Index (Prometheus Metrics Model 1.2.1 API)

A

add(String, String) - Method in class Labels: Create a new Labels instance containing the labels of this and the label passed as name and value.
ALLOW_ALL - Static variable in class MetricNameFilter: For convenience, a filter that allows all names.
AMPERES - Static variable in class Unit

B

C

D

E

G

GaugeDataPointSnapshot(double, Labels, Exemplar) - Constructor for class GaugeSnapshot.GaugeDataPointSnapshot: To create a new GaugeSnapshot.GaugeDataPointSnapshot, you can either call the constructor directly or use the Builder with GaugeSnapshot.GaugeDataPointSnapshot.builder().
GaugeDataPointSnapshot(double, Labels, Exemplar, long) - Constructor for class GaugeSnapshot.GaugeDataPointSnapshot: Constructor with an additional scrape timestamp.
gaugeHistogram(boolean) - Method in class HistogramSnapshot.Builder: true indicates that this histogram is a gauge histogram.
GaugeSnapshot - Class in io.prometheus.metrics.model.snapshots: Immutable snapshot of a Gauge.
GaugeSnapshot(MetricMetadata, Collection<GaugeSnapshot.GaugeDataPointSnapshot>) - Constructor for class GaugeSnapshot: To create a new GaugeSnapshot, you can either call the constructor directly or use the builder with GaugeSnapshot.builder().
GaugeSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
GaugeSnapshot.GaugeDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
GaugeSnapshot.GaugeDataPointSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
get(double, double) - Method in class Exemplars: This is used by classic histograms to find an exemplar with a value between lowerBound and upperBound.
get(int) - Method in class Exemplars
get(int) - Method in class MetricSnapshots
get(int) - Method in class Quantiles
get(String) - Method in class Labels: Get the label value for a given label name.
getBucketIndex() - Method in class NativeHistogramBucket: See NativeHistogramBuckets for info on native bucket indexes.
getBucketIndex(int) - Method in class NativeHistogramBuckets
getClassicBuckets() - Method in class HistogramSnapshot.HistogramDataPointSnapshot: Will return garbage if HistogramSnapshot.HistogramDataPointSnapshot.hasClassicHistogramData() is false.
getCount() - Method in class ClassicHistogramBucket
getCount() - Method in class DistributionDataPointSnapshot: This will return garbage if DistributionDataPointSnapshot.hasCount() is false.
getCount() - Method in class NativeHistogramBucket
getCount(int) - Method in class ClassicHistogramBuckets: The count is not cumulative.
getCount(int) - Method in class NativeHistogramBuckets
getCreatedTimestampMillis() - Method in class DataPointSnapshot: This will only return a reasonable value if DataPointSnapshot.hasCreatedTimestamp() is true.
getDataPoints() - Method in class CounterSnapshot
getDataPoints() - Method in class GaugeSnapshot
getDataPoints() - Method in class HistogramSnapshot
getDataPoints() - Method in class InfoSnapshot
getDataPoints() - Method in class MetricSnapshot
getDataPoints() - Method in class StateSetSnapshot
getDataPoints() - Method in class SummarySnapshot
getDataPoints() - Method in class UnknownSnapshot
getExemplar() - Method in class CounterSnapshot.CounterDataPointSnapshot: May be null.
getExemplar() - Method in class GaugeSnapshot.GaugeDataPointSnapshot: May be null.
getExemplar() - Method in class UnknownSnapshot.UnknownDataPointSnapshot: May return null.
getExemplars() - Method in class DistributionDataPointSnapshot: May be Exemplars.EMPTY, but will never be null.
getHelp() - Method in class MetricMetadata
getLabels() - Method in class DataPointSnapshot
getLabels() - Method in class Exemplar: In most cases labels will contain Exemplar.TRACE_ID and Exemplar.SPAN_ID, but this is not required.
getLatest() - Method in class Exemplars: Find the Exemplar with the newest timestamp.
getMetadata() - Method in class MetricSnapshot
getName() - Method in class Label
getName() - Method in class MetricMetadata: The name does not include the _total suffix for counter metrics or the _info suffix for Info metrics.
getName() - Method in class StateSetSnapshot.State
getName(int) - Method in class Labels
getName(int) - Method in class StateSetSnapshot.StateSetDataPointSnapshot
getNativeBucketsForNegativeValues() - Method in class HistogramSnapshot.HistogramDataPointSnapshot: Will return garbage if HistogramSnapshot.HistogramDataPointSnapshot.hasNativeHistogramData() is false.
getNativeBucketsForPositiveValues() - Method in class HistogramSnapshot.HistogramDataPointSnapshot: Will return garbage if HistogramSnapshot.HistogramDataPointSnapshot.hasNativeHistogramData() is false.
getNativeSchema() - Method in class HistogramSnapshot.HistogramDataPointSnapshot: The schema defines the scale of the native histogram, i.g.
getNativeZeroCount() - Method in class HistogramSnapshot.HistogramDataPointSnapshot: Number of observed zero values.
getNativeZeroThreshold() - Method in class HistogramSnapshot.HistogramDataPointSnapshot: All observations in [-nativeZeroThreshold; +nativeZeroThreshold] are treated as zero.
getParameterValues(String) - Method in interface PrometheusScrapeRequest: See jakarta.servlet.ServletRequest.getParameterValues(String name)
getPrometheusName() - Method in interface Collector: This is called in two places: During registration to check if a metric with that name already exists. During scrape to check if this collector can be skipped because a name filter is present and the metric name is excluded. Returning null means checks are omitted (registration the metric always succeeds), and the collector is always scraped (the result is dropped after scraping if a name filter is present and the metric name is excluded).
getPrometheusName() - Method in class MetricMetadata: Same as MetricMetadata.getName() but with dots replaced by underscores.
getPrometheusName(int) - Method in class Labels: Like Labels.getName(int), but dots are replaced with underscores.
getPrometheusNames() - Method in interface MultiCollector: This is called in two places: During registration to check if a metric with that name already exists. During scrape to check if the collector can be skipped because a name filter is present and all names are excluded. Returning an empty list means checks are omitted (registration metric always succeeds), and the collector is always scraped (if a name filter is present and all names are excluded the result is dropped).
getQuantile() - Method in class Quantile
getQuantiles() - Method in class SummarySnapshot.SummaryDataPointSnapshot
getRequestPath() - Method in interface PrometheusScrapeRequest: Absolute path of the HTTP request.
getScrapeTimestampMillis() - Method in class DataPointSnapshot: This will only return a reasonable value if DataPointSnapshot.hasScrapeTimestamp() is true.
getSum() - Method in class DistributionDataPointSnapshot: This will return garbage if DistributionDataPointSnapshot.hasSum() is false.
getTimestampMillis() - Method in class Exemplar: Will return garbage if Exemplar.hasTimestamp() is false.
getUnit() - Method in class MetricMetadata
getUpperBound() - Method in class ClassicHistogramBucket
getUpperBound(int) - Method in class ClassicHistogramBuckets
getValue() - Method in class CounterSnapshot.CounterDataPointSnapshot
getValue() - Method in class Exemplar
getValue() - Method in class GaugeSnapshot.GaugeDataPointSnapshot
getValue() - Method in class Label
getValue() - Method in class Quantile
getValue() - Method in class UnknownSnapshot.UnknownDataPointSnapshot
getValue(int) - Method in class Labels
GRAMS - Static variable in class Unit

