Package org.datadog.jenkins.plugins.datadog.clients

Class DatadogAgentClient

java.lang.Object

org.datadog.jenkins.plugins.datadog.clients.DatadogAgentClient

All Implemented Interfaces:

DatadogClient

public class DatadogAgentClient
extends Object
implements DatadogClient

This class is used to collect all methods that has to do with transmitting data to Datadog.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatadogAgentClient.ConnectivityResult

Nested classes/interfaces inherited from interface org.datadog.jenkins.plugins.datadog.DatadogClient

DatadogClient.ClientType, DatadogClient.Status

Constructor Summary

Constructors

Constructor	Description
DatadogAgentClient(String hostname, Integer port, Integer logCollectionPort, Integer traceCollectionPort)
DatadogAgentClient(String hostname, Integer port, Integer logCollectionPort, Integer traceCollectionPort, long evpProxyTimeoutMillis)

Method Summary

Modifier and Type	Method	Description
static DatadogAgentClient.ConnectivityResult	checkConnectivity(String host, int port)
TraceWriteStrategy	createTraceWriteStrategy()
boolean	equals(Object o)
boolean	event(DatadogEvent event)	Sends an event to the Datadog API, including the event payload.
Set<String>	fetchAgentSupportedEndpoints()	Fetches the supported endpoints from the Trace Agent /info API
int	hashCode()
MetricsClient	metrics()
boolean	sendLogs(String payload)	Send log message.
boolean	serviceCheck(String name, DatadogClient.Status status, String hostname, Map<String,Set<String>> tags)	Sends a service check to the Datadog API, including the check name, and status.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatadogAgentClient

public DatadogAgentClient(String hostname,
                          Integer port,
                          Integer logCollectionPort,
                          Integer traceCollectionPort)

DatadogAgentClient

public DatadogAgentClient(String hostname,
                          Integer port,
                          Integer logCollectionPort,
                          Integer traceCollectionPort,
                          long evpProxyTimeoutMillis)

Method Detail

checkConnectivity

public static DatadogAgentClient.ConnectivityResult checkConnectivity(String host,
                                                                      int port)

fetchAgentSupportedEndpoints

public Set<String> fetchAgentSupportedEndpoints()

Fetches the supported endpoints from the Trace Agent /info API

Returns:

a set of endpoints (if /info wasn't available, it will be empty)

event

public boolean event(DatadogEvent event)

Description copied from interface: DatadogClient

Sends an event to the Datadog API, including the event payload.

Specified by:

event in interface DatadogClient

Parameters:

event - - a DatadogEvent object

Returns:

a boolean to signify the success or failure of the HTTP POST request.

metrics

public MetricsClient metrics()

Specified by:

metrics in interface DatadogClient

serviceCheck

public boolean serviceCheck(String name,
                            DatadogClient.Status status,
                            String hostname,
                            Map<String,Set<String>> tags)

Description copied from interface: DatadogClient

Sends a service check to the Datadog API, including the check name, and status.

Specified by:

serviceCheck in interface DatadogClient

Parameters:

name - - A String with the name of the service check to record.

status - - An Status with the status code to record for this service check.

hostname - - A String with the hostname to submit.

tags - - A Map containing the tags to submit.

Returns:

a boolean to signify the success or failure of the HTTP POST request.

sendLogs

public boolean sendLogs(String payload)

Description copied from interface: DatadogClient

Send log message.

Specified by:

sendLogs in interface DatadogClient

Parameters:

payload - log payload to submit JSON object as String

Returns:

a boolean to signify the success or failure of the request.

createTraceWriteStrategy

public TraceWriteStrategy createTraceWriteStrategy()

Specified by:

createTraceWriteStrategy in interface DatadogClient

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object