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:

CounterWithCallback, GaugeWithCallback, Info, StatefulMetric, SummaryWithCallback

@StableApi
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
protected final io.prometheus.metrics.model.snapshots.MetricMetadata	metadata

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
Set<String>	getLabelNames()	Deprecated. Use getMetricFamilyDescriptor() instead.
io.prometheus.metrics.model.snapshots.MetricMetadata	getMetadata()	Deprecated. Use getMetricFamilyDescriptor() instead.
io.prometheus.metrics.model.snapshots.MetricFamilyDescriptor	getMetricFamilyDescriptor()
String	getPrometheusName()	Deprecated. Use getMetricFamilyDescriptor() instead.

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, getMetricType

Field Details

metadata

protected final io.prometheus.metrics.model.snapshots.MetricMetadata metadata

labelNames

protected final String[] labelNames

Constructor Details

MetricWithFixedMetadata

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

Method Details

getMetricFamilyDescriptor

@Nullable
public io.prometheus.metrics.model.snapshots.MetricFamilyDescriptor getMetricFamilyDescriptor()

getMetadata

@Deprecated
public io.prometheus.metrics.model.snapshots.MetricMetadata getMetadata()

Deprecated.

Use getMetricFamilyDescriptor() instead.

getPrometheusName

@Deprecated
public String getPrometheusName()

Deprecated.

Use getMetricFamilyDescriptor() instead.

getLabelNames

@Deprecated
public Set<String> getLabelNames()

Deprecated.

Use getMetricFamilyDescriptor() instead.