io.prometheus.client

Class Enumeration

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.SimpleCollector<Enumeration.Child>

io.prometheus.client.Enumeration

All Implemented Interfaces:

Collector.Describable

public class Enumeration
extends SimpleCollector<Enumeration.Child>
implements Collector.Describable

Enumeration metric, to track which of a set of states something is in. The first provided state will be the default.

Example enumeration:

 
   class YourClass {
     static final Enumeration taskState = Enumeration.build()
         .name("task_state").help("State of the task.")
         .states("stopped", "starting", "running")
         .register();

     void stop() {
          // Your code here.
          taskState.state("stopped")
     }
   }
 
 

You can also use a Java Enum:

   class YourClass {
     public enum yourEnum {
       STOPPED,
       STARTING,
       RUNNING,
     }
     static final Enumeration taskState = Enumeration.build()
         .name("task_state").help("State of the task.")
         .states(yourEnum.class)
         .register();

     void stop() {
          // Your code here.
          taskState.state(yourEnum.STOPPED)
     }
   }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Enumeration.Builder
static class	Enumeration.Child The value of a single Enumeration.

Nested classes/interfaces inherited from class io.prometheus.client.Collector

Collector.Describable, Collector.MetricFamilySamples, Collector.Type

Field Summary

Fields inherited from class io.prometheus.client.SimpleCollector

children, fullname, help, labelNames, noLabelsChild, unit

Fields inherited from class io.prometheus.client.Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Method Summary

Modifier and Type	Method and Description
static Enumeration.Builder	build() Return a Builder to allow configuration of a new Enumeration.
static Enumeration.Builder	build(String name, String help) Return a Builder to allow configuration of a new Enumeration.
List<Collector.MetricFamilySamples>	collect() Return all of the metrics of this Collector.
List<Collector.MetricFamilySamples>	describe() Provide a list of metric families this Collector is expected to return.
String	get() Get the value of the Enumeration.
protected Enumeration.Child	newChild() Return a new child, workaround for Java generics limitations.
void	state(Enum e) Set the state on the enum with no labels.
void	state(String s) Set the state on the enum with no labels.

Methods inherited from class io.prometheus.client.SimpleCollector

clear, familySamplesList, initializeNoLabelsChild, labels, remove, setChild

Methods inherited from class io.prometheus.client.Collector

checkMetricLabelName, checkMetricName, doubleToGoString, register, register, sanitizeMetricName

Methods inherited from class java.lang.Object

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

Method Detail

build

public static Enumeration.Builder build(String name,
                                        String help)

Return a Builder to allow configuration of a new Enumeration. Ensures required fields are provided.

Parameters:

name - The name of the metric

help - The help string of the metric

build

public static Enumeration.Builder build()

Return a Builder to allow configuration of a new Enumeration.

newChild

protected Enumeration.Child newChild()

Description copied from class: SimpleCollector

Return a new child, workaround for Java generics limitations.

Specified by:

newChild in class SimpleCollector<Enumeration.Child>

state

public void state(String s)

Set the state on the enum with no labels.

state

public void state(Enum e)

Set the state on the enum with no labels.

get

public String get()

Get the value of the Enumeration.

collect

public List<Collector.MetricFamilySamples> collect()

Description copied from class: Collector

Return all of the metrics of this Collector.

Specified by:

collect in class Collector

describe

public List<Collector.MetricFamilySamples> describe()

Description copied from interface: Collector.Describable

Provide a list of metric families this Collector is expected to return. These should exclude the samples. This is used by the registry to detect collisions and duplicate registrations. Usually custom collectors do not have to implement Describable. If Describable is not implemented and the CollectorRegistry was created with auto describe enabled (which is the case for the default registry) then collect will be called at registration time instead of describe. If this could cause problems, either implement a proper describe, or if that's not practical have describe return an empty list.

Specified by:

describe in interface Collector.Describable