Index (Prometheus Metrics Core 1.3.1 API)

A B C D E G H I L M N O Q R S T U W
All Classes and Interfaces|All Packages|Constant Field Values

A

addLabelValues(String...) - Method in class Info: Create an info data point with the given label values.
awaitInitialization() - Static method in class Scheduler: For unit test.

B

build() - Method in class Counter.Builder
build() - Method in class CounterWithCallback.Builder
build() - Method in class Gauge.Builder
build() - Method in class GaugeWithCallback.Builder
build() - Method in class Histogram.Builder
build() - Method in class Info.Builder
build() - Method in class MetricWithFixedMetadata.Builder
build() - Method in class StateSet.Builder
build() - Method in class Summary.Builder
build() - Method in class SummaryWithCallback.Builder
builder() - Static method in class Counter
builder() - Static method in class CounterWithCallback
builder() - Static method in class Gauge
builder() - Static method in class GaugeWithCallback
builder() - Static method in class Histogram
builder() - Static method in class Info
builder() - Static method in class StateSet
builder() - Static method in class Summary
builder() - Static method in class SummaryWithCallback
builder(PrometheusProperties) - Static method in class Counter
builder(PrometheusProperties) - Static method in class CounterWithCallback
builder(PrometheusProperties) - Static method in class Gauge
builder(PrometheusProperties) - Static method in class GaugeWithCallback
builder(PrometheusProperties) - Static method in class Histogram
builder(PrometheusProperties) - Static method in class Info
builder(PrometheusProperties) - Static method in class StateSet
builder(PrometheusProperties) - Static method in class Summary
builder(PrometheusProperties) - Static method in class SummaryWithCallback

C

call(double, String...) - Method in interface CounterWithCallback.Callback
call(double, String...) - Method in interface GaugeWithCallback.Callback
call(long, double, Quantiles, String...) - Method in interface SummaryWithCallback.Callback
callback(Consumer<CounterWithCallback.Callback>) - Method in class CounterWithCallback.Builder
callback(Consumer<GaugeWithCallback.Callback>) - Method in class GaugeWithCallback.Builder
callback(Consumer<SummaryWithCallback.Callback>) - Method in class SummaryWithCallback.Builder
classicExponentialUpperBounds(double, double, int) - Method in class Histogram.Builder: Create classic histogram bucxkets with exponential boundaries.
classicLinearUpperBounds(double, double, int) - Method in class Histogram.Builder: Create classic histogram buckets with linear bucket boundaries.
classicOnly() - Method in class Histogram.Builder: Use the classic histogram representation only, i.e.
classicUpperBounds(double...) - Method in class Histogram.Builder: Set the upper bounds for the classic histogram buckets.
clear() - Method in class Counter: Reset the metric (remove all data points).
clear() - Method in class Gauge: Reset the metric (remove all data points).
clear() - Method in class Histogram: Reset the metric (remove all data points).
clear() - Method in class StateSet: Reset the metric (remove all data points).
clear() - Method in class Summary: Reset the metric (remove all data points).
close() - Method in class Timer: Same as Timer.observeDuration().
collect() - Method in class ExemplarSampler
collect() - Method in class Counter
collect() - Method in class CounterWithCallback
collect() - Method in class Gauge
collect() - Method in class GaugeWithCallback
collect() - Method in class Histogram
collect() - Method in class Info
collect() - Method in class Metric
collect() - Method in class StateSet
collect() - Method in class Summary
collect() - Method in class SummaryWithCallback
constLabels(Labels) - Method in class 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.
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 SlidingWindow: Get the currently active instance of T.

D

