Package io.prometheus.metrics.model.snapshots

Class MetricMetadata

Object

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 all invalid characters and dots replaced by underscores.
Unit	getUnit()
boolean	hasUnit()

Methods inherited from class Object

equals, 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,
 @Nullable
 String help,
 @Nullable
 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

@Nullable
public String getHelp()

hasUnit

public boolean hasUnit()

getUnit

@Nullable
public Unit getUnit()