org.datadog.jenkins.plugins.datadog

Class DatadogGlobalConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.datadog.jenkins.plugins.datadog.DatadogGlobalConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, OnMaster

@Extension
public class DatadogGlobalConfiguration
extends GlobalConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	DD_AGENT_HOST
static String	DD_AGENT_PORT
static String	DD_TRACE_AGENT_PORT
static String	DD_TRACE_AGENT_URL
static String	TARGET_HOST_PROPERTY
static String	TARGET_PORT_PROPERTY
static String	TARGET_TRACE_COLLECTION_PORT_PROPERTY

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DatadogGlobalConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Indicates if this builder can be used with all kinds of project types.
FormValidation	doCheckAgentConnectivityLogs(String targetHost, String targetLogCollectionPort) Test the connection to the Logs Collection port in the Datadog Agent.
FormValidation	doCheckAgentConnectivityTraces(String targetHost, String targetTraceCollectionPort) Test the connection to the Traces Collection port in the Datadog Agent.
FormValidation	doCheckTargetApiURL(String targetApiURL)
FormValidation	doCheckTargetHost(String targetHost)
FormValidation	doCheckTargetLogCollectionPort(String targetLogCollectionPort)
FormValidation	doCheckTargetLogIntakeURL(String targetLogIntakeURL)
FormValidation	doCheckTargetPort(String targetPort)
FormValidation	doCheckTargetTraceCollectionPort(String targetTraceCollectionPort)
FormValidation	doCheckTraceServiceName(String traceServiceName)
FormValidation	doTestConnection(String targetApiKey, String targetApiURL) Tests the apiKey field from the configuration screen, to check its' validity.
FormValidation	doTestHostname(String hostname) Tests the hostname field from the configuration screen, to determine if the hostname is of a valid format, according to the RFC 1123.
String	getBlacklist() Deprecated. replaced by getExcluded()
String	getCiInstanceName() Getter function for the traceServiceName global configuration.
String	getDisplayName() Getter function for a human readable plugin name, used in the configuration screen.
boolean	getEnableCiVisibility()
String	getExcluded() Getter function for the excluded global configuration, containing a comma-separated list of jobs to exclude from monitoring.
String	getGlobalJobTags() Getter function for the globalJobTags global configuration, containing a comma-separated list of jobs and tags that should be applied to them
String	getGlobalTagFile() Gets the globalTagFile set in the job configuration.
String	getGlobalTags() Getter function for the globalTags global configuration, containing a comma-separated list of tags that should be applied everywhere.
String	getHostname() Getter function for the hostname global configuration.
String	getIncluded() Getter function for the included global configuration, containing a comma-separated list of jobs to include for monitoring.
String	getReportWith() Getter function for the reportWith global configuration.
Secret	getTargetApiKey() Getter function for the targetApiKey global configuration.
String	getTargetApiURL() Getter function for the targetApiURL global configuration.
String	getTargetHost() Getter function for the targetHost global configuration.
Integer	getTargetLogCollectionPort() Getter function for the targetLogCollectionPort global configuration.
String	getTargetLogIntakeURL() Getter function for the targetLogIntakeURL global configuration.
Integer	getTargetPort() Getter function for the targetPort global configuration.
Integer	getTargetTraceCollectionPort() Getter function for the targetTraceCollectionPort global configuration.
String	getTraceServiceName() Deprecated. use getCiInstanceName.
String	getWhitelist() Deprecated. replaced by getIncluded()
boolean	isApplicable(Class<? extends AbstractProject> aClass) Indicates if this builder can be used with all kinds of project types.
boolean	isCollectBuildLogs()
boolean	isCollectBuildTraces() Deprecated. Use isEnabledCiVisibility
boolean	isEmitConfigChangeEvents()
boolean	isEmitSecurityEvents()
boolean	isEmitSystemEvents()
boolean	reportWithEquals(String value)
void	setBlacklist(String jobs) Deprecated. replaced by setExcluded(String)
void	setCiInstanceName(String ciInstanceName) Setter function for the traceServiceName global configuration.
void	setCollectBuildLogs(boolean collectBuildLogs) Set the checkbox in the UI, used for Jenkins data binding
void	setCollectBuildTraces(boolean collectBuildTraces) Deprecated. Use setEnableCiVisibility
void	setEmitConfigChangeEvents(boolean emitConfigChangeEvents) Set the checkbox in the UI, used for Jenkins data binding
void	setEmitSecurityEvents(boolean emitSecurityEvents) Set the checkbox in the UI, used for Jenkins data binding
void	setEmitSystemEvents(boolean emitSystemEvents) Set the checkbox in the UI, used for Jenkins data binding
void	setEnableCiVisibility(boolean enableCiVisibility) Deprecated. Use setEnableCiVisibility
void	setExcluded(String jobs) Setter function for the excluded jobs global configuration, accepting a comma-separated string of jobs.
void	setGlobalJobTags(String globalJobTags) Setter function for the globalJobTags global configuration, accepting a comma-separated string of jobs and tags.
void	setGlobalTagFile(String globalTagFile) Setter function for the globalFile global configuration, accepting a comma-separated string of tags.
void	setGlobalTags(String globalTags) Setter function for the globalTags global configuration, accepting a comma-separated string of tags.
void	setHostname(String hostname) Setter function for the hostname global configuration.
void	setIncluded(String jobs) Setter function for the includedd global configuration, accepting a comma-separated string of jobs.
void	setReportWith(String reportWith) Setter function for the reportWith global configuration.
void	setTargetApiKey(String targetApiKey) Setter function for the apiKey global configuration.
void	setTargetApiURL(String targetApiURL) Setter function for the targetApiURL global configuration.
void	setTargetHost(String targetHost) Setter function for the targetHost global configuration.
void	setTargetLogCollectionPort(Integer targetLogCollectionPort) Setter function for the targetLogCollectionPort global configuration.
void	setTargetLogIntakeURL(String targetLogIntakeURL) Setter function for the targetLogIntakeURL global configuration.
void	setTargetPort(Integer targetPort) Setter function for the targetPort global configuration.
void	setTargetTraceCollectionPort(Integer targetTraceCollectionPort) Setter function for the targetLogCollectionPort global configuration.
void	setTraceServiceName(String traceServiceName) Deprecated. Use setCiInstanceName.
void	setWhitelist(String jobs) Deprecated. replaced by setIncluded(String)
static boolean	validatePort(String targetPort)
static boolean	validateURL(String targetURL)

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