DataPoint - Interface in io.prometheus.metrics.core.datapoints
dec() - Method in interface GaugeDataPoint: Subtract one.
dec(double) - Method in interface GaugeDataPoint: Subtract amount.
decWithExemplar(double, Labels) - Method in interface GaugeDataPoint: Subtract amount, and create a custom exemplar with the given labels.
decWithExemplar(Labels) - Method in interface GaugeDataPoint: Subtract one, and create a custom exemplar with the given labels.
DEFAULT_CLASSIC_UPPER_BOUNDS - Static variable in class Histogram.Builder
DEFAULT_MAX_AGE_SECONDS - Static variable in class Summary.Builder: 5 minutes.
DEFAULT_MAX_RETENTION_PERIOD_SECONDS - Static variable in class ExemplarSamplerConfig: See ExemplarsProperties.getMaxRetentionPeriodSeconds()
DEFAULT_MIN_RETENTION_PERIOD_SECONDS - Static variable in class ExemplarSamplerConfig: See ExemplarsProperties.getMinRetentionPeriodSeconds()
DEFAULT_NUMBER_OF_AGE_BUCKETS - Static variable in class 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 ExemplarSampler
ExemplarSampler(ExemplarSamplerConfig, SpanContext) - Constructor for class ExemplarSampler: Constructor with an additional {code spanContext} argument.
ExemplarSamplerConfig - Class in io.prometheus.metrics.core.exemplars
ExemplarSamplerConfig(ExemplarsProperties, double[]) - Constructor for class ExemplarSamplerConfig: Constructor for classic histogram metrics.
ExemplarSamplerConfig(ExemplarsProperties, int) - Constructor for class ExemplarSamplerConfig: Constructor for all metric types except classic histograms.

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.
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 CounterDataPoint: Get the current value.
get() - Method in interface GaugeDataPoint: Get the current value.
get() - Method in class Counter: Get the current value.
get() - Method in class Gauge: Get the current value.
getDefaultProperties() - Method in class Histogram.Builder: Default properties for histogram metrics.
getDefaultProperties() - Method in class Counter.Builder: Override if there are more properties than just exemplars enabled.
getDefaultProperties() - Method in class Gauge.Builder: Override if there are more properties than just exemplars enabled.
getDefaultProperties() - Method in class StateSet.Builder: Override if there are more properties than just exemplars enabled.
getDefaultProperties() - Method in class Summary.Builder: Default properties for summary metrics.
getHistogramClassicUpperBounds() - Method in class ExemplarSamplerConfig: May be null.
getLongValue() - Method in interface CounterDataPoint: Get the current value as a long.
getLongValue() - Method in class Counter: Get the current value as a long.
getMaxRetentionPeriodMillis() - Method in class ExemplarSamplerConfig: See ExemplarsProperties.getMaxRetentionPeriodSeconds()
getMinRetentionPeriodMillis() - Method in class ExemplarSamplerConfig: See ExemplarsProperties.getMinRetentionPeriodSeconds()
getNumberOfExemplars() - Method in class ExemplarSamplerConfig: Defaults: Counters have one Exemplar, native histograms and summaries have 4 Exemplars, classic histograms have one Exemplar per bucket.
getPrometheusName() - Method in class MetricWithFixedMetadata
getSampleIntervalMillis() - Method in class ExemplarSamplerConfig: See ExemplarsProperties.getSampleIntervalMilliseconds()

H

help(String) - Method in class 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

inc() - Method in interface CounterDataPoint: Add one.
inc() - Method in interface GaugeDataPoint: Add one.
inc(double) - Method in interface CounterDataPoint: Add amount.
inc(double) - Method in interface GaugeDataPoint: Add amount.
inc(double) - Method in class Counter: Add amount.
inc(double) - Method in class Gauge: Add amount.
inc(long) - Method in interface CounterDataPoint: Add amount.
inc(long) - Method in class Counter: Add amount.
incWithExemplar(double, Labels) - Method in interface CounterDataPoint: Add amount, and create a custom exemplar with the given labels.
incWithExemplar(double, Labels) - Method in interface GaugeDataPoint: Add amount, and create a custom exemplar with the given labels.
incWithExemplar(double, Labels) - Method in class Counter: Add amount, and create a custom exemplar with the given labels.
incWithExemplar(double, Labels) - Method in class Gauge: Add amount, and create a custom exemplar with the given labels.
incWithExemplar(long, Labels) - Method in interface CounterDataPoint: Add amount, and create a custom exemplar with the given labels.
incWithExemplar(long, Labels) - Method in class Counter: Add amount, and create a custom exemplar with the given labels.
incWithExemplar(Labels) - Method in interface CounterDataPoint: Add one, and create a custom exemplar with the given labels.
incWithExemplar(Labels) - Method in interface 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 Counter: Initialize label values.
initLabelValues(String...) - Method in class Gauge: Initialize label values.
initLabelValues(String...) - Method in class Histogram: Initialize label values.
initLabelValues(String...) - Method in class StateSet: Initialize label values.
initLabelValues(String...) - Method in class Summary: 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

