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 and Description
static class	DatadogAgentClient.ConnectivityResult

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

DatadogClient.ClientType, DatadogClient.Status

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	enableValidations

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatadogAgentClient(String hostname, Integer port, Integer logCollectionPort, Integer traceCollectionPort)

Method Summary

Modifier and Type	Method and Description
static DatadogAgentClient.ConnectivityResult	checkConnectivity(String host, int port)
protected boolean	checkEvpProxySupportAndUpdateLogic()
boolean	equals(Object object)
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
boolean	finishBuildTrace(BuildData buildData, Run<?,?> run) Finish the trace of a certain Jenkins build.
void	flushCounters() Submit all your counters as rate with 10 seconds intervals.
boolean	gauge(String name, long value, String hostname, Map<String,Set<String>> tags) Sends a metric to the Datadog API, including the gauge name, and value.
String	getHostname()
static DatadogClient	getInstance(String hostname, Integer port, Integer logCollectionPort, Integer traceCollectionPort) NOTE: Use ClientFactory.getClient method to instantiate the client in the Jenkins Plugin This method is not recommended to be used because it misses some validations.
Integer	getLogCollectionPort()
Integer	getPort()
Integer	getTraceCollectionPort()
int	hashCode()
boolean	incrementCounter(String name, String hostname, Map<String,Set<String>> tags) Increment a counter for the given metrics.
boolean	isDefaultIntakeConnectionBroken()
boolean	isEvpProxySupported()
boolean	isLogIntakeConnectionBroken()
boolean	isWebhookIntakeConnectionBroken()
boolean	postWebhook(String payload) Posts a given payload to the Agent EVP Proxy so it is forwarded to the Webhook Intake.
protected boolean	reinitializeAgentHttpClient(boolean force) reinitialize the Tracer Client
boolean	sendLogs(String payload) Send log message.
boolean	sendPipelineTrace(Run<?,?> run, org.jenkinsci.plugins.workflow.graph.FlowNode flowNode) Send all traces related to a certain Jenkins pipeline.
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.
void	setApiKey(Secret apiKey)
void	setDefaultIntakeConnectionBroken(boolean defaultIntakeConnectionBroken)
void	setHostname(String hostname)
void	setLogCollectionPort(Integer logCollectionPort)
void	setLogIntakeConnectionBroken(boolean logIntakeConnectionBroken)
void	setLogIntakeUrl(String logIntakeUrl)
void	setPort(Integer port)
void	setUrl(String url)
void	setWebhookIntakeConnectionBroken(boolean webhookIntakeConnectionBroken)
void	setWebhookIntakeUrl(String webhookIntakeUrl)
boolean	startBuildTrace(BuildData buildData, Run<?,?> run) Start the trace of a certain Jenkins build.
void	validateConfiguration()

Methods inherited from class java.lang.Object

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

Field Detail

enableValidations

public static boolean enableValidations

Constructor Detail

DatadogAgentClient

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

Method Detail

getInstance

public static DatadogClient getInstance(String hostname,
                                        Integer port,
                                        Integer logCollectionPort,
                                        Integer traceCollectionPort)

NOTE: Use ClientFactory.getClient method to instantiate the client in the Jenkins Plugin This method is not recommended to be used because it misses some validations.

Parameters:

hostname - - target hostname

port - - target port

logCollectionPort - - target log collection port

traceCollectionPort - - target trace collection port

Returns:

an singleton instance of the DogStatsDClient.

checkConnectivity

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

validateConfiguration

public void validateConfiguration()
                           throws IllegalArgumentException

Throws:

IllegalArgumentException

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fetchAgentSupportedEndpoints

public Set<String> fetchAgentSupportedEndpoints()

Fetches the supported endpoints from the Trace Agent /info API

Returns:

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

postWebhook

public boolean postWebhook(String payload)

Posts a given payload to the Agent EVP Proxy so it is forwarded to the Webhook Intake.

Specified by:

postWebhook in interface DatadogClient

Parameters:

payload - - A webhooks payload.

Returns:

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

reinitializeAgentHttpClient

protected boolean reinitializeAgentHttpClient(boolean force)

reinitialize the Tracer Client

Parameters:

force - - force to reinitialize

Returns:

true if reinitialized properly otherwise false

checkEvpProxySupportAndUpdateLogic

protected boolean checkEvpProxySupportAndUpdateLogic()

getHostname

public String getHostname()

setHostname