DD_AGENT_HOST

public static final String DD_AGENT_HOST

See Also:

Constant Field Values

DD_AGENT_PORT

public static final String DD_AGENT_PORT

See Also:

Constant Field Values

DD_TRACE_AGENT_PORT

public static final String DD_TRACE_AGENT_PORT

See Also:

Constant Field Values

DD_TRACE_AGENT_URL

public static final String DD_TRACE_AGENT_URL

See Also:

Constant Field Values

TARGET_HOST_PROPERTY

public static final String TARGET_HOST_PROPERTY

See Also:

Constant Field Values

TARGET_PORT_PROPERTY

public static final String TARGET_PORT_PROPERTY

See Also:

Constant Field Values

TARGET_TRACE_COLLECTION_PORT_PROPERTY

public static final String TARGET_TRACE_COLLECTION_PORT_PROPERTY

See Also:

Constant Field Values

Constructor Detail

DatadogGlobalConfiguration

@DataBoundConstructor
public DatadogGlobalConfiguration()

Method Detail

doCheckAgentConnectivityLogs

public FormValidation doCheckAgentConnectivityLogs(@QueryParameter(value="targetHost")
                                                   String targetHost,
                                                   @QueryParameter(value="targetLogCollectionPort")
                                                   String targetLogCollectionPort)

Test the connection to the Logs Collection port in the Datadog Agent.

Parameters:

targetHost - - The Datadog Agent host

targetLogCollectionPort - - The Logs Collection port used to report logs in the Datadog Agent

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

doCheckAgentConnectivityTraces

public FormValidation doCheckAgentConnectivityTraces(@QueryParameter(value="targetHost")
                                                     String targetHost,
                                                     @QueryParameter(value="targetTraceCollectionPort")
                                                     String targetTraceCollectionPort)

Test the connection to the Traces Collection port in the Datadog Agent.

Parameters:

targetHost - - The Datadog Agent host

targetTraceCollectionPort - - The Traces Collection port used to report logs in the Datadog Agent

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

doTestConnection

public FormValidation doTestConnection(@QueryParameter(value="targetApiKey")
                                       String targetApiKey,
                                       @QueryParameter(value="targetApiURL")
                                       String targetApiURL)
                                throws IOException,
                                       javax.servlet.ServletException

Tests the apiKey field from the configuration screen, to check its' validity. It is used in the config.jelly resource file. See method="testConnection"

