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.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	help
private final String	name	Name without suffix.
private final String	prometheusName	Same as name that all invalid char (without Unicode support) are replaced by _
private final Unit	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
(package private) MetricMetadata	escape(EscapingScheme escapingScheme)
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 all invalid characters and dots replaced by underscores.
Unit	getUnit()
boolean	hasUnit()
private void	validate()

Methods inherited from class Object

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

Field Details

name

private final String name

Name without suffix.

For example, the name for a counter "http_requests_total" is "http_requests". The name of an info called "jvm_info" is "jvm".

We allow dots in label names. Dots are automatically replaced with underscores in Prometheus exposition formats. However, if metrics from this library are exposed in OpenTelemetry format dots are retained.

See MetricMetadata(String, String, Unit) for more info on naming conventions.

prometheusName

private final String prometheusName

Same as name that all invalid char (without Unicode support) are replaced by _

Multiple metrics with the same prometheusName are not allowed, because they would end up in the same time series in Prometheus if EscapingScheme.UNDERSCORE_ESCAPING or EscapingScheme.DOTS_ESCAPING is used.

help

private final String help

unit

private final Unit unit

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 any Unicode chars. Use getPrometheusName() to get the name in legacy Prometheus format, i.e. with all dots and all invalid chars replaced by underscores.

getPrometheusName

public String getPrometheusName()

Same as getName() but with all invalid characters and dots replaced by underscores.

This is used by Prometheus exposition formats.

getHelp

public String getHelp()

hasUnit

public boolean hasUnit()

getUnit

public Unit getUnit()

validate

private void validate()

escape

MetricMetadata escape(EscapingScheme escapingScheme)