io.prometheus.client

Class CollectorRegistry

java.lang.Object

io.prometheus.client.CollectorRegistry

public class CollectorRegistry
extends Object

A registry of Collectors.

The majority of users should use the defaultRegistry, rather than instantiating their own.

Creating a registry other than the default is primarily useful for unittests, or pushing a subset of metrics to the Pushgateway from batch jobs.

Field Summary

Fields

Modifier and Type	Field and Description
static CollectorRegistry	defaultRegistry The default registry.

Constructor Summary

Constructors

Constructor and Description
CollectorRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Unregister all Collectors.
Double	getSampleValue(String name) Returns the given value, or null if it doesn't exist.
Double	getSampleValue(String name, String[] labelNames, String[] labelValues) Returns the given value, or null if it doesn't exist.
Enumeration<Collector.MetricFamilySamples>	metricFamilySamples() Enumeration of metrics of all registered collectors.
void	register(Collector m) Register a Collector.
void	unregister(Collector m) Unregister a Collector.

Methods inherited from class java.lang.Object

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

Field Detail

defaultRegistry

public static final CollectorRegistry defaultRegistry

The default registry.

Constructor Detail

CollectorRegistry

public CollectorRegistry()

Method Detail

register

public void register(Collector m)

Register a Collector.

A collector can be registered to multiple CollectorRegistries.

unregister

public void unregister(Collector m)

Unregister a Collector.

clear

public void clear()

Unregister all Collectors.

metricFamilySamples

public Enumeration<Collector.MetricFamilySamples> metricFamilySamples()

Enumeration of metrics of all registered collectors.

getSampleValue

public Double getSampleValue(String name)

Returns the given value, or null if it doesn't exist.

This is inefficient, and intended only for use in unittests.

getSampleValue

public Double getSampleValue(String name,
                    String[] labelNames,
                    String[] labelValues)

Returns the given value, or null if it doesn't exist.

This is inefficient, and intended only for use in unittests.