Parameters:

targetApiURL - - The API Url to validate the apikey.

targetApiKey - - A String containing the apiKey submitted from the form on the configuration screen, which will be used to authenticate a request to the Datadog API.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

Throws:

IOException - if there is an input/output exception.

javax.servlet.ServletException - if there is a servlet exception.

doTestHostname

public FormValidation doTestHostname(@QueryParameter(value="hostname")
                                     String hostname)

Tests the hostname field from the configuration screen, to determine if the hostname is of a valid format, according to the RFC 1123. It is used in the config.jelly resource file. See method="testHostname"

Parameters:

hostname - - A String containing the hostname submitted from the form on the configuration screen, which will be used to authenticate a request to the Datadog API.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

doCheckTargetApiURL

public FormValidation doCheckTargetApiURL(@QueryParameter(value="targetApiURL")
                                          String targetApiURL)

Parameters:

targetApiURL - - The API URL which the plugin will report to.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

doCheckTargetLogIntakeURL

public FormValidation doCheckTargetLogIntakeURL(@QueryParameter(value="targetLogIntakeURL")
                                                String targetLogIntakeURL)

Parameters:

targetLogIntakeURL - - The Log Intake URL which the plugin will report to.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

validateURL

public static boolean validateURL(String targetURL)

doCheckTargetHost

public FormValidation doCheckTargetHost(@QueryParameter(value="targetHost")
                                        String targetHost)

Parameters:

targetHost - - The dogStatsD Host which the plugin will report to.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

validatePort

public static boolean validatePort(String targetPort)

doCheckTargetPort

public FormValidation doCheckTargetPort(@QueryParameter(value="targetPort")
                                        String targetPort)

Parameters:

targetPort - - The dogStatsD Port which the plugin will report to.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

doCheckTargetLogCollectionPort

public FormValidation doCheckTargetLogCollectionPort(@QueryParameter(value="targetLogCollectionPort")
                                                     String targetLogCollectionPort)

Parameters:

targetLogCollectionPort - - The Log Collection Port which the plugin will report to.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

doCheckTargetTraceCollectionPort

public FormValidation doCheckTargetTraceCollectionPort(@QueryParameter(value="targetTraceCollectionPort")
                                                       String targetTraceCollectionPort)

Parameters:

targetTraceCollectionPort - - The Trace Collection Port which the plugin will report to.

Returns:

a FormValidation object used to display a message to the user on the configuration screen.

doCheckTraceServiceName

public FormValidation doCheckTraceServiceName(@QueryParameter(value="traceServiceName")
                                              String traceServiceName)

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> aClass)

Indicates if this builder can be used with all kinds of project types.

Parameters:

aClass - - An extension of the AbstractProject class representing a specific type of project.

Returns:

a boolean signifying whether or not a builder can be used with a specific type of project.

getDisplayName

public String getDisplayName()

Getter function for a human readable plugin name, used in the configuration screen.

Overrides:

getDisplayName in class Descriptor<GlobalConfiguration>

Returns:

a String containing the human readable display name for this plugin.

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws Descriptor.FormException

Indicates if this builder can be used with all kinds of project types.

Overrides:

configure in class GlobalConfiguration

Parameters:

req - - A StaplerRequest object

formData - - A JSONObject containing the submitted form data from the configuration screen.

Returns:

a boolean signifying the success or failure of configuration.

Throws:

FormException - if the formData is invalid.

Descriptor.FormException

reportWithEquals

public boolean reportWithEquals(String value)

getReportWith

public String getReportWith()

Getter function for the reportWith global configuration.

Returns:

a String containing the reportWith global configuration.

setReportWith

@DataBoundSetter
public void setReportWith(String reportWith)

Setter function for the reportWith global configuration.

Parameters:

reportWith - = A string containing the reportWith global configuration.

getTargetApiURL

public String getTargetApiURL()

Getter function for the targetApiURL global configuration.

Returns:

a String containing the targetApiURL global configuration.

setTargetApiURL

@DataBoundSetter
public void setTargetApiURL(String targetApiURL)

Setter function for the targetApiURL global configuration.

Parameters:

targetApiURL - = A string containing the DataDog API URL

setTargetLogIntakeURL

@DataBoundSetter
public void setTargetLogIntakeURL(String targetLogIntakeURL)

Setter function for the targetLogIntakeURL global configuration.

Parameters:

targetLogIntakeURL - = A string containing the DataDog Log Intake URL

getTargetLogIntakeURL