public void setHostname(String hostname)

Specified by:

setHostname in interface DatadogClient

getPort

public Integer getPort()

setPort

public void setPort(Integer port)

Specified by:

setPort in interface DatadogClient

getLogCollectionPort

public Integer getLogCollectionPort()

setLogCollectionPort

public void setLogCollectionPort(Integer logCollectionPort)

Specified by:

setLogCollectionPort in interface DatadogClient

getTraceCollectionPort

public Integer getTraceCollectionPort()

setUrl

public void setUrl(String url)

Specified by:

setUrl in interface DatadogClient

setLogIntakeUrl

public void setLogIntakeUrl(String logIntakeUrl)

Specified by:

setLogIntakeUrl in interface DatadogClient

setWebhookIntakeUrl

public void setWebhookIntakeUrl(String webhookIntakeUrl)

Specified by:

setWebhookIntakeUrl in interface DatadogClient

setApiKey

public void setApiKey(Secret apiKey)

Specified by:

setApiKey in interface DatadogClient

isDefaultIntakeConnectionBroken

public boolean isDefaultIntakeConnectionBroken()

Specified by:

isDefaultIntakeConnectionBroken in interface DatadogClient

setDefaultIntakeConnectionBroken

public void setDefaultIntakeConnectionBroken(boolean defaultIntakeConnectionBroken)

Specified by:

setDefaultIntakeConnectionBroken in interface DatadogClient

isLogIntakeConnectionBroken

public boolean isLogIntakeConnectionBroken()

Specified by:

isLogIntakeConnectionBroken in interface DatadogClient

setLogIntakeConnectionBroken

public void setLogIntakeConnectionBroken(boolean logIntakeConnectionBroken)

Specified by:

setLogIntakeConnectionBroken in interface DatadogClient

isWebhookIntakeConnectionBroken

public boolean isWebhookIntakeConnectionBroken()

Specified by:

isWebhookIntakeConnectionBroken in interface DatadogClient

setWebhookIntakeConnectionBroken

public void setWebhookIntakeConnectionBroken(boolean webhookIntakeConnectionBroken)

Specified by:

setWebhookIntakeConnectionBroken in interface DatadogClient

isEvpProxySupported

public boolean isEvpProxySupported()

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.

incrementCounter

public boolean incrementCounter(String name,
                                String hostname,
                                Map<String,Set<String>> tags)

Description copied from interface: DatadogClient

Increment a counter for the given metrics. NOTE: To submit all counters you need to execute the flushCounters method. This is to aggregate counters and submit them in batch to Datadog in order to minimize network traffic.

Specified by:

incrementCounter in interface DatadogClient

Parameters:

name - - metric name

hostname - - metric hostname

tags - - metric tags

Returns:

a boolean to signify the success or failure of increment submission.

flushCounters

public void flushCounters()

Description copied from interface: DatadogClient

Submit all your counters as rate with 10 seconds intervals.

Specified by:

flushCounters in interface DatadogClient

gauge

public boolean gauge(String name,
                     long value,
                     String hostname,
                     Map<String,Set<String>> tags)

Description copied from interface: DatadogClient

Sends a metric to the Datadog API, including the gauge name, and value.

Specified by:

gauge in interface DatadogClient

Parameters:

name - - A String with the name of the metric to record.

value - - A long containing the value to submit.

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.

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.

startBuildTrace

public boolean startBuildTrace(BuildData buildData,
                               Run<?,?> run)

Description copied from interface: DatadogClient

Start the trace of a certain Jenkins build.

Specified by:

startBuildTrace in interface DatadogClient

Parameters:

buildData - build data to use in the pipeline trace

run - a particular execution of a Jenkins build

Returns:

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

finishBuildTrace

public boolean finishBuildTrace(BuildData buildData,
                                Run<?,?> run)

Description copied from interface: DatadogClient

Finish the trace of a certain Jenkins build.

Specified by:

finishBuildTrace in interface DatadogClient

Parameters:

buildData - build data to use in the pipeline trace

run - the run to create a pipeline trace for

Returns:

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

sendPipelineTrace

public boolean sendPipelineTrace(Run<?,?> run,
                                 org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)

Description copied from interface: DatadogClient

Send all traces related to a certain Jenkins pipeline.

Specified by:

sendPipelineTrace in interface DatadogClient

Parameters:

run - a particular execution of a Jenkins build

flowNode - current flowNode

Returns:

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