org.jenkinsci.plugins.githubautostatus.notifiers

Class InfluxDbNotifier

java.lang.Object

org.jenkinsci.plugins.githubautostatus.notifiers.BuildNotifier

org.jenkinsci.plugins.githubautostatus.notifiers.InfluxDbNotifier

All Implemented Interfaces:

hudson.ExtensionPoint

public class InfluxDbNotifier
extends BuildNotifier

Writes job and stage measurements to an InfluxDB REST API.

Author:

Jeff Pearce (GitHub jeffpearce)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

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

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

DEFAULT_LONG, DEFAULT_STRING

Constructor Summary

Constructors

Constructor and Description
InfluxDbNotifier(InfluxDbNotifierConfig config) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled() Determines whether this notifier is enabled.
void	notifyBuildStageStatus(String jobName, BuildStage stageItem) Sends a state change to InfluxDB.
void	notifyFinalBuildStatus(BuildStage.State buildState, Map<String,Object> parameters) Sends the final build status to InfluxDB.
boolean	wantsOutOfStageErrors() Get whether the notifier wants to know about errors that happen outside of a stage.

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

all, getLong

Methods inherited from class java.lang.Object

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

Field Detail

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)

Constructor

Parameters:

config - InfluxDB configuration info

Method Detail

isEnabled

public boolean isEnabled()

Determines whether this notifier is enabled.

Specified by:

isEnabled in class BuildNotifier

Returns:

true if enabled; false otherwise

wantsOutOfStageErrors

public boolean wantsOutOfStageErrors()

Get whether the notifier wants to know about errors that happen outside of a stage.

Overrides:

wantsOutOfStageErrors in class BuildNotifier

Returns:

true; since this notifier reports these errors.

notifyBuildStageStatus

public void notifyBuildStageStatus(String jobName,
                                   BuildStage stageItem)

Sends a state change to InfluxDB.

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 the final build status to InfluxDB.

Specified by:

notifyFinalBuildStatus in class BuildNotifier

Parameters:

buildState - the new state

parameters - build parameters