public String getTargetLogIntakeURL()

Getter function for the targetLogIntakeURL global configuration.

Returns:

a String containing the targetLogIntakeURL global configuration.

getTargetApiKey

public Secret getTargetApiKey()

Getter function for the targetApiKey global configuration.

Returns:

a Secret containing the targetApiKey global configuration.

setTargetApiKey

@DataBoundSetter
public void setTargetApiKey(String targetApiKey)

Setter function for the apiKey global configuration.

Parameters:

targetApiKey - = A string containing the plaintext representation of a DataDog API Key

getTargetHost

public String getTargetHost()

Getter function for the targetHost global configuration.

Returns:

a String containing the targetHost global configuration.

setTargetHost

@DataBoundSetter
public void setTargetHost(String targetHost)

Setter function for the targetHost global configuration.

Parameters:

targetHost - = A string containing the DogStatsD Host

getTargetPort

public Integer getTargetPort()

Getter function for the targetPort global configuration.

Returns:

a Integer containing the targetPort global configuration.

setTargetPort

@DataBoundSetter
public void setTargetPort(Integer targetPort)

Setter function for the targetPort global configuration.

Parameters:

targetPort - = A string containing the DogStatsD Port

getTargetLogCollectionPort

public Integer getTargetLogCollectionPort()

Getter function for the targetLogCollectionPort global configuration.

Returns:

a Integer containing the targetLogCollectionPort global configuration.

setTargetLogCollectionPort

@DataBoundSetter
public void setTargetLogCollectionPort(Integer targetLogCollectionPort)

Setter function for the targetLogCollectionPort global configuration.

Parameters:

targetLogCollectionPort - = A string containing the Log Collection Port

getTargetTraceCollectionPort

public Integer getTargetTraceCollectionPort()

Getter function for the targetTraceCollectionPort global configuration.

Returns:

a Integer containing the targetTraceCollectionPort global configuration.

setTargetTraceCollectionPort

@DataBoundSetter
public void setTargetTraceCollectionPort(Integer targetTraceCollectionPort)

Setter function for the targetLogCollectionPort global configuration.

Parameters:

targetTraceCollectionPort - = A string containing the Trace Collection Port

getTraceServiceName

@Deprecated
public String getTraceServiceName()

Deprecated. use getCiInstanceName.

Getter function for the traceServiceName global configuration.

Returns:

a String containing the traceServiceName global configuration.

setTraceServiceName

@Deprecated
 @DataBoundSetter
public void setTraceServiceName(String traceServiceName)

Deprecated. Use setCiInstanceName.

Setter function for the traceServiceName global configuration.

Parameters:

traceServiceName - = A string containing the Trace Service Name

getCiInstanceName

public String getCiInstanceName()

Getter function for the traceServiceName global configuration.

Returns:

a String containing the traceServiceName global configuration.

setCiInstanceName

public void setCiInstanceName(String ciInstanceName)

Setter function for the traceServiceName global configuration.

Parameters:

ciInstanceName - = A string containing the CI Instance Name

getHostname

public String getHostname()

Getter function for the hostname global configuration.

Returns:

a String containing the hostname global configuration.

setHostname

@DataBoundSetter
public void setHostname(String hostname)

Setter function for the hostname global configuration.

Parameters:

hostname - - A String containing the hostname of the Jenkins host.

getBlacklist

@Deprecated
public String getBlacklist()

Deprecated. replaced by getExcluded()

Returns:

a String array containing the excluded global configuration.

getExcluded

public String getExcluded()

Getter function for the excluded global configuration, containing a comma-separated list of jobs to exclude from monitoring.

Returns:

a String array containing the excluded global configuration.

setBlacklist

@Deprecated
 @DataBoundSetter
public void setBlacklist(String jobs)

Deprecated. replaced by setExcluded(String)

Parameters:

jobs - - a comma-separated list of jobs to exclude from monitoring.

setExcluded

@DataBoundSetter
public void setExcluded(String jobs)

Setter function for the excluded jobs global configuration, accepting a comma-separated string of jobs.

Parameters:

jobs - - a comma-separated list of jobs to exclude from monitoring.

getWhitelist

@Deprecated
public String getWhitelist()

Deprecated. replaced by getIncluded()

Returns:

a String array containing the included global configuration.

getIncluded

public String getIncluded()

Getter function for the included global configuration, containing a comma-separated list of jobs to include for monitoring.

Returns:

a String array containing the included global configuration.

setWhitelist

