Package org.jenkinsci.plugins.prometheus.collectors.jenkins

Class JenkinsUpGauge

java.lang.Object

org.jenkinsci.plugins.prometheus.collectors.BaseMetricCollector<Jenkins,io.prometheus.client.Gauge>

org.jenkinsci.plugins.prometheus.collectors.jenkins.JenkinsUpGauge

All Implemented Interfaces:

MetricCollector<Jenkins,io.prometheus.client.Gauge>

public class JenkinsUpGauge
extends BaseMetricCollector<Jenkins,io.prometheus.client.Gauge>

Field Summary

Fields inherited from class org.jenkinsci.plugins.prometheus.collectors.BaseMetricCollector

collector, labelNames, namePrefix, namespace, SEPARATOR, subsystem

Method Summary

Modifier and Type	Method	Description
void	calculateMetric(Jenkins jenkinsObject, String[] labelValues)	This method contains the logic to calculate a metric value based on the given Jenkins object (e.g.
protected io.prometheus.client.SimpleCollector.Builder<?,io.prometheus.client.Gauge>	getCollectorBuilder()
protected CollectorType	getCollectorType()
protected String	getHelpText()

Methods inherited from class org.jenkinsci.plugins.prometheus.collectors.BaseMetricCollector

calculateName, collect, getBaseName, initCollector

Methods inherited from class java.lang.Object

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

Method Detail

getCollectorType

protected CollectorType getCollectorType()

Specified by:

getCollectorType in class BaseMetricCollector<Jenkins,io.prometheus.client.Gauge>

Returns:

- the name of the collector without subsystem, namespace, prefix

getHelpText

protected String getHelpText()

Specified by:

getHelpText in class BaseMetricCollector<Jenkins,io.prometheus.client.Gauge>

Returns:

- the help text which should be displayed

getCollectorBuilder

protected io.prometheus.client.SimpleCollector.Builder<?,io.prometheus.client.Gauge> getCollectorBuilder()

Specified by:

getCollectorBuilder in class BaseMetricCollector<Jenkins,io.prometheus.client.Gauge>

Returns:

- builder object of the type of collector

calculateMetric

public void calculateMetric(Jenkins jenkinsObject,
                            String[] labelValues)

Description copied from interface: MetricCollector

This method contains the logic to calculate a metric value based on the given Jenkins object (e.g. Job, Run,...)

Specified by:

calculateMetric in interface MetricCollector<Jenkins,io.prometheus.client.Gauge>

Specified by:

calculateMetric in class BaseMetricCollector<Jenkins,io.prometheus.client.Gauge>

Parameters:

jenkinsObject - - Examples: Job, Run

labelValues - - The label values for the calculation