DatadogUtilities (Datadog Plugin 5.3.0 API)

java.lang.Object
- org.datadog.jenkins.plugins.datadog.DatadogUtilities

public class DatadogUtilities
extends Object

Constructor Summary

Constructors
Constructor and Description

DatadogUtilities()

Constructors
Constructor and Description
`DatadogUtilities()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static URL`	`buildHttpURL(String hostname, Integer port, String path)` Returns an HTTP URL
`static void`	`cleanUpTraceActions(Run<?,?> run)` Removes all actions related to traces for Jenkins pipelines.
`static Map<String,Set<String>>`	`computeTagListFromVarList(EnvVars envVars, String varList)`
`static List<String>`	`cstrToList(String str)` Converts a Comma Separated List into a List Object
`static long`	`currentTimeMillis()`
`static Map<String,Set<String>>`	`getBuildTags(Run run, EnvVars envVars)` Builds extraTags if any are configured in the Job.
`static Map<String,Set<String>>`	`getComputerTags(Computer computer)`
`static DatadogGlobalConfiguration`	`getDatadogGlobalDescriptor()`
`static DatadogJobProperty`	`getDatadogJobProperties(Run r)`
`static String`	`getFileName(XmlFile file)`
`static String`	`getHostname(EnvVars envVars)` Getter function to return either the saved hostname global configuration, or the hostname that is set in the Jenkins host itself.
`static Optional<String>`	`getHostnameFromWorkerEnv(Run run)` Fetches the environment variables from the worker and returns the value of DD_CI_HOSTNAME if set.
`static HttpURLConnection`	`getHttpURLConnection(URL url, int timeoutMS)` Returns an HTTP url connection given a url object.
`static String`	`getItemName(Item item)`
`static String`	`getJenkinsUrl()`
`static Set<String>`	`getNodeLabels(Computer computer)`
`static String`	`getNodeName(Computer computer)`
`static String`	`getNormalizedResultForTraces(String result)` Returns a normalize result for traces.
`static String`	`getResultTag(org.jenkinsci.plugins.workflow.graph.FlowNode node)`
`static Long`	`getRunStartTimeInMillis(Run run)`
`static Map<String,Set<String>>`	`getTagsFromGlobalTags()` Getter function for the globalTags global configuration, containing a comma-separated list of tags that should be applied everywhere.
`static Map<String,Set<String>>`	`getTagsFromPipelineAction(Run run)` Pipeline extraTags if any are configured in the Job from DatadogPipelineAction.
`static String`	`getUserId()`
`static boolean`	`isJobTracked(String jobName)` Checks if a jobName is excluded, included, or neither.
`static boolean`	`isMainNode(String nodeName)`
`static boolean`	`isPipeline(Run<?,?> run)` Check if a run is from a Jenkins pipeline.
`static boolean`	`isPipelineNode(org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)` Returns true if a `FlowNode` is a Pipeline node.
`static boolean`	`isStageNode(org.jenkinsci.plugins.workflow.graph.BlockStartNode flowNode)` Returns true if a `FlowNode` is a Stage node.
`static Boolean`	`isValidHostname(String hostname)` Validator function to ensure that the hostname is valid.
`static List<String>`	`linesToList(String str)` Converts a string List into a List Object
`static void`	`severe(Logger logger, Throwable e, String message)`
`static String`	`statusFromResult(String result)` Returns a normalized result for traces.
`static int`	`toInt(boolean b)`
`static String`	`toISO8601(Date date)` Returns a date as String in the ISO8601 format
`static String`	`toJson(Map<String,String> map)` Returns a JSON object string based on the map.
`static String`	`toJson(Set<String> set)` Returns a JSON array string based on the set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DatadogUtilities
```
public DatadogUtilities()
```
- Method Detail
  - getDatadogGlobalDescriptor
```
public static DatadogGlobalConfiguration getDatadogGlobalDescriptor()
```
    Returns:
    
    - The descriptor for the Datadog plugin. In this case the global configuration.
  - getDatadogJobProperties
```
public static DatadogJobProperty getDatadogJobProperties(@Nonnull
                                                         Run r)
```
    Parameters:
    
    r - - Current build.
    
    Returns:
    
    - The configured DatadogJobProperty. Null if not there
  - getBuildTags
