org.datadog.jenkins.plugins.datadog

Interface DatadogClient

All Known Implementing Classes:

DatadogAgentClient, DatadogHttpClient

public interface DatadogClient

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DatadogClient.ClientType
static class	DatadogClient.Status

Method Summary

Modifier and Type	Method and Description
boolean	event(DatadogEvent event) Sends an event to the Datadog API, including the event payload.
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	incrementCounter(String name, String hostname, Map<String,Set<String>> tags) Increment a counter for the given metrics.
boolean	isDefaultIntakeConnectionBroken()
boolean	isLogIntakeConnectionBroken()
boolean	isWebhookIntakeConnectionBroken()
Metrics	metrics()
boolean	postWebhook(String payload) Send a webhook payload to the webhooks intake.
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.

Method Detail

setUrl

void setUrl(String url)

setLogIntakeUrl

void setLogIntakeUrl(String logIntakeUrl)

setWebhookIntakeUrl

void setWebhookIntakeUrl(String webhookIntakeUrl)

setApiKey

void setApiKey(Secret apiKey)

setHostname

void setHostname(String hostname)

setPort

void setPort(Integer port)

setLogCollectionPort

void setLogCollectionPort(Integer logCollectionPort)

isDefaultIntakeConnectionBroken

boolean isDefaultIntakeConnectionBroken()

setDefaultIntakeConnectionBroken

void setDefaultIntakeConnectionBroken(boolean defaultIntakeConnectionBroken)

isLogIntakeConnectionBroken

boolean isLogIntakeConnectionBroken()

isWebhookIntakeConnectionBroken

boolean isWebhookIntakeConnectionBroken()

setLogIntakeConnectionBroken

void setLogIntakeConnectionBroken(boolean logIntakeConnectionBroken)

setWebhookIntakeConnectionBroken

void setWebhookIntakeConnectionBroken(boolean webhookIntakeConnectionBroken)

event

boolean event(DatadogEvent event)

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

Parameters:

event - - a DatadogEvent object

Returns:

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

incrementCounter

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

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.

Parameters:

name - - metric name

hostname - - metric hostname

tags - - metric tags

Returns:

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

flushCounters

void flushCounters()

Submit all your counters as rate with 10 seconds intervals.

metrics

Metrics metrics()

serviceCheck

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.

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

boolean sendLogs(String payload)

Send log message.

Parameters:

payload - log payload to submit JSON object as String

Returns:

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

postWebhook

boolean postWebhook(String payload)

Send a webhook payload to the webhooks intake.

Parameters:

payload - - A webhooks payload.

Returns:

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

startBuildTrace

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

Start the trace of a certain Jenkins build.

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

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

Finish the trace of a certain Jenkins build.

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

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

Send all traces related to a certain Jenkins pipeline.

Parameters:

run - a particular execution of a Jenkins build

flowNode - current flowNode

Returns:

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