Class PrometheusRegistry

java.lang.Object

io.prometheus.metrics.model.registry.PrometheusRegistry

public class PrometheusRegistry
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PrometheusRegistry.CollectorRegistration	Stores the registration details for a Collector at registration time.
private static class	PrometheusRegistry.MultiCollectorRegistration	Stores the registration details for a single metric within a MultiCollector.
private static class	PrometheusRegistry.RegistrationInfo	Tracks registration information for each metric name to enable validation of type consistency, label schema uniqueness, and help/unit consistency.

Field Summary

Fields

Modifier and Type	Field	Description
private final ConcurrentHashMap<Collector, PrometheusRegistry.CollectorRegistration>	collectorMetadata
private final Set<Collector>	collectors
static final PrometheusRegistry	defaultRegistry
private final ConcurrentHashMap<MultiCollector, List<PrometheusRegistry.MultiCollectorRegistration>>	multiCollectorMetadata
private final Set<MultiCollector>	multiCollectors
private final ConcurrentHashMap<String, PrometheusRegistry.RegistrationInfo>	registered

Constructor Summary

Constructors

Constructor	Description
PrometheusRegistry()

Method Summary

Modifier and Type	Method	Description
void	clear()
private static Set<String>	immutableLabelNames(Set<String> labelNames)	Returns an immutable set of label names for storage.
void	register(Collector collector)
void	register(MultiCollector collector)
MetricSnapshots	scrape()
MetricSnapshots	scrape(PrometheusScrapeRequest scrapeRequest)
MetricSnapshots	scrape(Predicate<String> includedNames)
MetricSnapshots	scrape(Predicate<String> includedNames, PrometheusScrapeRequest scrapeRequest)
void	unregister(Collector collector)
void	unregister(MultiCollector collector)
private void	unregisterLabelSchema(String prometheusName, Set<String> labelNames)	Removes the label schema for the given metric name.
private void	validateRegistration(String prometheusName, MetricType metricType, Set<String> normalizedLabels, String help, Unit unit)	Validates the registration of a metric with the given parameters.

Methods inherited from class Object

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

Field Details

defaultRegistry

public static final PrometheusRegistry defaultRegistry

collectors

private final Set<Collector> collectors

multiCollectors

private final Set<MultiCollector> multiCollectors

registered

private final ConcurrentHashMap<String, PrometheusRegistry.RegistrationInfo> registered

collectorMetadata

private final ConcurrentHashMap<Collector, PrometheusRegistry.CollectorRegistration> collectorMetadata

multiCollectorMetadata

private final ConcurrentHashMap<MultiCollector, List<PrometheusRegistry.MultiCollectorRegistration>> multiCollectorMetadata

Constructor Details

PrometheusRegistry

public PrometheusRegistry()

Method Details

immutableLabelNames

private static Set<String> immutableLabelNames(Set<String> labelNames)

Returns an immutable set of label names for storage. Defends against mutation of the set returned by Collector.getLabelNames() after registration, which would break duplicate detection and unregistration.

validateRegistration

private void validateRegistration(String prometheusName,
 MetricType metricType,
 Set<String> normalizedLabels,
 String help,
 Unit unit)

Validates the registration of a metric with the given parameters. Ensures type consistency, label schema uniqueness, and help/unit consistency.

register

public void register(Collector collector)

register

public void register(MultiCollector collector)

unregister

public void unregister(Collector collector)

unregister

public void unregister(MultiCollector collector)

unregisterLabelSchema

private void unregisterLabelSchema(String prometheusName,
 Set<String> labelNames)

Removes the label schema for the given metric name. If no label schemas remain for that name, removes the metric name entirely from the registry.

clear

public void clear()

scrape

public MetricSnapshots scrape()

scrape

public MetricSnapshots scrape(PrometheusScrapeRequest scrapeRequest)

scrape

public MetricSnapshots scrape(Predicate<String> includedNames)

scrape

public MetricSnapshots scrape(Predicate<String> includedNames,
 PrometheusScrapeRequest scrapeRequest)