Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addLabelValues(String...) - Method in class io.prometheus.metrics.core.metrics.Info
-
Create an info data point with the given label values.
- awaitInitialization() - Static method in class io.prometheus.metrics.core.util.Scheduler
-
For unit test.
B
- build() - Method in class io.prometheus.metrics.core.metrics.Counter.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.CounterWithCallback.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.Gauge.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.GaugeWithCallback.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.Info.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.Metric.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.StateSet.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
- build() - Method in class io.prometheus.metrics.core.metrics.SummaryWithCallback.Builder
- builder() - Static method in class io.prometheus.metrics.core.metrics.Counter
- builder() - Static method in class io.prometheus.metrics.core.metrics.CounterWithCallback
- builder() - Static method in class io.prometheus.metrics.core.metrics.Gauge
- builder() - Static method in class io.prometheus.metrics.core.metrics.GaugeWithCallback
- builder() - Static method in class io.prometheus.metrics.core.metrics.Histogram
- builder() - Static method in class io.prometheus.metrics.core.metrics.Info
- builder() - Static method in class io.prometheus.metrics.core.metrics.StateSet
- builder() - Static method in class io.prometheus.metrics.core.metrics.Summary
- builder() - Static method in class io.prometheus.metrics.core.metrics.SummaryWithCallback
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.Counter
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.CounterWithCallback
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.Gauge
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.GaugeWithCallback
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.Histogram
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.Info
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.StateSet
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.Summary
- builder(PrometheusProperties) - Static method in class io.prometheus.metrics.core.metrics.SummaryWithCallback
- Builder(List<String>, PrometheusProperties) - Constructor for class io.prometheus.metrics.core.metrics.Metric.Builder
- Builder(List<String>, PrometheusProperties) - Constructor for class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
C
- call(double, String...) - Method in interface io.prometheus.metrics.core.metrics.CounterWithCallback.Callback
- call(double, String...) - Method in interface io.prometheus.metrics.core.metrics.GaugeWithCallback.Callback
- call(long, double, Quantiles, String...) - Method in interface io.prometheus.metrics.core.metrics.SummaryWithCallback.Callback
- callback(Consumer<CounterWithCallback.Callback>) - Method in class io.prometheus.metrics.core.metrics.CounterWithCallback.Builder
- callback(Consumer<GaugeWithCallback.Callback>) - Method in class io.prometheus.metrics.core.metrics.GaugeWithCallback.Builder
- callback(Consumer<SummaryWithCallback.Callback>) - Method in class io.prometheus.metrics.core.metrics.SummaryWithCallback.Builder
- classicExponentialUpperBounds(double, double, int) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Create classic histogram buckets with exponential boundaries.
- classicLinearUpperBounds(double, double, int) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Create classic histogram buckets with linear bucket boundaries.
- classicOnly() - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Use the classic histogram representation only, i.e. don't maintain native histogram buckets.
- classicUpperBounds(double...) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Set the upper bounds for the classic histogram buckets.
- clear() - Method in class io.prometheus.metrics.core.metrics.Gauge
-
Reset the metric (remove all data points).
- close() - Method in class io.prometheus.metrics.core.datapoints.Timer
-
Same as
Timer.observeDuration()
. - collect() - Method in class io.prometheus.metrics.core.exemplars.ExemplarSampler
- collect() - Method in class io.prometheus.metrics.core.metrics.Counter
- collect() - Method in class io.prometheus.metrics.core.metrics.CounterWithCallback
- collect() - Method in class io.prometheus.metrics.core.metrics.Gauge
- collect() - Method in class io.prometheus.metrics.core.metrics.GaugeWithCallback
- collect() - Method in class io.prometheus.metrics.core.metrics.Histogram
- collect() - Method in class io.prometheus.metrics.core.metrics.Info
- collect() - Method in class io.prometheus.metrics.core.metrics.Metric
- collect() - Method in class io.prometheus.metrics.core.metrics.StateSet
- collect() - Method in class io.prometheus.metrics.core.metrics.Summary
- collect() - Method in class io.prometheus.metrics.core.metrics.SummaryWithCallback
- collect(List<Labels>, List<Counter.DataPoint>) - Method in class io.prometheus.metrics.core.metrics.Counter
- collect(List<Labels>, List<Gauge.DataPoint>) - Method in class io.prometheus.metrics.core.metrics.Gauge
- collect(List<Labels>, List<Histogram.DataPoint>) - Method in class io.prometheus.metrics.core.metrics.Histogram
- collect(List<Labels>, List<StateSet.DataPoint>) - Method in class io.prometheus.metrics.core.metrics.StateSet
- collect(List<Labels>, List<Summary.DataPoint>) - Method in class io.prometheus.metrics.core.metrics.Summary
- constLabels - Variable in class io.prometheus.metrics.core.metrics.Metric.Builder
- constLabels - Variable in class io.prometheus.metrics.core.metrics.Metric
- constLabels(Labels) - Method in class io.prometheus.metrics.core.metrics.Metric.Builder
- constLabels(Labels) - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
- Counter - Class in io.prometheus.metrics.core.metrics
-
Counter metric.
- Counter.Builder - Class in io.prometheus.metrics.core.metrics
- CounterDataPoint - Interface in io.prometheus.metrics.core.datapoints
-
Represents a single counter data point, i.e. a single line for a counter metric in Prometheus text format.
- CounterWithCallback - Class in io.prometheus.metrics.core.metrics
-
Example:
- CounterWithCallback.Builder - Class in io.prometheus.metrics.core.metrics
- CounterWithCallback.Callback - Interface in io.prometheus.metrics.core.metrics
- current() - Method in class io.prometheus.metrics.core.metrics.SlidingWindow
-
Get the currently active instance of
T
.
D
- DataPoint - Interface in io.prometheus.metrics.core.datapoints
- dec() - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Subtract one.
- dec(double) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Subtract
amount
. - decWithExemplar(double, Labels) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Subtract
amount
, and create a custom exemplar with the given labels. - decWithExemplar(Labels) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Subtract one, and create a custom exemplar with the given labels.
- DEFAULT_CLASSIC_UPPER_BOUNDS - Static variable in class io.prometheus.metrics.core.metrics.Histogram.Builder
- DEFAULT_MAX_AGE_SECONDS - Static variable in class io.prometheus.metrics.core.metrics.Summary.Builder
-
5 minutes.
- DEFAULT_MAX_RETENTION_PERIOD_SECONDS - Static variable in class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
See
ExemplarsProperties.getMaxRetentionPeriodSeconds()
- DEFAULT_MIN_RETENTION_PERIOD_SECONDS - Static variable in class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
See
ExemplarsProperties.getMinRetentionPeriodSeconds()
- DEFAULT_NUMBER_OF_AGE_BUCKETS - Static variable in class io.prometheus.metrics.core.metrics.Summary.Builder
-
5.
- DistributionDataPoint - Interface in io.prometheus.metrics.core.datapoints
-
Represents a single data point of a histogram or a summary metric.
E
- ExemplarSampler - Class in io.prometheus.metrics.core.exemplars
-
The ExemplarSampler selects Spans as exemplars.
- ExemplarSampler(ExemplarSamplerConfig) - Constructor for class io.prometheus.metrics.core.exemplars.ExemplarSampler
- ExemplarSampler(ExemplarSamplerConfig, SpanContext) - Constructor for class io.prometheus.metrics.core.exemplars.ExemplarSampler
-
Constructor with an additional {code spanContext} argument.
- ExemplarSamplerConfig - Class in io.prometheus.metrics.core.exemplars
- ExemplarSamplerConfig(ExemplarsProperties, double[]) - Constructor for class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
Constructor for classic histogram metrics.
- ExemplarSamplerConfig(ExemplarsProperties, int) - Constructor for class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
Constructor for all metric types except classic histograms.
- exemplarsEnabled - Variable in class io.prometheus.metrics.core.metrics.Gauge.Builder
G
- Gauge - Class in io.prometheus.metrics.core.metrics
-
Gauge metric.
- Gauge.Builder - Class in io.prometheus.metrics.core.metrics
- GaugeDataPoint - Interface in io.prometheus.metrics.core.datapoints
-
Represents a single gauge data point, i.e. a single line for a gauge metric in Prometheus text format.
- GaugeWithCallback - Class in io.prometheus.metrics.core.metrics
-
Example:
- GaugeWithCallback.Builder - Class in io.prometheus.metrics.core.metrics
- GaugeWithCallback.Callback - Interface in io.prometheus.metrics.core.metrics
- get() - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Get the current value.
- get() - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Get the current value.
- get() - Method in class io.prometheus.metrics.core.metrics.Counter
- get() - Method in class io.prometheus.metrics.core.metrics.Gauge
- getConfigProperty(MetricsProperties[], Function<MetricsProperties, P>) - Method in class io.prometheus.metrics.core.metrics.Gauge
- getDefaultProperties() - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Default properties for histogram metrics.
- getDefaultProperties() - Method in class io.prometheus.metrics.core.metrics.Gauge.Builder
-
Override if there are more properties than just exemplars enabled.
- getDefaultProperties() - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
-
Default properties for summary metrics.
- getHistogramClassicUpperBounds() - Method in class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
May be
null
. - getLongValue() - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Get the current value as a
long
. - getLongValue() - Method in class io.prometheus.metrics.core.metrics.Counter
- getMaxRetentionPeriodMillis() - Method in class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
See
ExemplarsProperties.getMaxRetentionPeriodSeconds()
- getMetadata() - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata
- getMetricProperties(StatefulMetric.Builder<?, ?>, PrometheusProperties) - Method in class io.prometheus.metrics.core.metrics.Gauge
- getMinRetentionPeriodMillis() - Method in class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
See
ExemplarsProperties.getMinRetentionPeriodSeconds()
- getNoLabels() - Method in class io.prometheus.metrics.core.metrics.Gauge
- getNumberOfExemplars() - Method in class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
Defaults: Counters have one Exemplar, native histograms and summaries have 4 Exemplars, classic histograms have one Exemplar per bucket.
- getPrometheusName() - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata
- getSampleIntervalMillis() - Method in class io.prometheus.metrics.core.exemplars.ExemplarSamplerConfig
-
See
ExemplarsProperties.getSampleIntervalMilliseconds()
H
- help(String) - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
- Histogram - Class in io.prometheus.metrics.core.metrics
-
Histogram metric.
- Histogram.Builder - Class in io.prometheus.metrics.core.metrics
- Histogram.DataPoint - Class in io.prometheus.metrics.core.metrics
I
- illegalLabelNames - Variable in class io.prometheus.metrics.core.metrics.Metric.Builder
- inc() - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Add one.
- inc() - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Add one.
- inc(double) - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Add
amount
. - inc(double) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Add
amount
. - inc(double) - Method in class io.prometheus.metrics.core.metrics.Counter
- inc(double) - Method in class io.prometheus.metrics.core.metrics.Gauge
- inc(long) - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Add
amount
. - inc(long) - Method in class io.prometheus.metrics.core.metrics.Counter
- incWithExemplar(double, Labels) - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Add
amount
, and create a custom exemplar with the given labels. - incWithExemplar(double, Labels) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Add
amount
, and create a custom exemplar with the given labels. - incWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.metrics.Counter
- incWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.metrics.Gauge
- incWithExemplar(long, Labels) - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Add
amount
, and create a custom exemplar with the given labels. - incWithExemplar(long, Labels) - Method in class io.prometheus.metrics.core.metrics.Counter
- incWithExemplar(Labels) - Method in interface io.prometheus.metrics.core.datapoints.CounterDataPoint
-
Add one, and create a custom exemplar with the given labels.
- incWithExemplar(Labels) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Add one, and create a custom exemplar with the given labels.
- Info - Class in io.prometheus.metrics.core.metrics
-
Info metric.
- Info.Builder - Class in io.prometheus.metrics.core.metrics
- initLabelValues(String...) - Method in class io.prometheus.metrics.core.metrics.Gauge
-
Initialize label values.
- io.prometheus.metrics.core - module io.prometheus.metrics.core
- io.prometheus.metrics.core.datapoints - package io.prometheus.metrics.core.datapoints
- io.prometheus.metrics.core.exemplars - package io.prometheus.metrics.core.exemplars
- io.prometheus.metrics.core.metrics - package io.prometheus.metrics.core.metrics
- io.prometheus.metrics.core.util - package io.prometheus.metrics.core.util
- isExemplarsEnabled() - Method in class io.prometheus.metrics.core.metrics.Counter
- isExemplarsEnabled() - Method in class io.prometheus.metrics.core.metrics.Gauge
- isExemplarsEnabled() - Method in class io.prometheus.metrics.core.metrics.Histogram
- isExemplarsEnabled() - Method in class io.prometheus.metrics.core.metrics.StateSet
- isExemplarsEnabled() - Method in class io.prometheus.metrics.core.metrics.Summary
L
- labelNames - Variable in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata
- labelNames(String...) - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
- labelValues(String...) - Method in class io.prometheus.metrics.core.metrics.Gauge
M
- makeLabels(String...) - Method in class io.prometheus.metrics.core.metrics.SummaryWithCallback
- maxAgeSeconds(long) - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
-
The quantiles are relative to a moving time window.
- Metric - Class in io.prometheus.metrics.core.metrics
-
Common base class for all metrics.
- Metric(Metric.Builder<?, ?>) - Constructor for class io.prometheus.metrics.core.metrics.Metric
- Metric.Builder<B extends Metric.Builder<B,
M>, M extends Metric> - Class in io.prometheus.metrics.core.metrics - MetricWithFixedMetadata - Class in io.prometheus.metrics.core.metrics
-
Almost all metrics have fixed metadata, i.e. the metric name is known when the metric is created.
- MetricWithFixedMetadata(MetricWithFixedMetadata.Builder<?, ?>) - Constructor for class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata
- MetricWithFixedMetadata.Builder<B extends MetricWithFixedMetadata.Builder<B,
M>, M extends MetricWithFixedMetadata> - Class in io.prometheus.metrics.core.metrics
N
- name - Variable in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
- name(String) - Method in class io.prometheus.metrics.core.metrics.Counter.Builder
-
The
_total
suffix will automatically be appended if it's missing. - name(String) - Method in class io.prometheus.metrics.core.metrics.CounterWithCallback.Builder
-
The
_total
suffix will automatically be appended if it's missing. - name(String) - Method in class io.prometheus.metrics.core.metrics.Info.Builder
-
The
_info
suffix will automatically be appended if it's missing. - name(String) - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
- nativeInitialSchema(int) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
The schema is a number in [-4, 8] defining the resolution of the native histogram.
- nativeMaxNumberOfBuckets(int) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Limit the number of native buckets.
- nativeMaxZeroThreshold(double) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Native histogram buckets get smaller and smaller the closer they get to zero.
- nativeMinZeroThreshold(double) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Native histogram buckets get smaller and smaller the closer they get to zero.
- nativeOnly() - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
Use the native histogram representation only, i.e. don't maintain classic histogram buckets.
- nativeResetDuration(long, TimeUnit) - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
-
If the histogram needed to be scaled down because
Histogram.Builder.nativeMaxNumberOfBuckets(int)
was exceeded, reset the histogram after a certain time interval to go back to the originalHistogram.Builder.nativeInitialSchema(int)
. - newDataPoint() - Method in class io.prometheus.metrics.core.metrics.Counter
- newDataPoint() - Method in class io.prometheus.metrics.core.metrics.Gauge
- newDataPoint() - Method in class io.prometheus.metrics.core.metrics.Histogram
- newDataPoint() - Method in class io.prometheus.metrics.core.metrics.StateSet
- newDataPoint() - Method in class io.prometheus.metrics.core.metrics.Summary
- numberOfAgeBuckets(int) - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
-
The quantiles are relative to a moving time window.
O
- observe(double) - Method in interface io.prometheus.metrics.core.datapoints.DistributionDataPoint
-
Observe
value
. - observe(double) - Method in class io.prometheus.metrics.core.exemplars.ExemplarSampler
- observe(double) - Method in class io.prometheus.metrics.core.metrics.Histogram.DataPoint
- observe(double) - Method in class io.prometheus.metrics.core.metrics.Histogram
- observe(double) - Method in class io.prometheus.metrics.core.metrics.SlidingWindow
-
Observe a value.
- observe(double) - Method in class io.prometheus.metrics.core.metrics.Summary.DataPoint
- observe(double) - Method in class io.prometheus.metrics.core.metrics.Summary
- observeDuration() - Method in class io.prometheus.metrics.core.datapoints.Timer
-
Records the observed duration in seconds since this
Timer
instance was created. - observeWithExemplar(double, Labels) - Method in interface io.prometheus.metrics.core.datapoints.DistributionDataPoint
-
Observe
value
, and create a custom exemplar with the given labels. - observeWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.exemplars.ExemplarSampler
- observeWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.metrics.Histogram.DataPoint
- observeWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.metrics.Histogram
- observeWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.metrics.Summary.DataPoint
- observeWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.metrics.Summary
P
- properties - Variable in class io.prometheus.metrics.core.metrics.Metric.Builder
Q
- quantile(double) - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
-
Add a quantile.
- quantile(double, double) - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
-
Add a quantile.
R
- register() - Method in class io.prometheus.metrics.core.metrics.Metric.Builder
- register(PrometheusRegistry) - Method in class io.prometheus.metrics.core.metrics.Metric.Builder
- remove(String...) - Method in class io.prometheus.metrics.core.metrics.Info
-
Remove the data point with the specified label values.
- remove(String...) - Method in class io.prometheus.metrics.core.metrics.Gauge
-
Remove the data point with the given label values.
- reset() - Method in class io.prometheus.metrics.core.exemplars.ExemplarSampler
S
- schedule(Runnable, long, TimeUnit) - Static method in class io.prometheus.metrics.core.util.Scheduler
- Scheduler - Class in io.prometheus.metrics.core.util
-
Used for scheduling maintenance tasks like purging outdated Exemplars or resetting native histograms.
- Scheduler() - Constructor for class io.prometheus.metrics.core.util.Scheduler
- self() - Method in class io.prometheus.metrics.core.metrics.Counter.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.CounterWithCallback.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.Gauge.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.GaugeWithCallback.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.Info.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.Metric.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.StateSet.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
- self() - Method in class io.prometheus.metrics.core.metrics.SummaryWithCallback.Builder
- set(double) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Set the gauge to
value
. - set(double) - Method in class io.prometheus.metrics.core.metrics.Gauge
- setFalse(Enum<?>) - Method in interface io.prometheus.metrics.core.datapoints.StateSetDataPoint
-
state
must be one of the states from when theStateSet
was created withStateSet.Builder.states(Class)
. - setFalse(String) - Method in interface io.prometheus.metrics.core.datapoints.StateSetDataPoint
-
state
must be one of the states from when theStateSet
was created withStateSet.Builder.states(String...)
. - setFalse(String) - Method in class io.prometheus.metrics.core.metrics.StateSet
- setLabelValues(String...) - Method in class io.prometheus.metrics.core.metrics.Info
-
Set the info label values.
- setTrue(Enum<?>) - Method in interface io.prometheus.metrics.core.datapoints.StateSetDataPoint
-
state
must be one of the states from when theStateSet
was created withStateSet.Builder.states(Class)
. - setTrue(String) - Method in interface io.prometheus.metrics.core.datapoints.StateSetDataPoint
-
state
must be one of the states from when theStateSet
was created withStateSet.Builder.states(String...)
. - setTrue(String) - Method in class io.prometheus.metrics.core.metrics.StateSet
- setWithExemplar(double, Labels) - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
-
Set the gauge to
value
, and create a custom exemplar with the given labels. - setWithExemplar(double, Labels) - Method in class io.prometheus.metrics.core.metrics.Gauge
- SlidingWindow<T> - Class in io.prometheus.metrics.core.metrics
-
Maintains a ring buffer of T to implement a sliding time window.
- SlidingWindow(Class<T>, Supplier<T>, ObjDoubleConsumer<T>, long, int) - Constructor for class io.prometheus.metrics.core.metrics.SlidingWindow
-
Example: If the
maxAgeSeconds
is 60 andageBuckets
is 3, then 3 instances ofT
are maintained and the sliding window moves to the next instance of T every 20 seconds. - startTimer() - Method in interface io.prometheus.metrics.core.datapoints.DistributionDataPoint
- startTimer() - Method in interface io.prometheus.metrics.core.datapoints.GaugeDataPoint
- startTimer() - Method in interface io.prometheus.metrics.core.datapoints.TimerApi
-
Start a
Timer
. - states(Class<? extends Enum<?>>) - Method in class io.prometheus.metrics.core.metrics.StateSet.Builder
-
Declare the states that should be represented by this StateSet.
- states(String...) - Method in class io.prometheus.metrics.core.metrics.StateSet.Builder
-
Declare the states that should be represented by this StateSet.
- StateSet - Class in io.prometheus.metrics.core.metrics
-
StateSet metric.
- StateSet.Builder - Class in io.prometheus.metrics.core.metrics
- StateSetDataPoint - Interface in io.prometheus.metrics.core.datapoints
-
Represents a single StateSet data point.
- Summary - Class in io.prometheus.metrics.core.metrics
-
Summary metric.
- Summary.Builder - Class in io.prometheus.metrics.core.metrics
- Summary.DataPoint - Class in io.prometheus.metrics.core.metrics
- SummaryWithCallback - Class in io.prometheus.metrics.core.metrics
-
Example:
- SummaryWithCallback.Builder - Class in io.prometheus.metrics.core.metrics
- SummaryWithCallback.Callback - Interface in io.prometheus.metrics.core.metrics
T
- time(Runnable) - Method in interface io.prometheus.metrics.core.datapoints.TimerApi
-
Observe the duration of the
func
call. - time(Supplier<T>) - Method in interface io.prometheus.metrics.core.datapoints.TimerApi
-
Like
TimerApi.time(Runnable)
, but returns the return value offunc
. - timeChecked(Callable<T>) - Method in interface io.prometheus.metrics.core.datapoints.TimerApi
- Timer - Class in io.prometheus.metrics.core.datapoints
-
Helper class for observing durations.
- TimerApi - Interface in io.prometheus.metrics.core.datapoints
-
Convenience API for timing durations.
- toProperties() - Method in class io.prometheus.metrics.core.metrics.Histogram.Builder
- toProperties() - Method in class io.prometheus.metrics.core.metrics.Gauge.Builder
-
Override if there are more properties than just exemplars enabled.
- toProperties() - Method in class io.prometheus.metrics.core.metrics.Summary.Builder
U
- unit(Unit) - Method in class io.prometheus.metrics.core.metrics.Info.Builder
-
Throws an
UnsupportedOperationException
because Info metrics cannot have a unit. - unit(Unit) - Method in class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder
W
- withExemplars() - Method in class io.prometheus.metrics.core.metrics.Gauge.Builder
-
Allow Exemplars for this metric.
- withoutExemplars() - Method in class io.prometheus.metrics.core.metrics.Gauge.Builder
-
Turn off Exemplars for this metric.
All Classes and Interfaces|All Packages|Constant Field Values