```
public static Map<String,Set<String>> getBuildTags(Run run,
                                                   EnvVars envVars)
```
    Builds extraTags if any are configured in the Job.
    
    Parameters:
    
    run - - Current build
    
    envVars - - Environment Variables
    
    Returns:
    
    A HashMap containing the key,value pairs of tags if any.
  - getTagsFromPipelineAction
```
public static Map<String,Set<String>> getTagsFromPipelineAction(Run run)
```
    Pipeline extraTags if any are configured in the Job from DatadogPipelineAction.
    
    Parameters:
    
    run - - Current build
    
    Returns:
    
    A HashMap containing the key,value pairs of tags if any.
  - isJobTracked
```
public static boolean isJobTracked(String jobName)
```
    Checks if a jobName is excluded, included, or neither.
    
    Parameters:
    
    jobName - - A String containing the name of some job.
    
    Returns:
    
    a boolean to signify if the jobName is or is not excluded or included.
  - getTagsFromGlobalTags
```
public static Map<String,Set<String>> getTagsFromGlobalTags()
```
    Getter function for the globalTags global configuration, containing a comma-separated list of tags that should be applied everywhere.
    
    Returns:
    
    a map containing the globalTags global configuration.
  - cstrToList
```
public static List<String> cstrToList(String str)
```
    Converts a Comma Separated List into a List Object
    
    Parameters:
    
    str - - A String containing a comma separated list of items.
    
    Returns:
    
    a String List with all items transform with trim and lower case
  - linesToList
```
public static List<String> linesToList(String str)
```
    Converts a string List into a List Object
    
    Parameters:
    
    str - - A String containing a comma separated list of items.
    
    Returns:
    
    a String List with all items
  - computeTagListFromVarList
```
public static Map<String,Set<String>> computeTagListFromVarList(EnvVars envVars,
                                                                String varList)
```
  - getHostname
```
public static String getHostname(EnvVars envVars)
```
    Getter function to return either the saved hostname global configuration, or the hostname that is set in the Jenkins host itself. Returns null if no valid hostname is found. Tries, in order: Jenkins configuration Jenkins hostname environment variable Unix hostname via `/bin/hostname -f` Localhost hostname
    
    Parameters:
    
    envVars - - The Jenkins environment variables
    
    Returns:
    
    a human readable String for the hostname.
  - getHostnameFromWorkerEnv
```
public static Optional<String> getHostnameFromWorkerEnv(Run run)
```
    Fetches the environment variables from the worker and returns the value of DD_CI_HOSTNAME if set.
    
    Parameters:
    
    run - - Current build
    
    Returns:
    
    the specified hostname or an empty Optional if not set
  - isValidHostname
```
public static Boolean isValidHostname(String hostname)
```
    Validator function to ensure that the hostname is valid. Also, fails on empty String.
    
    Parameters:
    
    hostname - - A String object containing the name of a host.
    
    Returns:
    
    a boolean representing the validity of the hostname
  - getComputerTags
```
public static Map<String,Set<String>> getComputerTags(Computer computer)
```
  - getNodeName
```
public static String getNodeName(Computer computer)
```
  - isMainNode
```
public static boolean isMainNode(String nodeName)
```
  - getNodeLabels
```
public static Set<String> getNodeLabels(Computer computer)
```
  - getUserId
```
public static String getUserId()
```
  - getItemName
```
public static String getItemName(Item item)
```
  - getRunStartTimeInMillis
```
public static Long getRunStartTimeInMillis(Run run)
```
  - currentTimeMillis
```
public static long currentTimeMillis()
```
  - getFileName
```
public static String getFileName(XmlFile file)
```
  - getJenkinsUrl
```
public static String getJenkinsUrl()
```
  - getResultTag
```
public static String getResultTag(@Nonnull
                                  org.jenkinsci.plugins.workflow.graph.FlowNode node)
```
  - isStageNode
```
public static boolean isStageNode(org.jenkinsci.plugins.workflow.graph.BlockStartNode flowNode)
```
    Returns true if a FlowNode is a Stage node.
    
    Parameters:
    
    flowNode - the flow node to evaluate
    
    Returns:
    
    flag indicating if a flowNode is a Stage node.
  - isPipelineNode
