org.jenkinsci.plugins.githubautostatus.notifiers

Class StatsdNotifier

java.lang.Object

org.jenkinsci.plugins.githubautostatus.notifiers.BuildNotifier

org.jenkinsci.plugins.githubautostatus.notifiers.StatsdNotifier

All Implemented Interfaces:

hudson.ExtensionPoint

public class StatsdNotifier
extends BuildNotifier

Sends job and stage metrics to a StatsD collector server over UDP.

Author:

Tom Hadlaw (thomas.hadlaw@hootsuite.com)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected StatsdNotifierConfig	config

Fields inherited from class org.jenkinsci.plugins.githubautostatus.notifiers.BuildNotifier

DEFAULT_LONG, DEFAULT_STRING

Constructor Summary

Constructors

Constructor and Description
StatsdNotifier(StatsdNotifierConfig config)
StatsdNotifier(StatsdWrapper client, StatsdNotifierConfig config)

Method Summary

Modifier and Type	Method and Description
String	getBranchPath() Returns the StatsD including the global prefix up to the branch bucket.
boolean	isEnabled() Determines whether this notifier is enabled.
void	notifyBuildStageStatus(String jobName, BuildStage stageItem) Sends duration metric to StatsD by doing a timer metric.
void	notifyFinalBuildStatus(BuildStage.State buildState, Map<String,Object> parameters) Sends final build status metric by doing a timer metric for blocked and unblocked job time.
String	sanitizeAll(String key) Applies all sanitizations to a key, folders are expanded into separate StatsD buckets.
void	sendNonStageError(String jobName, String nodeName) Sends build status metric to StatsD by doing an increment on the buildState categories.

Methods inherited from class org.jenkinsci.plugins.githubautostatus.notifiers.BuildNotifier

all, getLong, wantsOutOfStageErrors

Methods inherited from class java.lang.Object

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

Field Detail

config

protected StatsdNotifierConfig config

Constructor Detail

StatsdNotifier

public StatsdNotifier(StatsdWrapper client,
                      StatsdNotifierConfig config)

StatsdNotifier

public StatsdNotifier(StatsdNotifierConfig config)

Method Detail

isEnabled

public boolean isEnabled()

Determines whether this notifier is enabled.

Specified by:

isEnabled in class BuildNotifier

Returns:

true if enabled; false otherwise

getBranchPath

public String getBranchPath()

Returns the StatsD including the global prefix up to the branch bucket.

Returns:

string of path up to branch bucket

notifyBuildStageStatus

public void notifyBuildStageStatus(String jobName,
                                   BuildStage stageItem)

Sends duration metric to StatsD by doing a timer metric.

Specified by:

notifyBuildStageStatus in class BuildNotifier

Parameters:

jobName - the name of the job

stageItem - stage item describing the new state

notifyFinalBuildStatus

public void notifyFinalBuildStatus(BuildStage.State buildState,
                                   Map<String,Object> parameters)

Sends final build status metric by doing a timer metric for blocked and unblocked job time.

Specified by:

notifyFinalBuildStatus in class BuildNotifier

Parameters:

buildState - the reported state

parameters - build parameters

sendNonStageError

public void sendNonStageError(String jobName,
                              String nodeName)

Sends build status metric to StatsD by doing an increment on the buildState categories.

Parameters:

jobName - name of the job

nodeName - the stage of the status on which to report on

sanitizeAll

public String sanitizeAll(String key)

Applies all sanitizations to a key, folders are expanded into separate StatsD buckets. It first applies bucket sanitization (removing periods to prevent them being interpreted as separate buckets). It then applies the StatsD bucket key sanitization.

Parameters:

key - key to sanitize

Returns:

sanitized key