L

labelNames(String...) - Method in class MetricWithFixedMetadata.Builder
labelValues(String...) - Method in class Counter
labelValues(String...) - Method in class Gauge
labelValues(String...) - Method in class Histogram
labelValues(String...) - Method in class StateSet
labelValues(String...) - Method in class Summary

M

maxAgeSeconds(long) - Method in class 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.
MetricWithFixedMetadata - Class in io.prometheus.metrics.core.metrics: Almost all metrics have fixed metadata, i.e.
MetricWithFixedMetadata.Builder<B,M> - Class in io.prometheus.metrics.core.metrics

N

name(String) - Method in class Counter.Builder: The _total suffix will automatically be appended if it's missing.
name(String) - Method in class CounterWithCallback.Builder: The _total suffix will automatically be appended if it's missing.
name(String) - Method in class Info.Builder: The _info suffix will automatically be appended if it's missing.
name(String) - Method in class MetricWithFixedMetadata.Builder
nativeInitialSchema(int) - Method in class Histogram.Builder: The schema is a number in [-4, 8] defining the resolution of the native histogram.
nativeMaxNumberOfBuckets(int) - Method in class Histogram.Builder: Limit the number of native buckets.
nativeMaxZeroThreshold(double) - Method in class Histogram.Builder: Native histogram buckets get smaller and smaller the closer they get to zero.
nativeMinZeroThreshold(double) - Method in class Histogram.Builder: Native histogram buckets get smaller and smaller the closer they get to zero.
nativeOnly() - Method in class Histogram.Builder: Use the native histogram representation only, i.e.
nativeResetDuration(long, TimeUnit) - Method in class 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 original Histogram.Builder.nativeInitialSchema(int).
numberOfAgeBuckets(int) - Method in class Summary.Builder: The quantiles are relative to a moving time window.

O

observe(double) - Method in interface DistributionDataPoint: Observe value.
observe(double) - Method in class ExemplarSampler
observe(double) - Method in class Histogram.DataPoint: Observe value.
observe(double) - Method in class Histogram: Observe value.
observe(double) - Method in class SlidingWindow: Observe a value.
observe(double) - Method in class Summary.DataPoint: Observe value.
observe(double) - Method in class Summary: Observe value.
observeDuration() - Method in class Timer: Records the observed duration in seconds since this Timer instance was created.
observeWithExemplar(double, Labels) - Method in interface DistributionDataPoint: Observe value, and create a custom exemplar with the given labels.
observeWithExemplar(double, Labels) - Method in class ExemplarSampler
observeWithExemplar(double, Labels) - Method in class Histogram.DataPoint: Observe value, and create a custom exemplar with the given labels.
observeWithExemplar(double, Labels) - Method in class Histogram: Observe value, and create a custom exemplar with the given labels.
observeWithExemplar(double, Labels) - Method in class Summary.DataPoint: Observe value, and create a custom exemplar with the given labels.
observeWithExemplar(double, Labels) - Method in class Summary: Observe value, and create a custom exemplar with the given labels.

Q

quantile(double) - Method in class Summary.Builder: Add a quantile.
quantile(double, double) - Method in class Summary.Builder: Add a quantile.

