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

Class DatadogApiClient

java.lang.Object

org.datadog.jenkins.plugins.datadog.clients.DatadogApiClient

All Implemented Interfaces:

DatadogClient

public class DatadogApiClient
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/interfaces inherited from interface org.datadog.jenkins.plugins.datadog.DatadogClient

DatadogClient.ClientType, DatadogClient.Status

Constructor Summary

Constructors

Constructor	Description
DatadogApiClient(String url, String logIntakeUrl, String webhookIntakeUrl, Secret apiKey)

Method Summary

Modifier and Type	Method	Description
LogWriteStrategy	createLogWriteStrategy()
TraceWriteStrategy	createTraceWriteStrategy()
boolean	equals(Object o)
boolean	event(DatadogEvent event)	Sends an event to the Datadog API, including the event payload.
int	hashCode()
MetricsClient	metrics()
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.
static boolean	validateDefaultIntakeConnection(String validatedUrl, Secret apiKey)
static boolean	validateLogIntakeConnection(String logsIntakeUrl, Secret apiKey)
static boolean	validateWebhookIntakeConnection(String webhookIntakeUrl, Secret apiKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

DatadogApiClient

public DatadogApiClient(String url,
                        String logIntakeUrl,
                        String webhookIntakeUrl,
                        Secret apiKey)

Method Detail

validateDefaultIntakeConnection

public static boolean validateDefaultIntakeConnection(String validatedUrl,
                                                      Secret apiKey)

validateWebhookIntakeConnection

public static boolean validateWebhookIntakeConnection(String webhookIntakeUrl,
                                                      Secret apiKey)

validateLogIntakeConnection

public static boolean validateLogIntakeConnection(String logsIntakeUrl,
                                                  Secret apiKey)

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.

createLogWriteStrategy

public LogWriteStrategy createLogWriteStrategy()

Specified by:

createLogWriteStrategy in interface DatadogClient

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