```
public static boolean isPipelineNode(org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)
```
    Returns true if a FlowNode is a Pipeline node.
    
    Parameters:
    
    flowNode - the flow node to evaluate
    
    Returns:
    
    flag indicating if a flowNode is a Pipeline node.
  - getNormalizedResultForTraces
```
public static String getNormalizedResultForTraces(@Nonnull
                                                  String result)
```
    Returns a normalize result for traces.
    
    Parameters:
    
    result - (success, failure, error, aborted, not_build, canceled, skipped, unknown)
    
    Returns:
    
    the normalized result for the traces based on the jenkins result
  - statusFromResult
```
public static String statusFromResult(@Nonnull
                                      String result)
```
    Returns a normalized result for traces. NOTE: This is very similar to the above "getNormalizedResultForTraces", but with the difference that this will not return "unstable", which isn't a valid status on the Webhooks API.
    
    Parameters:
    
    result - (success, failure, error, aborted, not_build, canceled, skipped, unknown)
    
    Returns:
    
    the normalized result for the traces based on the jenkins result
  - severe
```
public static void severe(Logger logger,
                          Throwable e,
                          String message)
```
  - toInt
```
public static int toInt(boolean b)
```
  - toISO8601
```
public static String toISO8601(Date date)
```
    Returns a date as String in the ISO8601 format
    
    Parameters:
    
    date - the date object to transform
    
    Returns:
    
    date as String in the ISO8601 format
  - toJson
```
public static String toJson(Set<String> set)
```
    Returns a JSON array string based on the set.
    
    Parameters:
    
    set - the set to transform into a JSON
    
    Returns:
    
    json array string
  - toJson
```
public static String toJson(Map<String,String> map)
```
    Returns a JSON object string based on the map.
    
    Parameters:
    
    map - the map to transform into a JSON
    
    Returns:
    
    json object string
  - cleanUpTraceActions
```
public static void cleanUpTraceActions(Run<?,?> run)
```
    Removes all actions related to traces for Jenkins pipelines.
    
    Parameters:
    
    run - the current run.
  - isPipeline
```
public static boolean isPipeline(Run<?,?> run)
```
    Check if a run is from a Jenkins pipeline. This action is added if the run is based on FlowNodes.
    
    Parameters:
    
    run - the current run.
    
    Returns:
    
    true if is a Jenkins pipeline.
  - getHttpURLConnection
```
public static HttpURLConnection getHttpURLConnection(URL url,
                                                     int timeoutMS)
                                              throws IOException
```
    Returns an HTTP url connection given a url object. Supports jenkins configured proxy.
    
    Parameters:
    
    url - - a URL object containing the URL to open a connection to.
    
    timeoutMS - - the timeout in MS
    
    Returns:
    
    a HttpURLConnection object.
    
    Throws:
    
    IOException - if HttpURLConnection fails to open connection
  - buildHttpURL
```
public static URL buildHttpURL(String hostname,
                               Integer port,
                               String path)
                        throws MalformedURLException
```
    Returns an HTTP URL
    
    Parameters:
    
    hostname - - the Hostname
    
    port - - the port to use
    
    path - - the path
    
    Returns:
    
    the HTTP URL
    
    Throws:
    
    MalformedURLException - if the URL is not in a valid format

Class DatadogUtilities

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatadogUtilities

Method Detail

getDatadogGlobalDescriptor

getDatadogJobProperties

getBuildTags

getTagsFromPipelineAction

isJobTracked

getTagsFromGlobalTags

cstrToList

linesToList

computeTagListFromVarList

getHostname

getHostnameFromWorkerEnv

isValidHostname

getComputerTags

getNodeName

isMainNode

getNodeLabels

getUserId

getItemName

getRunStartTimeInMillis

currentTimeMillis

getFileName

getJenkinsUrl

getResultTag

isStageNode

isPipelineNode

getNormalizedResultForTraces

statusFromResult

severe

toInt

toISO8601

toJson

toJson

cleanUpTraceActions

isPipeline

getHttpURLConnection

buildHttpURL