R

remove(String...) - Method in class Info: Remove the data point with the specified label values.
remove(String...) - Method in class Counter: Remove the data point with the given label values.
remove(String...) - Method in class Gauge: Remove the data point with the given label values.
remove(String...) - Method in class Histogram: Remove the data point with the given label values.
remove(String...) - Method in class StateSet: Remove the data point with the given label values.
remove(String...) - Method in class Summary: Remove the data point with the given label values.
reset() - Method in class ExemplarSampler

S

schedule(Runnable, long, TimeUnit) - Static method in class 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 Scheduler
set(double) - Method in interface GaugeDataPoint: Set the gauge to value.
set(double) - Method in class Gauge: Set the gauge to value.
setFalse(Enum<?>) - Method in interface StateSetDataPoint: state must be one of the states from when the StateSet was created with StateSet.Builder.states(Class).
setFalse(String) - Method in interface StateSetDataPoint: state must be one of the states from when the StateSet was created with StateSet.Builder.states(String...).
setFalse(String) - Method in class StateSet: state must be one of the states from when the StateSet was created with StateSet.Builder.states(String...).
setLabelValues(String...) - Method in class Info: Set the info label values.
setTrue(Enum<?>) - Method in interface StateSetDataPoint: state must be one of the states from when the StateSet was created with StateSet.Builder.states(Class).
setTrue(String) - Method in interface StateSetDataPoint: state must be one of the states from when the StateSet was created with StateSet.Builder.states(String...).
setTrue(String) - Method in class StateSet: state must be one of the states from when the StateSet was created with StateSet.Builder.states(String...).
setWithExemplar(double, Labels) - Method in interface GaugeDataPoint: Set the gauge to value, and create a custom exemplar with the given labels.
setWithExemplar(double, Labels) - Method in class Gauge: Set the gauge to value, and create a custom exemplar with the given labels.
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 SlidingWindow: Example: If the maxAgeSeconds is 60 and ageBuckets is 3, then 3 instances of T are maintained and the sliding window moves to the next instance of T every 20 seconds.
startTimer() - Method in interface DistributionDataPoint: Start a Timer.
startTimer() - Method in interface GaugeDataPoint: Start a Timer.
startTimer() - Method in interface TimerApi: Start a Timer.
states(Class<? extends Enum<?>>) - Method in class StateSet.Builder: Declare the states that should be represented by this StateSet.
states(String...) - Method in class 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 TimerApi: Observe the duration of the func call.
time(Supplier<T>) - Method in interface TimerApi: Like TimerApi.time(Runnable), but returns the return value of func.
timeChecked(Callable<T>) - Method in interface TimerApi: Like TimerApi.time(Supplier), but func may throw a checked Exception.
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.

U

unit(Unit) - Method in class Info.Builder: Throws an UnsupportedOperationException because Info metrics cannot have a unit.
unit(Unit) - Method in class MetricWithFixedMetadata.Builder

W

withExemplars() - Method in class Counter.Builder: Allow Exemplars for this metric.
withExemplars() - Method in class Gauge.Builder: Allow Exemplars for this metric.
withExemplars() - Method in class Histogram.Builder: Allow Exemplars for this metric.
withExemplars() - Method in class StateSet.Builder: Allow Exemplars for this metric.
withExemplars() - Method in class Summary.Builder: Allow Exemplars for this metric.
withoutExemplars() - Method in class Counter.Builder: Turn off Exemplars for this metric.
withoutExemplars() - Method in class Gauge.Builder: Turn off Exemplars for this metric.
withoutExemplars() - Method in class Histogram.Builder: Turn off Exemplars for this metric.
withoutExemplars() - Method in class StateSet.Builder: Turn off Exemplars for this metric.
withoutExemplars() - Method in class Summary.Builder: Turn off Exemplars for this metric.

A B C D E G H I L M N O Q R S T U W
All Classes and Interfaces|All Packages|Constant Field Values