org.datadog.jenkins.plugins.datadogbuildreporter

Class DatadogBuildListener

java.lang.Object

hudson.model.listeners.RunListener<hudson.model.Run>

org.datadog.jenkins.plugins.datadogbuildreporter.DatadogBuildListener

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<DatadogBuildListener>

@Extension
public class DatadogBuildListener
extends hudson.model.listeners.RunListener<hudson.model.Run>
implements hudson.model.Describable<DatadogBuildListener>

DatadogBuildListener RunListener.

When the user configures the project and runs a build, Descriptor.newInstance(StaplerRequest) is invoked and a new DatadogBuildListener is created. The created instance is persisted to the project configuration XML by using XStream, allowing you to use instance fields (like link #name) to remember the configuration.

When a build starts, the onStarted(Run, TaskListener) method will be invoked. And when a build finishes, the onCompleted(Run, TaskListener) method will be invoked.

Author:

John Zeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatadogBuildListener.DescriptorImpl Descriptor for DatadogBuildListener.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.listeners.RunListener

LISTENERS, targetType

Constructor Summary

Constructors

Constructor and Description
DatadogBuildListener() Runs when the DatadogBuildListener class is created.

Method Summary

Modifier and Type	Method and Description
String	durationToString(double duration) Converts from a double to a human readable string, representing a time duration.
void	event(net.sf.json.JSONObject builddata, net.sf.json.JSONArray tags) Sends a an event to the Datadog API, including the event payload, and a set of tags.
void	gauge(String metricName, net.sf.json.JSONObject builddata, String key, net.sf.json.JSONArray tags) Sends a metric to the Datadog API, including the gauge name, value, and a set of tags.
DatadogBuildListener.DescriptorImpl	getDescriptor() Getter function for the DatadogBuildListener.DescriptorImpl class.
void	onCompleted(hudson.model.Run run, hudson.model.TaskListener listener) Called when a build is completed.
void	onStarted(hudson.model.Run run, hudson.model.TaskListener listener) Called when a build is first started.
Boolean	post(net.sf.json.JSONObject payload, String type) Posts a given JSONObject payload to the DataDog API, using the user configured apiKey.
void	printLog(String message) Prints a message to the PrintStream logger.
void	serviceCheck(String checkName, Integer status, net.sf.json.JSONObject builddata, net.sf.json.JSONArray tags) Sends a service check to the Datadog API, including the check name, status, and a set of tags.

Methods inherited from class hudson.model.listeners.RunListener

all, fireCompleted, fireDeleted, fireFinalized, fireStarted, onDeleted, onFinalized, register, setUpEnvironment, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

DatadogBuildListener

public DatadogBuildListener()

Runs when the DatadogBuildListener class is created.

Method Detail

onStarted

public final void onStarted(hudson.model.Run run,
                            hudson.model.TaskListener listener)

Called when a build is first started.

Overrides:

onStarted in class hudson.model.listeners.RunListener<hudson.model.Run>

Parameters:

run - - A Run object representing a particular execution of Job.

listener - - A TaskListener object which receives events that happen during some operation.

onCompleted

public final void onCompleted(hudson.model.Run run,
                              @Nonnull
                              hudson.model.TaskListener listener)

Called when a build is completed.

Overrides:

onCompleted in class hudson.model.listeners.RunListener<hudson.model.Run>

Parameters:

run - - A Run object representing a particular execution of Job.

listener - - A TaskListener object which receives events that happen during some operation.

post

public final Boolean post(net.sf.json.JSONObject payload,
                          String type)

Posts a given JSONObject payload to the DataDog API, using the user configured apiKey.

Parameters:

payload - - A JSONObject containing a specific subset of a builds metadata.

type - - A String containing the URL subpath pertaining to the type of API post required.

Returns:

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

gauge

public final void gauge(String metricName,
                        net.sf.json.JSONObject builddata,
                        String key,
                        net.sf.json.JSONArray tags)

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

Parameters:

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

builddata - - A JSONObject containing a builds metadata.

key - - A String with the name of the build metadata to be found in the JSONObject builddata.

tags - - A JSONArray containing a specific subset of tags retrieved from a builds metadata.

serviceCheck

public final void serviceCheck(String checkName,
                               Integer status,
                               net.sf.json.JSONObject builddata,
                               net.sf.json.JSONArray tags)

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

Parameters:

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

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

builddata - - A JSONObject containing a builds metadata.

tags - - A JSONArray containing a specific subset of tags retrieved from a builds metadata.

event

public final void event(net.sf.json.JSONObject builddata,
                        net.sf.json.JSONArray tags)

Sends a an event to the Datadog API, including the event payload, and a set of tags.

Parameters:

builddata - - A JSONObject containing a builds metadata.

tags - - A JSONArray containing a specific subset of tags retrieved from a builds metadata.

durationToString

public final String durationToString(double duration)

Converts from a double to a human readable string, representing a time duration.

Parameters:

duration - - A Double with a duration in seconds.

Returns:

a human readable String representing a time duration.

printLog

public final void printLog(String message)

Prints a message to the PrintStream logger.

Parameters:

message - - A String containing a message to be printed to the PrintStream logger.

getDescriptor

public final DatadogBuildListener.DescriptorImpl getDescriptor()

Getter function for the DatadogBuildListener.DescriptorImpl class.

Specified by:

getDescriptor in interface hudson.model.Describable<DatadogBuildListener>

Returns:

a new DatadogBuildListener.DescriptorImpl class.