Index
All Classes and Interfaces|All Packages|Constant Field Values
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
- bucket(double, long) - Method in class ClassicHistogramBuckets.Builder
-
Must be called at least once for the
Double.POSITIVE_INFINITY
bucket. - bucket(int, long) - Method in class NativeHistogramBuckets.Builder
-
Add a native histogram bucket.
- build() - Method in class MetricNameFilter.Builder
- build() - Method in class ClassicHistogramBuckets.Builder
-
Will throw an
IllegalArgumentException
if theDouble.POSITIVE_INFINITY
bucket is missing. - build() - Method in class CounterSnapshot.Builder
- build() - Method in class CounterSnapshot.CounterDataPointSnapshot.Builder
- build() - Method in class Exemplar.Builder
- build() - Method in class Exemplars.Builder
- build() - Method in class GaugeSnapshot.Builder
- build() - Method in class GaugeSnapshot.GaugeDataPointSnapshot.Builder
- build() - Method in class HistogramSnapshot.Builder
- build() - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- build() - Method in class InfoSnapshot.Builder
- build() - Method in class InfoSnapshot.InfoDataPointSnapshot.Builder
- build() - Method in class Labels.Builder
- build() - Method in class MetricSnapshots.Builder
- build() - Method in class NativeHistogramBuckets.Builder
- build() - Method in class Quantiles.Builder
- build() - Method in class StateSetSnapshot.Builder
- build() - Method in class StateSetSnapshot.StateSetDataPointSnapshot.Builder
- build() - Method in class SummarySnapshot.Builder
- build() - Method in class SummarySnapshot.SummaryDataPointSnapshot.Builder
- build() - Method in class UnknownSnapshot.Builder
- build() - Method in class UnknownSnapshot.UnknownDataPointSnapshot.Builder
- builder() - Static method in class MetricNameFilter
- builder() - Static method in class ClassicHistogramBuckets
-
To create new
ClassicHistogramBuckets
, you can either use one of the staticof(...)
methods, or usebuilder()
. - builder() - Static method in class CounterSnapshot
- builder() - Static method in class CounterSnapshot.CounterDataPointSnapshot
- builder() - Static method in class Exemplar
- builder() - Static method in class Exemplars
- builder() - Static method in class GaugeSnapshot
- builder() - Static method in class GaugeSnapshot.GaugeDataPointSnapshot
- builder() - Static method in class HistogramSnapshot
- builder() - Static method in class HistogramSnapshot.HistogramDataPointSnapshot
- builder() - Static method in class InfoSnapshot
- builder() - Static method in class InfoSnapshot.InfoDataPointSnapshot
- builder() - Static method in class Labels
- builder() - Static method in class MetricSnapshots
- builder() - Static method in class NativeHistogramBuckets
- builder() - Static method in class Quantiles
- builder() - Static method in class StateSetSnapshot
- builder() - Static method in class StateSetSnapshot.StateSetDataPointSnapshot
- builder() - Static method in class SummarySnapshot
- builder() - Static method in class SummarySnapshot.SummaryDataPointSnapshot
- builder() - Static method in class UnknownSnapshot
- builder() - Static method in class UnknownSnapshot.UnknownDataPointSnapshot
- Builder() - Constructor for class DataPointSnapshot.Builder
- Builder() - Constructor for class MetricSnapshot.Builder
- BYTES - Static variable in class Unit
C
- CELSIUS - Static variable in class Unit
- CLASSIC_HISTOGRAM - Static variable in class HistogramSnapshot
- ClassicHistogramBucket - Class in io.prometheus.metrics.model.snapshots
-
Helper class for iterating over
ClassicHistogramBuckets
. - ClassicHistogramBucket(double, long) - Constructor for class ClassicHistogramBucket
- classicHistogramBuckets(ClassicHistogramBuckets) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- ClassicHistogramBuckets - Class in io.prometheus.metrics.model.snapshots
-
Immutable container for histogram buckets with fixed bucket boundaries.
- ClassicHistogramBuckets.Builder - Class in io.prometheus.metrics.model.snapshots
- collect() - Method in interface Collector
-
Called when the Prometheus server scrapes metrics.
- collect() - Method in interface MultiCollector
-
Called when the Prometheus server scrapes metrics.
- collect(Predicate<String>) - Method in interface Collector
- collect(Predicate<String>) - Method in interface MultiCollector
-
Like
MultiCollector.collect()
, but returns only the snapshots whereincludedNames.test(name)
istrue
. - Collector - Interface in io.prometheus.metrics.model.registry
-
To be registered with the Prometheus collector registry.
- compareTo(ClassicHistogramBucket) - Method in class ClassicHistogramBucket
-
For sorting a list of buckets by upper bound.
- compareTo(Label) - Method in class Label
- compareTo(Labels) - Method in class Labels
- contains(String) - Method in class Labels
-
Test if these labels contain a specific label name.
- containsMetricName(String) - Method in class MetricSnapshots.Builder
- count(long) - Method in class SummarySnapshot.SummaryDataPointSnapshot.Builder
- CounterDataPointSnapshot(double, Labels, Exemplar, long) - Constructor for class CounterSnapshot.CounterDataPointSnapshot
-
To create a new
CounterSnapshot.CounterDataPointSnapshot
, you can either call the constructor directly or use the Builder withCounterSnapshot.CounterDataPointSnapshot.builder()
. - CounterDataPointSnapshot(double, Labels, Exemplar, long, long) - Constructor for class CounterSnapshot.CounterDataPointSnapshot
-
Constructor with an additional scrape timestamp.
- CounterSnapshot - Class in io.prometheus.metrics.model.snapshots
-
Immutable snapshot of a Counter.
- CounterSnapshot(MetricMetadata, Collection<CounterSnapshot.CounterDataPointSnapshot>) - Constructor for class CounterSnapshot
-
To create a new
CounterSnapshot
, you can either call the constructor directly or use the builder withCounterSnapshot.builder()
. - CounterSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- CounterSnapshot.CounterDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
- CounterSnapshot.CounterDataPointSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- createdTimestampMillis(long) - Method in class CounterSnapshot.CounterDataPointSnapshot.Builder
- createdTimestampMillis(long) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
D
- dataPoint(CounterSnapshot.CounterDataPointSnapshot) - Method in class CounterSnapshot.Builder
-
Add a data point.
- dataPoint(GaugeSnapshot.GaugeDataPointSnapshot) - Method in class GaugeSnapshot.Builder
-
Add a data point.
- dataPoint(HistogramSnapshot.HistogramDataPointSnapshot) - Method in class HistogramSnapshot.Builder
-
Add a data point.
- dataPoint(InfoSnapshot.InfoDataPointSnapshot) - Method in class InfoSnapshot.Builder
-
Add a data point.
- dataPoint(StateSetSnapshot.StateSetDataPointSnapshot) - Method in class StateSetSnapshot.Builder
-
Add a data point.
- dataPoint(SummarySnapshot.SummaryDataPointSnapshot) - Method in class SummarySnapshot.Builder
-
Add a data point.
- dataPoint(UnknownSnapshot.UnknownDataPointSnapshot) - Method in class UnknownSnapshot.Builder
-
Add a data point.
- DataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
- DataPointSnapshot.Builder<T extends DataPointSnapshot.Builder<T>> - Class in io.prometheus.metrics.model.snapshots
- defaultRegistry - Static variable in class PrometheusRegistry
- DistributionDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
-
Common base class for histogram and summary data.
E
- EMPTY - Static variable in class ClassicHistogramBuckets
-
Used in native histograms to indicate that no classic histogram buckets are present.
- EMPTY - Static variable in class Exemplars
-
EMPTY means no Exemplars.
- EMPTY - Static variable in class Labels
- EMPTY - Static variable in class NativeHistogramBuckets
- EMPTY - Static variable in class Quantiles
- equals(Object) - Method in class Labels
- exemplar(Exemplar) - Method in class CounterSnapshot.CounterDataPointSnapshot.Builder
- exemplar(Exemplar) - Method in class Exemplars.Builder
-
Add an exemplar.
- exemplar(Exemplar) - Method in class GaugeSnapshot.GaugeDataPointSnapshot.Builder
-
Optional
- exemplar(Exemplar) - Method in class UnknownSnapshot.UnknownDataPointSnapshot.Builder
-
Optional
- Exemplar - Class in io.prometheus.metrics.model.snapshots
-
Immutable representation of an Exemplar.
- Exemplar(double, Labels, long) - Constructor for class Exemplar
-
To create a new
Exemplar
, you can either call the constructor directly or use the Builder withExemplar.builder()
. - Exemplar.Builder - Class in io.prometheus.metrics.model.snapshots
- exemplars(Exemplars) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- exemplars(Collection<Exemplar>) - Method in class Exemplars.Builder
-
Add all exemplars form the collection.
- Exemplars - Class in io.prometheus.metrics.model.snapshots
-
Immutable container for Exemplars.
- Exemplars.Builder - Class in io.prometheus.metrics.model.snapshots
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 withGaugeSnapshot.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 withGaugeSnapshot.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()
isfalse
. - getCount() - Method in class ClassicHistogramBucket
- getCount() - Method in class DistributionDataPointSnapshot
-
This will return garbage if
DistributionDataPointSnapshot.hasCount()
isfalse
. - 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 benull
. - getHelp() - Method in class MetricMetadata
- getLabels() - Method in class DataPointSnapshot
- getLabels() - Method in class Exemplar
-
In most cases labels will contain
Exemplar.TRACE_ID
andExemplar.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()
isfalse
. - getNativeBucketsForPositiveValues() - Method in class HistogramSnapshot.HistogramDataPointSnapshot
-
Will return garbage if
HistogramSnapshot.HistogramDataPointSnapshot.hasNativeHistogramData()
isfalse
. - 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.
- getPrometheusName() - Method in interface Collector
-
Override this and return
null
if a collector does not have a constant name, or if you don't want this library to callCollector.collect()
during registration of this collector. - 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
-
Override this and return an empty list if the MultiCollector does not return a constant list of names (names may be added / removed between scrapes).
- getQuantile() - Method in class Quantile
- getQuantiles() - Method in class SummarySnapshot.SummaryDataPointSnapshot
- 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()
isfalse
. - getTimestampMillis() - Method in class Exemplar
-
Will return garbage if
Exemplar.hasTimestamp()
isfalse
. - 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
- hasClassicHistogramData() - Method in class HistogramSnapshot.HistogramDataPointSnapshot
- hasCount() - Method in class DistributionDataPointSnapshot
- hasCreatedTimestamp() - Method in class DataPointSnapshot
- hashCode() - Method in class Labels
- hasNativeHistogramData() - Method in class HistogramSnapshot.HistogramDataPointSnapshot
- hasSameNames(Labels) - Method in class Labels
- hasSameValues(Labels) - Method in class Labels
- hasScrapeTimestamp() - Method in class DataPointSnapshot
- hasSum() - Method in class DistributionDataPointSnapshot
- hasTimestamp() - Method in class Exemplar
- hasUnit() - Method in class MetricMetadata
- help(String) - Method in class MetricSnapshot.Builder
- HistogramDataPointSnapshot(int, long, double, NativeHistogramBuckets, NativeHistogramBuckets, double, Labels, Exemplars, long) - Constructor for class HistogramSnapshot.HistogramDataPointSnapshot
-
Constructor for native histograms (as opposed to classic histograms).
- HistogramDataPointSnapshot(ClassicHistogramBuckets, double, Labels, Exemplars, long) - Constructor for class HistogramSnapshot.HistogramDataPointSnapshot
-
Constructor for classic histograms (as opposed to native histograms).
- HistogramDataPointSnapshot(ClassicHistogramBuckets, int, long, double, NativeHistogramBuckets, NativeHistogramBuckets, double, Labels, Exemplars, long) - Constructor for class HistogramSnapshot.HistogramDataPointSnapshot
-
Constructor for a histogram with both, classic and native data.
- HistogramDataPointSnapshot(ClassicHistogramBuckets, int, long, double, NativeHistogramBuckets, NativeHistogramBuckets, double, Labels, Exemplars, long, long) - Constructor for class HistogramSnapshot.HistogramDataPointSnapshot
-
Constructor with an additional scrape timestamp.
- HistogramSnapshot - Class in io.prometheus.metrics.model.snapshots
-
Immutable snapshot of a Histogram.
- HistogramSnapshot(boolean, MetricMetadata, Collection<HistogramSnapshot.HistogramDataPointSnapshot>) - Constructor for class HistogramSnapshot
-
Use this with the first parameter
true
to create a snapshot of a Gauge Histogram. - HistogramSnapshot(MetricMetadata, Collection<HistogramSnapshot.HistogramDataPointSnapshot>) - Constructor for class HistogramSnapshot
-
To create a new
HistogramSnapshot
, you can either call the constructor directly or use the builder withHistogramSnapshot.builder()
. - HistogramSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- HistogramSnapshot.HistogramDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
- HistogramSnapshot.HistogramDataPointSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
I
- InfoDataPointSnapshot(Labels) - Constructor for class InfoSnapshot.InfoDataPointSnapshot
-
To create a new
InfoSnapshot.InfoDataPointSnapshot
, you can either call the constructor directly or use the Builder withInfoSnapshot.InfoDataPointSnapshot.builder()
. - InfoDataPointSnapshot(Labels, long) - Constructor for class InfoSnapshot.InfoDataPointSnapshot
-
Constructor with an additional scrape timestamp.
- InfoSnapshot - Class in io.prometheus.metrics.model.snapshots
-
Immutable snapshot of an Info metric.
- InfoSnapshot(MetricMetadata, Collection<InfoSnapshot.InfoDataPointSnapshot>) - Constructor for class InfoSnapshot
-
To create a new
InfoSnapshot
, you can either call the constructor directly or use the builder withInfoSnapshot.builder()
. - InfoSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- InfoSnapshot.InfoDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
- InfoSnapshot.InfoDataPointSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- io.prometheus.metrics.model.registry - package io.prometheus.metrics.model.registry
- io.prometheus.metrics.model.snapshots - package io.prometheus.metrics.model.snapshots
- isEmpty() - Method in class ClassicHistogramBuckets
- isEmpty() - Method in class Labels
- isGaugeHistogram() - Method in class HistogramSnapshot
- isTrue() - Method in class StateSetSnapshot.State
- isTrue(int) - Method in class StateSetSnapshot.StateSetDataPointSnapshot
- isValidLabelName(String) - Static method in class PrometheusNaming
- isValidMetricName(String) - Static method in class PrometheusNaming
-
Test if a metric name is valid.
- iterator() - Method in class ClassicHistogramBuckets
- iterator() - Method in class Exemplars
- iterator() - Method in class Labels
- iterator() - Method in class MetricSnapshots
- iterator() - Method in class NativeHistogramBuckets
- iterator() - Method in class Quantiles
- iterator() - Method in class StateSetSnapshot.StateSetDataPointSnapshot
J
K
- kiloBytesToBytes(double) - Static method in class Unit
L
- label(String, String) - Method in class Labels.Builder
-
Add a label.
- Label - Class in io.prometheus.metrics.model.snapshots
-
Utility for iterating over
Labels
. - Label(String, String) - Constructor for class Label
- labels(Labels) - Method in class DataPointSnapshot.Builder
- labels(Labels) - Method in class Exemplar.Builder
- Labels - Class in io.prometheus.metrics.model.snapshots
-
Immutable set of name/value pairs, sorted by name.
- Labels.Builder - Class in io.prometheus.metrics.model.snapshots
M
- merge(Labels) - Method in class Labels
-
Create a new Labels instance containing the labels of this and the labels of other.
- merge(String[], String[]) - Method in class Labels
-
Create a new Labels instance containing the labels of this and the labels passed as names and values.
- METERS - Static variable in class Unit
- MetricMetadata - Class in io.prometheus.metrics.model.snapshots
-
Immutable container for metric metadata: name, help, unit.
- MetricMetadata(String) - Constructor for class MetricMetadata
- MetricMetadata(String, String) - Constructor for class MetricMetadata
- MetricMetadata(String, String, Unit) - Constructor for class MetricMetadata
-
Constructor.
- MetricNameFilter - Class in io.prometheus.metrics.model.registry
-
Filter samples (i.e.
- MetricNameFilter.Builder - Class in io.prometheus.metrics.model.registry
- metricSnapshot(MetricSnapshot) - Method in class MetricSnapshots.Builder
-
Add a metric snapshot.
- MetricSnapshot - Class in io.prometheus.metrics.model.snapshots
-
Base class for metric snapshots.
- MetricSnapshot.Builder<T extends MetricSnapshot.Builder<T>> - Class in io.prometheus.metrics.model.snapshots
- MetricSnapshots - Class in io.prometheus.metrics.model.snapshots
-
Immutable list of metric snapshots.
- MetricSnapshots(MetricSnapshot...) - Constructor for class MetricSnapshots
- MetricSnapshots(Collection<MetricSnapshot>) - Constructor for class MetricSnapshots
-
To create MetricSnapshots, you can either call the constructor directly or use
MetricSnapshots.builder()
. - MetricSnapshots.Builder - Class in io.prometheus.metrics.model.snapshots
- millisToSeconds(long) - Static method in class Unit
- MultiCollector - Interface in io.prometheus.metrics.model.registry
-
Like
Collector
, but collecting multiple Snapshots at once.
N
- name(String) - Method in class MetricSnapshot.Builder
-
The name is required.
- nameMustBeEqualTo(String...) - Method in class MetricNameFilter.Builder
- nameMustBeEqualTo(Collection<String>) - Method in class MetricNameFilter.Builder
-
Only samples with one of the
names
will be included. - nameMustNotBeEqualTo(String...) - Method in class MetricNameFilter.Builder
- nameMustNotBeEqualTo(Collection<String>) - Method in class MetricNameFilter.Builder
-
All samples that are not in
names
will be excluded. - nameMustNotStartWith(String...) - Method in class MetricNameFilter.Builder
- nameMustNotStartWith(Collection<String>) - Method in class MetricNameFilter.Builder
-
Samples with names starting with one of the
prefixes
will be excluded. - nameMustStartWith(String...) - Method in class MetricNameFilter.Builder
- nameMustStartWith(Collection<String>) - Method in class MetricNameFilter.Builder
-
Only samples whose name starts with one of the
prefixes
will be included. - nanosToSeconds(long) - Static method in class Unit
- nativeBucketsForNegativeValues(NativeHistogramBuckets) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- nativeBucketsForPositiveValues(NativeHistogramBuckets) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- NativeHistogramBucket - Class in io.prometheus.metrics.model.snapshots
-
For iterating over
NativeHistogramBuckets
. - NativeHistogramBucket(int, long) - Constructor for class NativeHistogramBucket
- NativeHistogramBuckets - Class in io.prometheus.metrics.model.snapshots
-
Immutable representation of native histogram buckets.
- NativeHistogramBuckets.Builder - Class in io.prometheus.metrics.model.snapshots
- nativeSchema(int) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- nativeZeroCount(long) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- nativeZeroThreshold(double) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
O
- of(double[], long[]) - Static method in class ClassicHistogramBuckets
-
To create new
ClassicHistogramBuckets
, you can either use one of the staticof(...)
methods, or useClassicHistogramBuckets.builder()
. - of(double[], Number[]) - Static method in class ClassicHistogramBuckets
-
To create new
ClassicHistogramBuckets
, you can either use one of the staticof(...)
methods, or useClassicHistogramBuckets.builder()
. - of(int[], long[]) - Static method in class NativeHistogramBuckets
-
To create a new
NativeHistogramBuckets
instance, you can either use one of the staticof(...)
methods, or useNativeHistogramBuckets.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 staticof(...)
methods, or useClassicHistogramBuckets.builder()
. - of(List<Integer>, List<Long>) - Static method in class NativeHistogramBuckets
-
To create a new
NativeHistogramBuckets
instance, you can either use one of the staticof(...)
methods, or useNativeHistogramBuckets.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
Q
- quantile(double, double) - Method in class Quantiles.Builder
-
Add a quantile.
- quantile(Quantile) - Method in class Quantiles.Builder
-
Add a quantile.
- Quantile - Class in io.prometheus.metrics.model.snapshots
-
Immutable representation of a Quantile.
- Quantile(double, double) - Constructor for class Quantile
- quantiles(Quantiles) - Method in class SummarySnapshot.SummaryDataPointSnapshot.Builder
- Quantiles - Class in io.prometheus.metrics.model.snapshots
-
Immutable list of quantiles.
- Quantiles.Builder - Class in io.prometheus.metrics.model.snapshots
R
- RATIO - Static variable in class Unit
- register(Collector) - Method in class PrometheusRegistry
- register(MultiCollector) - Method in class PrometheusRegistry
S
- sanitizeLabelName(String) - Static method in class PrometheusNaming
-
Convert an arbitrary string to a name where
isValidLabelName(name)
is true. - sanitizeMetricName(String) - Static method in class PrometheusNaming
-
Convert an arbitrary string to a name where
isValidMetricName(name)
is true. - scrape() - Method in class PrometheusRegistry
- scrape(Predicate<String>) - Method in class PrometheusRegistry
- scrapeTimestampMillis(long) - Method in class DataPointSnapshot.Builder
-
In most cases you should not set a scrape timestamp, because the scrape timestamp is set by the Prometheus server during scraping.
- SECONDS - Static variable in class Unit
- secondsToMillis(double) - Static method in class Unit
- size() - Method in class ClassicHistogramBuckets
- size() - Method in class Exemplars
- size() - Method in class Labels
- size() - Method in class MetricSnapshots
- size() - Method in class NativeHistogramBuckets
- size() - Method in class Quantiles
- size() - Method in class StateSetSnapshot.StateSetDataPointSnapshot
- SPAN_ID - Static variable in class Exemplar
-
Label name for span id.
- spanId(String) - Method in class Exemplar.Builder
- state(String, boolean) - Method in class StateSetSnapshot.StateSetDataPointSnapshot.Builder
-
Add a state.
- StateSetDataPointSnapshot(String[], boolean[], Labels) - Constructor for class StateSetSnapshot.StateSetDataPointSnapshot
-
To create a new
StateSetSnapshot.StateSetDataPointSnapshot
, you can either call the constructor directly or use the Builder withStateSetSnapshot.StateSetDataPointSnapshot.builder()
. - StateSetDataPointSnapshot(String[], boolean[], Labels, long) - Constructor for class StateSetSnapshot.StateSetDataPointSnapshot
-
Constructor with an additional scrape timestamp.
- StateSetSnapshot - Class in io.prometheus.metrics.model.snapshots
-
Immutable snapshot of a StateSet metric.
- StateSetSnapshot(MetricMetadata, Collection<StateSetSnapshot.StateSetDataPointSnapshot>) - Constructor for class StateSetSnapshot
-
To create a new
StateSetSnapshot
, you can either call the constructor directly or use the builder withStateSetSnapshot.builder()
. - StateSetSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- StateSetSnapshot.State - Class in io.prometheus.metrics.model.snapshots
- StateSetSnapshot.StateSetDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
- StateSetSnapshot.StateSetDataPointSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- stream() - Method in class ClassicHistogramBuckets
- stream() - Method in class Labels
- stream() - Method in class MetricSnapshots
- stream() - Method in class NativeHistogramBuckets
- stream() - Method in class StateSetSnapshot.StateSetDataPointSnapshot
- sum(double) - Method in class HistogramSnapshot.HistogramDataPointSnapshot.Builder
- SummaryDataPointSnapshot(long, double, Quantiles, Labels, Exemplars, long) - Constructor for class SummarySnapshot.SummaryDataPointSnapshot
-
To create a new
SummarySnapshot.SummaryDataPointSnapshot
, you can either call the constructor directly or use the Builder withSummarySnapshot.SummaryDataPointSnapshot.builder()
. - SummaryDataPointSnapshot(long, double, Quantiles, Labels, Exemplars, long, long) - Constructor for class SummarySnapshot.SummaryDataPointSnapshot
-
Constructor with an additional scrape timestamp.
- SummarySnapshot - Class in io.prometheus.metrics.model.snapshots
-
Immutable snapshot of a Summary metric.
- SummarySnapshot(MetricMetadata, Collection<SummarySnapshot.SummaryDataPointSnapshot>) - Constructor for class SummarySnapshot
-
To create a new
SummarySnapshot
, you can either call the constructor directly or use the builder withSummarySnapshot.builder()
. - SummarySnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- SummarySnapshot.SummaryDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
- SummarySnapshot.SummaryDataPointSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
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
- unit(Unit) - Method in class InfoSnapshot.Builder
- unit(Unit) - Method in class MetricSnapshot.Builder
- unit(Unit) - Method in class StateSetSnapshot.Builder
- Unit - Class in io.prometheus.metrics.model.snapshots
-
Some pre-defined units for convenience.
- Unit(String) - Constructor for class Unit
- UnknownDataPointSnapshot(double, Labels, Exemplar) - Constructor for class UnknownSnapshot.UnknownDataPointSnapshot
-
To create a new
UnknownSnapshot.UnknownDataPointSnapshot
, you can either call the constructor directly or use the Builder withUnknownSnapshot.UnknownDataPointSnapshot.builder()
. - UnknownDataPointSnapshot(double, Labels, Exemplar, long) - Constructor for class UnknownSnapshot.UnknownDataPointSnapshot
-
Constructor with an additional scrape timestamp.
- UnknownSnapshot - Class in io.prometheus.metrics.model.snapshots
-
Immutable snapshot of an Unknown (Untyped) metric.
- UnknownSnapshot(MetricMetadata, Collection<UnknownSnapshot.UnknownDataPointSnapshot>) - Constructor for class UnknownSnapshot
-
To create a new
UnknownSnapshot
, you can either call the constructor directly or use the builder withUnknownSnapshot.builder()
. - UnknownSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- UnknownSnapshot.UnknownDataPointSnapshot - Class in io.prometheus.metrics.model.snapshots
- UnknownSnapshot.UnknownDataPointSnapshot.Builder - Class in io.prometheus.metrics.model.snapshots
- unregister(Collector) - Method in class PrometheusRegistry
- unregister(MultiCollector) - Method in class PrometheusRegistry
V
- value(double) - Method in class CounterSnapshot.CounterDataPointSnapshot.Builder
-
Counter value.
- value(double) - Method in class Exemplar.Builder
- value(double) - Method in class GaugeSnapshot.GaugeDataPointSnapshot.Builder
-
Gauge value.
- value(double) - Method in class UnknownSnapshot.UnknownDataPointSnapshot.Builder
-
required.
- VOLTS - Static variable in class Unit
All Classes and Interfaces|All Packages|Constant Field Values