@Deprecated
 @DataBoundSetter
public void setWhitelist(String jobs)

Deprecated. replaced by setIncluded(String)

Parameters:

jobs - - a comma-separated list of jobs to include for monitoring.

setIncluded

@DataBoundSetter
public void setIncluded(String jobs)

Setter function for the includedd global configuration, accepting a comma-separated string of jobs.

Parameters:

jobs - - a comma-separated list of jobs to include for monitoring.

getGlobalTagFile

public String getGlobalTagFile()

Gets the globalTagFile set in the job configuration.

Returns:

a String representing the relative path to a globalTagFile

setGlobalTagFile

@DataBoundSetter
public void setGlobalTagFile(String globalTagFile)

Setter function for the globalFile global configuration, accepting a comma-separated string of tags.

Parameters:

globalTagFile - - a comma-separated list of tags.

getGlobalTags

public String getGlobalTags()

Getter function for the globalTags global configuration, containing a comma-separated list of tags that should be applied everywhere.

Returns:

a String array containing the globalTags global configuration

setGlobalTags

@DataBoundSetter
public void setGlobalTags(String globalTags)

Setter function for the globalTags global configuration, accepting a comma-separated string of tags.

Parameters:

globalTags - - a comma-separated list of tags.

getGlobalJobTags

public String getGlobalJobTags()

Getter function for the globalJobTags global configuration, containing a comma-separated list of jobs and tags that should be applied to them

Returns:

a String array containing the globalJobTags global configuration.

setGlobalJobTags

@DataBoundSetter
public void setGlobalJobTags(String globalJobTags)

Setter function for the globalJobTags global configuration, accepting a comma-separated string of jobs and tags.

Parameters:

globalJobTags - - a comma-separated list of jobs to include from monitoring.

isEmitSecurityEvents

public boolean isEmitSecurityEvents()

Returns:

- A Boolean indicating if the user has configured Datadog to emit Security related events.

setEmitSecurityEvents

@DataBoundSetter
public void setEmitSecurityEvents(boolean emitSecurityEvents)

Set the checkbox in the UI, used for Jenkins data binding

Parameters:

emitSecurityEvents - - The checkbox status (checked/unchecked)

isEmitSystemEvents

public boolean isEmitSystemEvents()

Returns:

- A Boolean indicating if the user has configured Datadog to emit System related events.

setEmitSystemEvents

@DataBoundSetter
public void setEmitSystemEvents(boolean emitSystemEvents)

Set the checkbox in the UI, used for Jenkins data binding

Parameters:

emitSystemEvents - - The checkbox status (checked/unchecked)

isEmitConfigChangeEvents

public boolean isEmitConfigChangeEvents()

Returns:

- A Boolean indicating if the user has configured Datadog to emit Config Change events.

setEmitConfigChangeEvents

@DataBoundSetter
public void setEmitConfigChangeEvents(boolean emitConfigChangeEvents)

Set the checkbox in the UI, used for Jenkins data binding

Parameters:

emitConfigChangeEvents - - The checkbox status (checked/unchecked)

isCollectBuildLogs

public boolean isCollectBuildLogs()

Returns:

- A Boolean indicating if the user has configured Datadog to collect logs.

setCollectBuildLogs

@DataBoundSetter
public void setCollectBuildLogs(boolean collectBuildLogs)

Set the checkbox in the UI, used for Jenkins data binding

Parameters:

collectBuildLogs - - The checkbox status (checked/unchecked)

isCollectBuildTraces

@Deprecated
public boolean isCollectBuildTraces()

Deprecated. Use isEnabledCiVisibility

Returns:

- A Boolean indicating if the user has configured Datadog to collect traces.

setCollectBuildTraces

@DataBoundSetter
 @Deprecated
public void setCollectBuildTraces(boolean collectBuildTraces)

Deprecated. Use setEnableCiVisibility

Set the checkbox in the UI, used for Jenkins data binding

Parameters:

collectBuildTraces - - The checkbox status (checked/unchecked)

getEnableCiVisibility

public boolean getEnableCiVisibility()

Returns:

- A Boolean indicating if the user has configured Datadog to enable CI Visibility.

setEnableCiVisibility

@DataBoundSetter
public void setEnableCiVisibility(boolean enableCiVisibility)

Deprecated. Use setEnableCiVisibility

Set the checkbox in the UI, used for Jenkins data binding to enable CI Visibility

Parameters:

enableCiVisibility - - The checkbox status (checked/unchecked)