H

I

J

JOULES - Static variable in class Unit

K

L

M

N

O

of(double[], long[]) - Static method in class ClassicHistogramBuckets: To create new ClassicHistogramBuckets, you can either use one of the static of(...) methods, or use ClassicHistogramBuckets.builder().
of(double[], Number[]) - Static method in class ClassicHistogramBuckets: To create new ClassicHistogramBuckets, you can either use one of the static of(...) methods, or use ClassicHistogramBuckets.builder().
of(int[], long[]) - Static method in class NativeHistogramBuckets: To create a new NativeHistogramBuckets instance, you can either use one of the static of(...) methods, or use NativeHistogramBuckets.builder().
of(Exemplar...) - Static method in class Exemplars: Create a new Exemplars instance.
of(MetricSnapshot...) - Static method in class MetricSnapshots
of(Quantile...) - Static method in class Quantiles: Create a new Quantiles instance.
of(String...) - Static method in class Labels: Create a new Labels instance.
of(String[], String[]) - Static method in class Labels: Create a new Labels instance.
of(Collection<Exemplar>) - Static method in class Exemplars: Create a new Exemplars instance.
of(List<Quantile>) - Static method in class Quantiles: Create a new Quantiles instance.
of(List<Double>, List<? extends Number>) - Static method in class ClassicHistogramBuckets: To create new ClassicHistogramBuckets, you can either use one of the static of(...) methods, or use ClassicHistogramBuckets.builder().
of(List<Integer>, List<Long>) - Static method in class NativeHistogramBuckets: To create a new NativeHistogramBuckets instance, you can either use one of the static of(...) methods, or use NativeHistogramBuckets.builder().
of(List<String>, List<String>) - Static method in class Labels: Create a new Labels instance.

P

prometheusName(String) - Static method in class PrometheusNaming: Get the metric or label name that is used in Prometheus exposition format.
PrometheusNaming - Class in io.prometheus.metrics.model.snapshots: Utility for Prometheus Metric and Label naming.
PrometheusNaming() - Constructor for class PrometheusNaming
PrometheusRegistry - Class in io.prometheus.metrics.model.registry
PrometheusRegistry() - Constructor for class PrometheusRegistry
PrometheusScrapeRequest - Interface in io.prometheus.metrics.model.registry: Infos extracted from the request received by the endpoint

Q

R

S

T

test(String) - Method in class MetricNameFilter
timestampMillis(long) - Method in class Exemplar.Builder
toString() - Method in class Labels: This must not be used in Prometheus exposition formats because names may contain dots.
toString() - Method in class Unit
TRACE_ID - Static variable in class Exemplar: Label name for trace id.
traceId(String) - Method in class Exemplar.Builder

U

V