Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class MetricMetadata

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricMetadata

public final class MetricMetadata
extends Object

Immutable container for metric metadata: name, help, unit.

Constructor Summary

Constructors

Constructor	Description
MetricMetadata(String name)	See MetricMetadata(String, String, Unit)
MetricMetadata(String name, String help)	See MetricMetadata(String, String, Unit)
MetricMetadata(String name, String help, Unit unit)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getHelp()
String	getName()	The name does not include the _total suffix for counter metrics or the _info suffix for Info metrics.
String	getPrometheusName()	Same as getName() but with dots replaced by underscores.
Unit	getUnit()
boolean	hasUnit()

Methods inherited from class java.lang.Object

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

Constructor Details

MetricMetadata

public MetricMetadata(String name)

See MetricMetadata(String, String, Unit)

MetricMetadata

public MetricMetadata(String name,
 String help)

See MetricMetadata(String, String, Unit)

MetricMetadata

public MetricMetadata(String name,
 String help,
 Unit unit)

Constructor.

Parameters:

name - must not be null. isValidMetricName(name) must be true. Use PrometheusNaming.sanitizeMetricName(String) to convert arbitrary strings into valid names.

help - optional. May be null.

unit - optional. May be null.

Method Details

getName

public String getName()

The name does not include the _total suffix for counter metrics or the _info suffix for Info metrics.

The name may contain dots. Use getPrometheusName() to get the name in Prometheus format, i.e. with dots replaced by underscores.

getPrometheusName

public String getPrometheusName()

Same as getName() but with dots replaced by underscores.

This is used by Prometheus exposition formats.

getHelp

public String getHelp()

hasUnit

public boolean hasUnit()

getUnit

public Unit getUnit()