Module io.prometheus.metrics.model

Package io.prometheus.metrics.model.snapshots

Class MetricFamilyDescriptor

java.lang.Object

io.prometheus.metrics.model.snapshots.MetricFamilyDescriptor

@StableApi
public final class MetricFamilyDescriptor
extends Object

Registration-time descriptor for a metric family.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricFamilyDescriptor.Builder<T extends MetricFamilyDescriptor.Builder<T>>
static final class	MetricFamilyDescriptor.CounterBuilder
static final class	MetricFamilyDescriptor.GaugeBuilder
static final class	MetricFamilyDescriptor.HistogramBuilder
static final class	MetricFamilyDescriptor.InfoBuilder
static final class	MetricFamilyDescriptor.StateSetBuilder
static final class	MetricFamilyDescriptor.SummaryBuilder
static final class	MetricFamilyDescriptor.UnknownBuilder

Method Summary

Modifier and Type	Method	Description
static MetricFamilyDescriptor.CounterBuilder	counter(String name)
static MetricFamilyDescriptor.GaugeBuilder	gauge(String name)
Set<String>	getLabelNames()
MetricMetadata	getMetadata()
String	getPrometheusName()
MetricType	getType()
static MetricFamilyDescriptor.HistogramBuilder	histogram(String name)
static MetricFamilyDescriptor.InfoBuilder	info(String name)
static MetricFamilyDescriptor	of(MetricType type, MetricMetadata metadata)
static MetricFamilyDescriptor	of(MetricType type, MetricMetadata metadata, Collection<String> labelNames)
static MetricFamilyDescriptor.Builder<?>	of(MetricType type, String name)
static MetricFamilyDescriptor.StateSetBuilder	stateSet(String name)
static MetricFamilyDescriptor.SummaryBuilder	summary(String name)
static MetricFamilyDescriptor.UnknownBuilder	unknown(String name)

Methods inherited from class java.lang.Object

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

Method Details

of

public static MetricFamilyDescriptor of(MetricType type,
 MetricMetadata metadata)

of

public static MetricFamilyDescriptor of(MetricType type,
 MetricMetadata metadata,
 Collection<String> labelNames)

of

public static MetricFamilyDescriptor.Builder<?> of(MetricType type,
 String name)

counter

public static MetricFamilyDescriptor.CounterBuilder counter(String name)

gauge

public static MetricFamilyDescriptor.GaugeBuilder gauge(String name)

histogram

public static MetricFamilyDescriptor.HistogramBuilder histogram(String name)

summary

public static MetricFamilyDescriptor.SummaryBuilder summary(String name)

info

public static MetricFamilyDescriptor.InfoBuilder info(String name)

stateSet

public static MetricFamilyDescriptor.StateSetBuilder stateSet(String name)

unknown

public static MetricFamilyDescriptor.UnknownBuilder unknown(String name)

getType

public MetricType getType()

getMetadata

public MetricMetadata getMetadata()

getLabelNames

public Set<String> getLabelNames()

getPrometheusName

public String getPrometheusName()