Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class MetricWithFixedMetadata

java.lang.Object

io.prometheus.metrics.core.metrics.Metric

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata

All Implemented Interfaces:

io.prometheus.metrics.model.registry.Collector

Direct Known Subclasses:

Counter, CounterWithCallback, Gauge, GaugeWithCallback, Histogram, Info, StateSet, Summary, SummaryWithCallback

public abstract class MetricWithFixedMetadata
extends Metric

Almost all metrics have fixed metadata, i.e. the metric name is known when the metric is created.

An exception would be a metric that is a bridge to a 3rd party metric library, where the metric name has to be retrieved from the 3rd party metric library at scrape time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricWithFixedMetadata.Builder<B extends MetricWithFixedMetadata.Builder<B,M>,M extends MetricWithFixedMetadata>

Field Summary

Fields

Modifier and Type	Field	Description
protected final String[]	labelNames

Fields inherited from class io.prometheus.metrics.core.metrics.Metric

constLabels

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetricWithFixedMetadata(MetricWithFixedMetadata.Builder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
protected io.prometheus.metrics.model.snapshots.MetricMetadata	getMetadata()
String	getPrometheusName()

Methods inherited from class io.prometheus.metrics.core.metrics.Metric

collect

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.prometheus.metrics.model.registry.Collector

collect, collect, collect

Field Details

labelNames

protected final String[] labelNames

Constructor Details

MetricWithFixedMetadata

protected MetricWithFixedMetadata(MetricWithFixedMetadata.Builder<?,?> builder)

Method Details

getMetadata

protected io.prometheus.metrics.model.snapshots.MetricMetadata getMetadata()

getPrometheusName

public String getPrometheusName()