org.jenkinsci.plugins.githubautostatus.notifiers

Class InfluxDbNotifier

java.lang.Object

org.jenkinsci.plugins.githubautostatus.notifiers.InfluxDbNotifier

All Implemented Interfaces:

BuildNotifier

public class InfluxDbNotifier
extends Object
implements BuildNotifier

Writes job and stage measurements to an influxdb REST API.

Author:

Jeff Pearce (jxpearce@godaddy.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authorization
protected String	branchName
protected InfluxDbNotifierConfig	config
protected String	DEFAULT_STRING
protected String	influxDbUrlString
protected String	repoName
protected String	repoOwner

Constructor Summary

Constructors

Constructor and Description
InfluxDbNotifier(InfluxDbNotifierConfig config)

Method Summary

Modifier and Type	Method and Description
protected String	escapeTagValue(String tagValue)
boolean	isEnabled() Determine whether notifier is enabled
void	notifyBuildStageStatus(String jobName, String nodeName, BuildState buildState, long timingInfo) Send a state change to influx
void	notifyBuildState(String jobName, String nodeName, BuildState buildState) Send stage status notification to influx
void	notifyFinalBuildStatus(String jobName, BuildState buildState, long buildDuration, long blockedDuration) Send final build status to influx
void	sendNonStageError(String jobName, String nodeName) Sends a notification for an error regardless of whether initial pending status was sent.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STRING

protected final String DEFAULT_STRING

See Also:

Constant Field Values

repoOwner

protected String repoOwner

repoName

protected String repoName

branchName

protected String branchName

influxDbUrlString

protected String influxDbUrlString

config

protected InfluxDbNotifierConfig config

authorization

protected transient String authorization

Constructor Detail

InfluxDbNotifier

public InfluxDbNotifier(InfluxDbNotifierConfig config)

Method Detail

isEnabled

public boolean isEnabled()

Determine whether notifier is enabled

Specified by:

isEnabled in interface BuildNotifier

Returns:

true if enabled; false otherwise

notifyBuildState

public void notifyBuildState(String jobName,
                             String nodeName,
                             BuildState buildState)

Send stage status notification to influx

Specified by:

notifyBuildState in interface BuildNotifier

Parameters:

nodeName - the node that has changed

buildState - the new state

jobName - the name of the job.

notifyBuildStageStatus

public void notifyBuildStageStatus(String jobName,
                                   String nodeName,
                                   BuildState buildState,
                                   long timingInfo)

Send a state change to influx

Specified by:

notifyBuildStageStatus in interface BuildNotifier

Parameters:

jobName - the name of the job

nodeName - the node that has changed

buildState - the new state

timingInfo - timingInfo

notifyFinalBuildStatus

public void notifyFinalBuildStatus(String jobName,
                                   BuildState buildState,
                                   long buildDuration,
                                   long blockedDuration)

Send final build status to influx

Specified by:

notifyFinalBuildStatus in interface BuildNotifier

Parameters:

jobName - the name of the job

buildState - the new state

buildDuration - overall build time

blockedDuration - time build was blocked before running

sendNonStageError

public void sendNonStageError(String jobName,
                              String nodeName)

Description copied from interface: BuildNotifier

Sends a notification for an error regardless of whether initial pending status was sent. Useful for reporting errors for non-declarative pipelines since they can happen outside of a stage.

Specified by:

sendNonStageError in interface BuildNotifier

Parameters:

jobName - the name of the job

nodeName - the name of the node that failed

escapeTagValue

protected String escapeTagValue(String tagValue)