Index (Prometheus Java Suite 0.15.0 API)

A B C D E F G H I J L M N O P Q R S T U V W
All Classes All Packages

A

activateOptions() - Method in class io.prometheus.client.log4j.InstrumentedAppender
Adapter - Class in io.prometheus.client
Adapter - Class in io.prometheus.client.servlet.jakarta
Adapter() - Constructor for class io.prometheus.client.Adapter
Adapter() - Constructor for class io.prometheus.client.servlet.jakarta.Adapter
add(double) - Method in class io.prometheus.client.DoubleAdder: Adds the given value.
add(QueuedThreadPool, String) - Method in class io.prometheus.client.jetty.QueuedThreadPoolStatisticsCollector
add(SessionFactory, String) - Method in class io.prometheus.client.hibernate.HibernateStatisticsCollector: Registers a Hibernate SessionFactory with this collector.
addCache(String, AsyncCache) - Method in class io.prometheus.client.cache.caffeine.CacheMetricsCollector: Add or replace the cache with the given name.
addCache(String, Cache) - Method in class io.prometheus.client.cache.caffeine.CacheMetricsCollector: Add or replace the cache with the given name.
addCache(String, Cache) - Method in class io.prometheus.client.guava.cache.CacheMetricsCollector: Add or replace the cache with the given name.
addMetric(List<String>, double) - Method in class io.prometheus.client.CounterMetricFamily
addMetric(List<String>, double) - Method in class io.prometheus.client.GaugeMetricFamily
addMetric(List<String>, double, double) - Method in class io.prometheus.client.SummaryMetricFamily
addMetric(List<String>, double, double, List<Double>) - Method in class io.prometheus.client.SummaryMetricFamily
ageBuckets(int) - Method in class io.prometheus.client.Summary.Builder: The class JavaDoc for Summary has more information on Summary.Builder.ageBuckets(int)
ALLOW_ALL - Static variable in class io.prometheus.client.SampleNameFilter: For convenience, a filter that allows all names.
and(Predicate<? super String>) - Method in class io.prometheus.client.SampleNameFilter: Replacement for Java 8's Predicate.and() for compatibility with Java versions < 8.
annotatedMethod() - Method in class io.prometheus.client.spring.web.MethodTimer
append(ILoggingEvent) - Method in class io.prometheus.client.logback.InstrumentedAppender
append(LoggingEvent) - Method in class io.prometheus.client.log4j.InstrumentedAppender
append(LogEvent) - Method in class io.prometheus.client.log4j2.InstrumentedAppender

B

Base64 - Class in io.prometheus.client.exporter: This class delegates to either javax.xml.bind.DatatypeConverter (for Java < 8) or java.util.Base64 (Java 8+) to perform Base64 encoding of a String.
BasicAuthHttpConnectionFactory - Class in io.prometheus.client.exporter
BasicAuthHttpConnectionFactory(HttpConnectionFactory, String, String) - Constructor for class io.prometheus.client.exporter.BasicAuthHttpConnectionFactory
BasicAuthHttpConnectionFactory(String, String) - Constructor for class io.prometheus.client.exporter.BasicAuthHttpConnectionFactory
buckets - Variable in class io.prometheus.client.Histogram.Child.Value
buckets(double...) - Method in class io.prometheus.client.Histogram.Builder: Set the upper bounds of buckets for the histogram.
BufferPoolsExports - Class in io.prometheus.client.hotspot: Exports metrics about JVM buffers.
BufferPoolsExports() - Constructor for class io.prometheus.client.hotspot.BufferPoolsExports
build() - Static method in class io.prometheus.client.Counter: Return a Builder to allow configuration of a new Counter.
build() - Static method in class io.prometheus.client.Enumeration: Return a Builder to allow configuration of a new Enumeration.
build() - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Build the HTTPServer
build() - Static method in class io.prometheus.client.Gauge: Return a Builder to allow configuration of a new Gauge.
build() - Static method in class io.prometheus.client.Histogram: Return a Builder to allow configuration of a new Histogram.
build() - Static method in class io.prometheus.client.Info: Return a Builder to allow configuration of a new Info.
build() - Method in class io.prometheus.client.SampleNameFilter.Builder
build() - Static method in class io.prometheus.client.Summary: Return a Builder to allow configuration of a new Summary.
build(String, String) - Static method in class io.prometheus.client.Counter: Return a Builder to allow configuration of a new Counter.
build(String, String) - Static method in class io.prometheus.client.Enumeration: Return a Builder to allow configuration of a new Enumeration.
build(String, String) - Static method in class io.prometheus.client.Gauge: Return a Builder to allow configuration of a new Gauge.
build(String, String) - Static method in class io.prometheus.client.Histogram: Return a Builder to allow configuration of a new Histogram.
build(String, String) - Static method in class io.prometheus.client.Info: Return a Builder to allow configuration of a new Info.
build(String, String) - Static method in class io.prometheus.client.Summary: Return a Builder to allow configuration of a new Summary.
Builder() - Constructor for class io.prometheus.client.Counter.Builder
Builder() - Constructor for class io.prometheus.client.Enumeration.Builder
Builder() - Constructor for class io.prometheus.client.exporter.HTTPServer.Builder
Builder() - Constructor for class io.prometheus.client.Gauge.Builder
Builder() - Constructor for class io.prometheus.client.Histogram.Builder
Builder() - Constructor for class io.prometheus.client.Info.Builder
Builder() - Constructor for class io.prometheus.client.SampleNameFilter.Builder
Builder() - Constructor for class io.prometheus.client.SimpleCollector.Builder
Builder() - Constructor for class io.prometheus.client.Summary.Builder

C

CacheMetricsCollector - Class in io.prometheus.client.cache.caffeine: Collect metrics from Caffeine's com.github.benmanes.caffeine.cache.Cache.
CacheMetricsCollector - Class in io.prometheus.client.guava.cache: Collect metrics from Guava's com.google.common.cache.Cache.
CacheMetricsCollector() - Constructor for class io.prometheus.client.cache.caffeine.CacheMetricsCollector
CacheMetricsCollector() - Constructor for class io.prometheus.client.guava.cache.CacheMetricsCollector
checkMetricLabelName(String) - Static method in class io.prometheus.client.Collector: Throw an exception if the metric label name is invalid.
checkMetricName(String) - Static method in class io.prometheus.client.Collector: Throw an exception if the metric name is invalid.
Child() - Constructor for class io.prometheus.client.Counter.Child
Child() - Constructor for class io.prometheus.client.Gauge.Child
Child(Boolean, CounterExemplarSampler) - Constructor for class io.prometheus.client.Counter.Child
children - Variable in class io.prometheus.client.cache.caffeine.CacheMetricsCollector
children - Variable in class io.prometheus.client.guava.cache.CacheMetricsCollector
children - Variable in class io.prometheus.client.SimpleCollector
chooseContentType(String) - Static method in class io.prometheus.client.exporter.common.TextFormat: Return the content type that should be used for a given Accept HTTP header.
ClassLoadingExports - Class in io.prometheus.client.hotspot: Exports metrics about JVM classloading.
ClassLoadingExports() - Constructor for class io.prometheus.client.hotspot.ClassLoadingExports
ClassLoadingExports(ClassLoadingMXBean) - Constructor for class io.prometheus.client.hotspot.ClassLoadingExports
clear() - Method in class io.prometheus.client.cache.caffeine.CacheMetricsCollector: Remove all caches.
clear() - Method in class io.prometheus.client.CollectorRegistry: Unregister all Collectors.
clear() - Method in class io.prometheus.client.guava.cache.CacheMetricsCollector: Remove all caches.
clear() - Method in class io.prometheus.client.SimpleCollector: Remove all children.
close() - Method in class io.prometheus.client.exporter.HTTPServer: Stop the HTTPServer.
close() - Method in class io.prometheus.client.Gauge.Timer: Equivalent to calling Gauge.Timer.setDuration().
close() - Method in class io.prometheus.client.Histogram.Timer: Equivalent to calling Histogram.Timer.observeDuration().
close() - Method in class io.prometheus.client.log4j.InstrumentedAppender
close() - Method in class io.prometheus.client.Summary.Timer: Equivalent to calling Summary.Timer.observeDuration().
collect() - Method in class io.prometheus.client.cache.caffeine.CacheMetricsCollector
collect() - Method in class io.prometheus.client.Collector: Return all metrics of this Collector.
collect() - Method in class io.prometheus.client.Counter
collect() - Method in class io.prometheus.client.dropwizard.DropwizardExports
collect() - Method in class io.prometheus.client.Enumeration
collect() - Method in class io.prometheus.client.Gauge
collect() - Method in class io.prometheus.client.guava.cache.CacheMetricsCollector
collect() - Method in class io.prometheus.client.hibernate.HibernateStatisticsCollector
collect() - Method in class io.prometheus.client.Histogram
collect() - Method in class io.prometheus.client.hotspot.BufferPoolsExports
collect() - Method in class io.prometheus.client.hotspot.ClassLoadingExports
collect() - Method in class io.prometheus.client.hotspot.GarbageCollectorExports
collect() - Method in class io.prometheus.client.hotspot.MemoryAllocationExports
collect() - Method in class io.prometheus.client.hotspot.MemoryPoolsExports
collect() - Method in class io.prometheus.client.hotspot.StandardExports
collect() - Method in class io.prometheus.client.hotspot.ThreadExports
collect() - Method in class io.prometheus.client.hotspot.VersionInfoExports
collect() - Method in class io.prometheus.client.Info
collect() - Method in class io.prometheus.client.jetty.JettyStatisticsCollector
collect() - Method in class io.prometheus.client.jetty.QueuedThreadPoolStatisticsCollector
collect() - Method in class io.prometheus.client.spring.boot.SpringBootMetricsCollector
collect() - Method in class io.prometheus.client.Summary
collect(Predicate<String>) - Method in class io.prometheus.client.Collector: Like Collector.collect(), but the result should only contain MetricFamilySamples where sampleNameFilter.test(name) is true for at least one Sample name.
collect(Predicate<String>) - Method in class io.prometheus.client.hotspot.BufferPoolsExports
collect(Predicate<String>) - Method in class io.prometheus.client.hotspot.ClassLoadingExports
collect(Predicate<String>) - Method in class io.prometheus.client.hotspot.GarbageCollectorExports
collect(Predicate<String>) - Method in class io.prometheus.client.hotspot.MemoryPoolsExports
collect(Predicate<String>) - Method in class io.prometheus.client.hotspot.ThreadExports
Collector - Class in io.prometheus.client: A collector for a set of metrics.
Collector() - Constructor for class io.prometheus.client.Collector
Collector.Describable - Interface in io.prometheus.client
Collector.MetricFamilySamples - Class in io.prometheus.client: A metric, and all of its samples.
Collector.MetricFamilySamples.Sample - Class in io.prometheus.client: A single Sample, with a unique name and set of labels.
Collector.Type - Enum in io.prometheus.client
CollectorRegistry - Class in io.prometheus.client: A registry of Collectors.
CollectorRegistry() - Constructor for class io.prometheus.client.CollectorRegistry
CollectorRegistry(boolean) - Constructor for class io.prometheus.client.CollectorRegistry
CONTENT_TYPE_004 - Static variable in class io.prometheus.client.exporter.common.TextFormat: Content-type for Prometheus text version 0.0.4.
CONTENT_TYPE_OPENMETRICS_100 - Static variable in class io.prometheus.client.exporter.common.TextFormat: Content-type for Openmetrics text version 1.0.0.
count - Variable in class io.prometheus.client.Summary.Child.Value
Counter - Class in io.prometheus.client: Counter metric, to track counts of events or running totals.
COUNTER - io.prometheus.client.Collector.Type
COUNTER_NAME - Static variable in class io.prometheus.client.log4j.InstrumentedAppender
COUNTER_NAME - Static variable in class io.prometheus.client.log4j2.InstrumentedAppender
COUNTER_NAME - Static variable in class io.prometheus.client.logback.InstrumentedAppender
Counter.Builder - Class in io.prometheus.client
Counter.Child - Class in io.prometheus.client: The value of a single Counter.
CounterExemplarSampler - Interface in io.prometheus.client.exemplars: Exemplar sampler for counter metrics.
CounterMetricFamily - Class in io.prometheus.client: Counter metric family, for custom collectors and exporters.
CounterMetricFamily(String, String, double) - Constructor for class io.prometheus.client.CounterMetricFamily
CounterMetricFamily(String, String, List<String>) - Constructor for class io.prometheus.client.CounterMetricFamily
create() - Method in class io.prometheus.client.Counter.Builder
create() - Method in class io.prometheus.client.Enumeration.Builder
create() - Method in class io.prometheus.client.Gauge.Builder
create() - Method in class io.prometheus.client.Histogram.Builder
create() - Method in class io.prometheus.client.Info.Builder
create() - Method in class io.prometheus.client.SimpleCollector.Builder: Return the constructed collector.
create() - Method in class io.prometheus.client.Summary.Builder
create(String) - Method in class io.prometheus.client.exporter.BasicAuthHttpConnectionFactory
create(String) - Method in class io.prometheus.client.exporter.DefaultHttpConnectionFactory
create(String) - Method in interface io.prometheus.client.exporter.HttpConnectionFactory
createAppender(String) - Static method in class io.prometheus.client.log4j2.InstrumentedAppender
created - Variable in class io.prometheus.client.Histogram.Child.Value
created - Variable in class io.prometheus.client.Summary.Child.Value
created() - Method in class io.prometheus.client.Counter.Child: Get the created time of the counter in milliseconds.
createSample(String, String, List<String>, List<String>, double) - Method in class io.prometheus.client.dropwizard.samplebuilder.CustomMappingSampleBuilder
createSample(String, String, List<String>, List<String>, double) - Method in class io.prometheus.client.dropwizard.samplebuilder.DefaultSampleBuilder
createSample(String, String, List<String>, List<String>, double) - Method in interface io.prometheus.client.dropwizard.samplebuilder.SampleBuilder: Creates a new Collector.MetricFamilySamples.Sample for the given parameters.
CustomMappingSampleBuilder - Class in io.prometheus.client.dropwizard.samplebuilder: Custom SampleBuilder implementation to allow Dropwizard metrics to be translated to Prometheus metrics including custom labels and names.
CustomMappingSampleBuilder(List<MapperConfig>) - Constructor for class io.prometheus.client.dropwizard.samplebuilder.CustomMappingSampleBuilder

D

dec() - Method in class io.prometheus.client.Gauge.Child: Decrement the gauge by 1.
dec() - Method in class io.prometheus.client.Gauge: Decrement the gauge with no labels by 1.
dec(double) - Method in class io.prometheus.client.Gauge.Child: Decrement the gauge by the given amount.
dec(double) - Method in class io.prometheus.client.Gauge: Decrement the gauge with no labels by the given amount.
DefaultExemplarSampler - Class in io.prometheus.client.exemplars: Default Exemplar sampler.
DefaultExemplarSampler(SpanContextSupplier) - Constructor for class io.prometheus.client.exemplars.DefaultExemplarSampler
DefaultExports - Class in io.prometheus.client.hotspot: Registers the default Hotspot collectors.
DefaultExports() - Constructor for class io.prometheus.client.hotspot.DefaultExports
DefaultHttpConnectionFactory - Class in io.prometheus.client.exporter
DefaultHttpConnectionFactory() - Constructor for class io.prometheus.client.exporter.DefaultHttpConnectionFactory
defaultRegistry - Static variable in class io.prometheus.client.CollectorRegistry: The default registry.
DefaultSampleBuilder - Class in io.prometheus.client.dropwizard.samplebuilder: Default implementation of SampleBuilder.
DefaultSampleBuilder() - Constructor for class io.prometheus.client.dropwizard.samplebuilder.DefaultSampleBuilder
delete(String) - Method in class io.prometheus.client.exporter.PushGateway: Deletes metrics from the Pushgateway.
delete(String, Map<String, String>) - Method in class io.prometheus.client.exporter.PushGateway: Deletes metrics from the Pushgateway.
describe() - Method in interface io.prometheus.client.Collector.Describable: Provide a list of metric families this Collector is expected to return.
describe() - Method in class io.prometheus.client.Counter
describe() - Method in class io.prometheus.client.dropwizard.DropwizardExports
describe() - Method in class io.prometheus.client.Enumeration
describe() - Method in class io.prometheus.client.Gauge
describe() - Method in class io.prometheus.client.Histogram
describe() - Method in class io.prometheus.client.Info
describe() - Method in class io.prometheus.client.spring.boot.SpringBootMetricsCollector
describe() - Method in class io.prometheus.client.Summary
destroy() - Method in class io.prometheus.client.filter.MetricsFilter
destroy() - Method in class io.prometheus.client.servlet.jakarta.filter.MetricsFilter
disableExemplars() - Static method in class io.prometheus.client.exemplars.ExemplarConfig: Prevent metrics from loading exemplars from an ExemplarSampler by default.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class io.prometheus.client.servlet.jakarta.filter.MetricsFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class io.prometheus.client.filter.MetricsFilter
doGet(HttpServletRequestAdapter, HttpServletResponseAdapter) - Method in class io.prometheus.client.servlet.common.exporter.Exporter
doGet(HttpServletRequest, HttpServletResponse) - Method in class io.prometheus.client.servlet.jakarta.exporter.MetricsServlet
doGet(HttpServletRequest, HttpServletResponse) - Method in class io.prometheus.client.exporter.MetricsServlet
doPost(HttpServletRequestAdapter, HttpServletResponseAdapter) - Method in class io.prometheus.client.servlet.common.exporter.Exporter
doPost(HttpServletRequest, HttpServletResponse) - Method in class io.prometheus.client.servlet.jakarta.exporter.MetricsServlet
doPost(HttpServletRequest, HttpServletResponse) - Method in class io.prometheus.client.exporter.MetricsServlet
DoubleAdder - Class in io.prometheus.client: One or more variables that together maintain an initially zero double sum.
DoubleAdder() - Constructor for class io.prometheus.client.DoubleAdder: Creates a new adder with initial sum of zero.
doubleToGoString(double) - Static method in class io.prometheus.client.Collector: Convert a double to its string representation in Go.
doubleValue() - Method in class io.prometheus.client.DoubleAdder: Equivalent to DoubleAdder.sum().
DropwizardExports - Class in io.prometheus.client.dropwizard: Collect Dropwizard metrics from a MetricRegistry.
DropwizardExports(MetricRegistry) - Constructor for class io.prometheus.client.dropwizard.DropwizardExports: Creates a new DropwizardExports with a DefaultSampleBuilder and MetricFilter.ALL.
DropwizardExports(MetricRegistry, MetricFilter) - Constructor for class io.prometheus.client.dropwizard.DropwizardExports: Creates a new DropwizardExports with a DefaultSampleBuilder and custom MetricFilter.
DropwizardExports(MetricRegistry, MetricFilter, SampleBuilder) - Constructor for class io.prometheus.client.dropwizard.DropwizardExports
DropwizardExports(MetricRegistry, SampleBuilder) - Constructor for class io.prometheus.client.dropwizard.DropwizardExports

E

elapsedSeconds() - Method in class io.prometheus.client.SimpleTimer
elapsedSecondsFromNanos(long, long) - Static method in class io.prometheus.client.SimpleTimer
enableExemplars() - Static method in class io.prometheus.client.exemplars.ExemplarConfig: Allow metrics to load exemplars from an ExemplarSampler by default.
enablePerQueryMetrics() - Method in class io.prometheus.client.hibernate.HibernateStatisticsCollector: Enables collection of per-query metrics.
EnablePrometheusEndpoint - Annotation Type in io.prometheus.client.spring.boot: Enable an endpoint that exposes Prometheus metrics from its default collector.
EnablePrometheusTiming - Annotation Type in io.prometheus.client.spring.web: Enable the use of PrometheusTimeMethod annotation on classes or methods.
EnableSpringBootMetricsCollector - Annotation Type in io.prometheus.client.spring.boot
encodeToString(byte[]) - Static method in class io.prometheus.client.exporter.Base64: Encodes a byte[] to a String using Base64.
Enumeration - Class in io.prometheus.client: Enumeration metric, to track which of a set of states something is in.
Enumeration.Builder - Class in io.prometheus.client
Enumeration.Child - Class in io.prometheus.client: The value of a single Enumeration.
equals(Object) - Method in class io.prometheus.client.Collector.MetricFamilySamples
equals(Object) - Method in class io.prometheus.client.Collector.MetricFamilySamples.Sample
equals(Object) - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
equals(Object) - Method in class io.prometheus.client.exemplars.Exemplar
executorService - Variable in class io.prometheus.client.exporter.HTTPServer
exemplar - Variable in class io.prometheus.client.Collector.MetricFamilySamples.Sample
Exemplar - Class in io.prometheus.client.exemplars: Immutable data class holding an Exemplar.
Exemplar(double, Long, String...) - Constructor for class io.prometheus.client.exemplars.Exemplar: Create an Exemplar
Exemplar(double, Long, Map<String, String>) - Constructor for class io.prometheus.client.exemplars.Exemplar: Create an Exemplar
Exemplar(double, String...) - Constructor for class io.prometheus.client.exemplars.Exemplar: Create an Exemplar without a timestamp
Exemplar(double, Map<String, String>) - Constructor for class io.prometheus.client.exemplars.Exemplar: Create an Exemplar
ExemplarConfig - Class in io.prometheus.client.exemplars: Static configuration for Exemplar behavior.
ExemplarConfig() - Constructor for class io.prometheus.client.exemplars.ExemplarConfig
exemplars - Variable in class io.prometheus.client.Histogram.Child.Value
ExemplarSampler - Interface in io.prometheus.client.exemplars: For convenience, an interface for implementing both, the CounterExemplarSampler and the HistogramExemplarSampler.
exponentialBuckets(double, double, int) - Method in class io.prometheus.client.Histogram.Builder: Set the upper bounds of buckets for the histogram with an exponential sequence.
Exporter - Class in io.prometheus.client.servlet.common.exporter: The MetricsServlet class exists to provide a simple way of exposing the metrics values.
Exporter(CollectorRegistry, Predicate<String>) - Constructor for class io.prometheus.client.servlet.common.exporter.Exporter: Construct a MetricsServlet for the given registry.

F

familySamplesList(Collector.Type, List<Collector.MetricFamilySamples.Sample>) - Method in class io.prometheus.client.SimpleCollector
filter(Predicate<String>) - Method in class io.prometheus.client.Collector.MetricFamilySamples
Filter - Class in io.prometheus.client.servlet.common.filter: Filter implements the common functionality provided by the two MetricsFilter implementations: javax version: io.prometheus.client.filter.MetricsFilter provided by simpleclient_servlet jakarta version: io.prometheus.client.servlet.jakarta.filter.MetricsFilter provided by simpleclient_servlet_jakarta
Filter() - Constructor for class io.prometheus.client.servlet.common.filter.Filter
Filter(String, String, Integer, double[], boolean) - Constructor for class io.prometheus.client.servlet.common.filter.Filter: If you want to configure the filter programmatically instead of via web.xml, you can pass all configuration parameters to this constructor.
Filter.MetricData - Class in io.prometheus.client.servlet.common.filter
FilterConfigAdapter - Interface in io.prometheus.client.servlet.common.adapter
FilterConfigurationException - Exception in io.prometheus.client.servlet.common.filter: Thrown when there is a misconfiguration in web.xml.
FilterConfigurationException(String) - Constructor for exception io.prometheus.client.servlet.common.filter.FilterConfigurationException
filteredMetricFamilySamples(Predicate<String>) - Method in class io.prometheus.client.CollectorRegistry: Enumeration of metrics where sampleNameFilter.test(name) returns true for each name in Collector.MetricFamilySamples.getNames().
filteredMetricFamilySamples(Set<String>) - Method in class io.prometheus.client.CollectorRegistry: Enumeration of metrics matching the specified names.
floatValue() - Method in class io.prometheus.client.DoubleAdder: Returns the DoubleAdder.sum() as a float after a narrowing primitive conversion.
fullname - Variable in class io.prometheus.client.SimpleCollector

G

GarbageCollectorExports - Class in io.prometheus.client.hotspot: Exports metrics about JVM garbage collectors.
GarbageCollectorExports() - Constructor for class io.prometheus.client.hotspot.GarbageCollectorExports
gatewayBaseURL - Variable in class io.prometheus.client.exporter.PushGateway
Gauge - Class in io.prometheus.client: Gauge metric, to report instantaneous values.
GAUGE - io.prometheus.client.Collector.Type
GAUGE_HISTOGRAM - io.prometheus.client.Collector.Type
Gauge.Builder - Class in io.prometheus.client
Gauge.Child - Class in io.prometheus.client: The value of a single Gauge.
Gauge.Timer - Class in io.prometheus.client: Represents an event being timed.
GaugeMetricFamily - Class in io.prometheus.client: Gauge metric family, for custom collectors and exporters.
GaugeMetricFamily(String, String, double) - Constructor for class io.prometheus.client.GaugeMetricFamily
GaugeMetricFamily(String, String, List<String>) - Constructor for class io.prometheus.client.GaugeMetricFamily
get() - Method in class io.prometheus.client.Counter.Child: Get the value of the counter.
get() - Method in class io.prometheus.client.Counter: Get the value of the counter.
get() - Method in class io.prometheus.client.Enumeration.Child: Get the state.
get() - Method in class io.prometheus.client.Enumeration: Get the value of the Enumeration.
get() - Method in class io.prometheus.client.exporter.SampleNameFilterSupplier
get() - Method in class io.prometheus.client.Gauge.Child: Get the value of the gauge.
get() - Method in class io.prometheus.client.Gauge: Get the value of the gauge.
get() - Method in class io.prometheus.client.Histogram.Child: Get the value of the Histogram.
get() - Method in class io.prometheus.client.Info.Child: Get the info.
get() - Method in class io.prometheus.client.Info: Get the the info.
get() - Method in class io.prometheus.client.Summary.Child: Get the value of the Summary.
get() - Method in class io.prometheus.client.Summary: Get the value of the Summary.
get() - Method in interface io.prometheus.client.Supplier
getContextPath() - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletRequestAdapter
getCounterExemplarSampler() - Static method in class io.prometheus.client.exemplars.ExemplarConfig
getGarbageCollectorMXBeans() - Method in class io.prometheus.client.hotspot.MemoryAllocationExports
getHeader(String) - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletRequestAdapter
getHistogramExemplarSampler() - Static method in class io.prometheus.client.exemplars.ExemplarConfig
getInitParameter(String) - Method in interface io.prometheus.client.servlet.common.adapter.FilterConfigAdapter
getInitParameter(String) - Method in interface io.prometheus.client.servlet.common.adapter.ServletConfigAdapter
getLabelName(int) - Method in class io.prometheus.client.exemplars.Exemplar: Get the label name at index i.
getLabels() - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
getLabelValue(int) - Method in class io.prometheus.client.exemplars.Exemplar: Get the label value at index i.
getMatch() - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
getMethod() - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletRequestAdapter
getName() - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
getNameAndLabels(MapperConfig, Map<String, String>) - Method in class io.prometheus.client.dropwizard.samplebuilder.CustomMappingSampleBuilder
getNames() - Method in class io.prometheus.client.Collector.MetricFamilySamples: List of names that are reserved for Samples in these MetricsFamilySamples.
getNumberOfLabels() - Method in class io.prometheus.client.exemplars.Exemplar
getParameterValues(String) - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletRequestAdapter
getPort() - Method in class io.prometheus.client.exporter.HTTPServer: Gets the port number.
getRequestURI() - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletRequestAdapter
getSampleValue(String) - Method in class io.prometheus.client.CollectorRegistry: Returns the given value, or null if it doesn't exist.
getSampleValue(String, String[], String[]) - Method in class io.prometheus.client.CollectorRegistry: Returns the given value, or null if it doesn't exist.
getSpanId() - Method in interface io.prometheus.client.exemplars.tracer.common.SpanContextSupplier
getSpanId() - Method in class io.prometheus.client.exemplars.tracer.otel_agent.OpenTelemetryAgentSpanContextSupplier
getSpanId() - Method in class io.prometheus.client.exemplars.tracer.otel.OpenTelemetrySpanContextSupplier
getStatus() - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletResponseAdapter
getTimestampMs() - Method in class io.prometheus.client.exemplars.Exemplar
getTraceId() - Method in interface io.prometheus.client.exemplars.tracer.common.SpanContextSupplier
getTraceId() - Method in class io.prometheus.client.exemplars.tracer.otel_agent.OpenTelemetryAgentSpanContextSupplier
getTraceId() - Method in class io.prometheus.client.exemplars.tracer.otel.OpenTelemetrySpanContextSupplier
getValue() - Method in class io.prometheus.client.exemplars.Exemplar
getWriter() - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletResponseAdapter
Graphite - Class in io.prometheus.client.bridge: Export metrics in the Graphite plaintext format.
Graphite(String, int) - Constructor for class io.prometheus.client.bridge.Graphite: Construct a Graphite Bridge with the given host:port.

H

handle(HttpExchange) - Method in class io.prometheus.client.exporter.HTTPServer.HTTPMetricHandler
handle(RoutingContext) - Method in class io.prometheus.client.vertx.MetricsHandler
hashCode() - Method in class io.prometheus.client.Collector.MetricFamilySamples
hashCode() - Method in class io.prometheus.client.Collector.MetricFamilySamples.Sample
hashCode() - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
hashCode() - Method in class io.prometheus.client.exemplars.Exemplar
help - Variable in class io.prometheus.client.Collector.MetricFamilySamples
help - Variable in class io.prometheus.client.SimpleCollector
help() - Method in annotation type io.prometheus.client.spring.web.PrometheusTimeMethod: The help message to show in prometheus metrics
help(String) - Method in class io.prometheus.client.SimpleCollector.Builder: Set the help string of the metric.
HibernateStatisticsCollector - Class in io.prometheus.client.hibernate: Collect metrics from one or more Hibernate SessionFactory instances.
HibernateStatisticsCollector() - Constructor for class io.prometheus.client.hibernate.HibernateStatisticsCollector: Creates an empty collector.
HibernateStatisticsCollector(SessionFactory, String) - Constructor for class io.prometheus.client.hibernate.HibernateStatisticsCollector: Creates a new collector for the given session factory.
Histogram - Class in io.prometheus.client: Histogram metric, to track distributions of events.
HISTOGRAM - io.prometheus.client.Collector.Type
Histogram.Builder - Class in io.prometheus.client
Histogram.Child - Class in io.prometheus.client: The value of a single Histogram.
Histogram.Child.Value - Class in io.prometheus.client
Histogram.Timer - Class in io.prometheus.client: Represents an event being timed.
HistogramExemplarSampler - Interface in io.prometheus.client.exemplars: Exemplar sampler for histogram metrics.
HttpConnectionFactory - Interface in io.prometheus.client.exporter
HTTPMetricHandler(CollectorRegistry) - Constructor for class io.prometheus.client.exporter.HTTPServer.HTTPMetricHandler
HTTPMetricHandler(CollectorRegistry, Supplier<Predicate<String>>) - Constructor for class io.prometheus.client.exporter.HTTPServer.HTTPMetricHandler
HTTPServer - Class in io.prometheus.client.exporter: Expose Prometheus metrics using a plain Java HttpServer.
HTTPServer(int) - Constructor for class io.prometheus.client.exporter.HTTPServer: Start an HTTP server serving the default Prometheus registry using non-daemon threads.
HTTPServer(int, boolean) - Constructor for class io.prometheus.client.exporter.HTTPServer: Start an HTTP server serving the default Prometheus registry.
HTTPServer(HttpServer, CollectorRegistry, boolean) - Constructor for class io.prometheus.client.exporter.HTTPServer: Start an HTTP server serving Prometheus metrics from the given registry using the given HttpServer.
HTTPServer(String, int) - Constructor for class io.prometheus.client.exporter.HTTPServer: Start an HTTP server serving the default Prometheus registry using non-daemon threads.
HTTPServer(String, int, boolean) - Constructor for class io.prometheus.client.exporter.HTTPServer: Start an HTTP server serving the default Prometheus registry.
HTTPServer(InetSocketAddress, CollectorRegistry) - Constructor for class io.prometheus.client.exporter.HTTPServer: Start an HTTP server serving Prometheus metrics from the given registry using non-daemon threads.
HTTPServer(InetSocketAddress, CollectorRegistry, boolean) - Constructor for class io.prometheus.client.exporter.HTTPServer: Start an HTTP server serving Prometheus metrics from the given registry.
HTTPServer.Builder - Class in io.prometheus.client.exporter: We keep the original constructors of HTTPServer for compatibility, but new configuration parameters like sampleNameFilter must be configured using the Builder.
HTTPServer.HTTPMetricHandler - Class in io.prometheus.client.exporter: Handles Metrics collections from the given registry.
HttpServletRequestAdapter - Interface in io.prometheus.client.servlet.common.adapter
HttpServletResponseAdapter - Interface in io.prometheus.client.servlet.common.adapter

I

inc() - Method in class io.prometheus.client.Counter.Child: Increment the counter by 1.
inc() - Method in class io.prometheus.client.Counter: Increment the counter with no labels by 1.
inc() - Method in class io.prometheus.client.Gauge.Child: Increment the gauge by 1.
inc() - Method in class io.prometheus.client.Gauge: Increment the gauge with no labels by 1.
inc(double) - Method in class io.prometheus.client.Counter.Child: Increment the counter by the given amount.
inc(double) - Method in class io.prometheus.client.Counter: Increment the counter with no labels by the given amount.
inc(double) - Method in class io.prometheus.client.Gauge.Child: Increment the gauge by the given amount.
inc(double) - Method in class io.prometheus.client.Gauge: Increment the gauge with no labels by the given amount.
incWithExemplar(double, String...) - Method in class io.prometheus.client.Counter.Child: Like Counter.Child.inc(double), but additionally creates an exemplar.
incWithExemplar(double, String...) - Method in class io.prometheus.client.Counter: Like Counter.Child.incWithExemplar(double, String...), but for the counter without labels.
incWithExemplar(double, Map<String, String>) - Method in class io.prometheus.client.Counter.Child: Same as Counter.Child.incWithExemplar(double, String...), but the exemplar labels are passed as a Map.
incWithExemplar(double, Map<String, String>) - Method in class io.prometheus.client.Counter: Like Counter.Child.incWithExemplar(double, Map), but for the counter without labels.
incWithExemplar(String...) - Method in class io.prometheus.client.Counter.Child: Same as incWithExemplar(1, exemplarLabels).
incWithExemplar(String...) - Method in class io.prometheus.client.Counter: Like Counter.Child.incWithExemplar(String...), but for the counter without labels.
incWithExemplar(Map<String, String>) - Method in class io.prometheus.client.Counter.Child: Same as incWithExemplar(1, exemplarLabels).
incWithExemplar(Map<String, String>) - Method in class io.prometheus.client.Counter: Like Counter.Child.incWithExemplar(Map), but for the counter without labels.
info(String...) - Method in class io.prometheus.client.Info.Child: Set the info.
info(String...) - Method in class io.prometheus.client.Info: Set the info on the info with no labels.
info(Map<String, String>) - Method in class io.prometheus.client.Info.Child: Set the info.
info(Map<String, String>) - Method in class io.prometheus.client.Info: Set the info on the info with no labels.
Info - Class in io.prometheus.client: Info metric, key-value pairs.
INFO - io.prometheus.client.Collector.Type
Info.Builder - Class in io.prometheus.client
Info.Child - Class in io.prometheus.client: The value of a single Info.
init(FilterConfigAdapter) - Method in class io.prometheus.client.servlet.common.filter.Filter: Common implementation of javax.servlet.Filter.init() and jakarta.servlet.Filter.init().
init(ServletConfigAdapter) - Method in class io.prometheus.client.servlet.common.exporter.Exporter
init(FilterConfig) - Method in class io.prometheus.client.servlet.jakarta.filter.MetricsFilter
init(ServletConfig) - Method in class io.prometheus.client.servlet.jakarta.exporter.MetricsServlet
init(FilterConfig) - Method in class io.prometheus.client.filter.MetricsFilter
init(ServletConfig) - Method in class io.prometheus.client.exporter.MetricsServlet
initialize() - Static method in class io.prometheus.client.hotspot.DefaultExports: Register the default Hotspot collectors with the default registry.
initializeNoLabelsChild() - Method in class io.prometheus.client.SimpleCollector: Initialize the child with no labels.
instanceIPGroupingKey() - Static method in class io.prometheus.client.exporter.PushGateway: Returns a grouping key with the instance label set to the machine's IP address.
InstrumentedAppender - Class in io.prometheus.client.log4j
InstrumentedAppender - Class in io.prometheus.client.log4j2: Log4j2 log statements at various log levels
InstrumentedAppender - Class in io.prometheus.client.logback
InstrumentedAppender() - Constructor for class io.prometheus.client.log4j.InstrumentedAppender: Create a new instrumented appender using the default registry.
InstrumentedAppender() - Constructor for class io.prometheus.client.logback.InstrumentedAppender: Create a new instrumented appender using the default registry.
InstrumentedAppender(CollectorRegistry) - Constructor for class io.prometheus.client.logback.InstrumentedAppender: Create a new instrumented appender using the supplied registry.
InstrumentedAppender(String) - Constructor for class io.prometheus.client.log4j2.InstrumentedAppender: Create a new instrumented appender using the default registry.
intValue() - Method in class io.prometheus.client.DoubleAdder: Returns the DoubleAdder.sum() as an int after a narrowing primitive conversion.
io.prometheus.client - package io.prometheus.client
io.prometheus.client.bridge - package io.prometheus.client.bridge
io.prometheus.client.cache.caffeine - package io.prometheus.client.cache.caffeine
io.prometheus.client.dropwizard - package io.prometheus.client.dropwizard
io.prometheus.client.dropwizard.samplebuilder - package io.prometheus.client.dropwizard.samplebuilder
io.prometheus.client.exemplars - package io.prometheus.client.exemplars
io.prometheus.client.exemplars.tracer.common - package io.prometheus.client.exemplars.tracer.common
io.prometheus.client.exemplars.tracer.otel - package io.prometheus.client.exemplars.tracer.otel
io.prometheus.client.exemplars.tracer.otel_agent - package io.prometheus.client.exemplars.tracer.otel_agent
io.prometheus.client.exporter - package io.prometheus.client.exporter
io.prometheus.client.exporter.common - package io.prometheus.client.exporter.common
io.prometheus.client.filter - package io.prometheus.client.filter
io.prometheus.client.guava.cache - package io.prometheus.client.guava.cache
io.prometheus.client.hibernate - package io.prometheus.client.hibernate
io.prometheus.client.hotspot - package io.prometheus.client.hotspot
io.prometheus.client.jetty - package io.prometheus.client.jetty
io.prometheus.client.log4j - package io.prometheus.client.log4j
io.prometheus.client.log4j2 - package io.prometheus.client.log4j2
io.prometheus.client.logback - package io.prometheus.client.logback
io.prometheus.client.servlet.common.adapter - package io.prometheus.client.servlet.common.adapter
io.prometheus.client.servlet.common.exporter - package io.prometheus.client.servlet.common.exporter
io.prometheus.client.servlet.common.filter - package io.prometheus.client.servlet.common.filter
io.prometheus.client.servlet.jakarta - package io.prometheus.client.servlet.jakarta
io.prometheus.client.servlet.jakarta.exporter - package io.prometheus.client.servlet.jakarta.exporter
io.prometheus.client.servlet.jakarta.filter - package io.prometheus.client.servlet.jakarta.filter
io.prometheus.client.spring.boot - package io.prometheus.client.spring.boot
io.prometheus.client.spring.web - package io.prometheus.client.spring.web
io.prometheus.client.vertx - package io.prometheus.client.vertx
isAvailable() - Static method in class io.prometheus.client.exemplars.tracer.otel_agent.OpenTelemetryAgentSpanContextSupplier
isAvailable() - Static method in class io.prometheus.client.exemplars.tracer.otel.OpenTelemetrySpanContextSupplier
isExemplarsEnabled() - Static method in class io.prometheus.client.exemplars.ExemplarConfig

J

JettyStatisticsCollector - Class in io.prometheus.client.jetty: Collect metrics from jetty's org.eclipse.jetty.server.handler.StatisticsHandler.
JettyStatisticsCollector(StatisticsHandler) - Constructor for class io.prometheus.client.jetty.JettyStatisticsCollector

L

labelNames - Variable in class io.prometheus.client.Collector.MetricFamilySamples.Sample
labelNames - Variable in class io.prometheus.client.SimpleCollector
labelNames(String...) - Method in class io.prometheus.client.SimpleCollector.Builder: Set the labelNames of the metric.
labels(String...) - Method in class io.prometheus.client.SimpleCollector: Return the Child with the given labels, creating it if needed.
labelValues - Variable in class io.prometheus.client.Collector.MetricFamilySamples.Sample
linearBuckets(double, double, int) - Method in class io.prometheus.client.Histogram.Builder: Set the upper bounds of buckets for the histogram with a linear sequence.
longValue() - Method in class io.prometheus.client.DoubleAdder: Returns the DoubleAdder.sum() as a long after a narrowing primitive conversion.

M

MapperConfig - Class in io.prometheus.client.dropwizard.samplebuilder: POJO containing info on how to map a graphite metric to a prometheus one.
MapperConfig() - Constructor for class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
MapperConfig(String, String, Map<String, String>) - Constructor for class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
mapToArray(Map<String, String>) - Static method in class io.prometheus.client.exemplars.Exemplar: Convert the map to an array [key1, value1, key2, value2, ...].
maxAgeSeconds(long) - Method in class io.prometheus.client.Summary.Builder: The class JavaDoc for Summary has more information on Summary.Builder.maxAgeSeconds(long)
MemoryAllocationExports - Class in io.prometheus.client.hotspot
MemoryAllocationExports() - Constructor for class io.prometheus.client.hotspot.MemoryAllocationExports
MemoryPoolsExports - Class in io.prometheus.client.hotspot: Exports metrics about JVM memory areas.
MemoryPoolsExports() - Constructor for class io.prometheus.client.hotspot.MemoryPoolsExports
MemoryPoolsExports(MemoryMXBean, List<MemoryPoolMXBean>) - Constructor for class io.prometheus.client.hotspot.MemoryPoolsExports
MethodTimer - Class in io.prometheus.client.spring.web: This class automatically times (via aspectj) the execution of annotated methods, if it's been enabled via EnablePrometheusTiming, for methods annotated with PrometheusTimeMethod
MethodTimer() - Constructor for class io.prometheus.client.spring.web.MethodTimer
metricFamilySamples() - Method in class io.prometheus.client.CollectorRegistry: Enumeration of metrics of all registered collectors.
MetricFamilySamples(String, Collector.Type, String, List<Collector.MetricFamilySamples.Sample>) - Constructor for class io.prometheus.client.Collector.MetricFamilySamples
MetricFamilySamples(String, String, Collector.Type, String, List<Collector.MetricFamilySamples.Sample>) - Constructor for class io.prometheus.client.Collector.MetricFamilySamples
MetricsFilter - Class in io.prometheus.client.filter: The MetricsFilter class provides a high-level filter that enables tunable collection of metrics for Servlet performance.
MetricsFilter - Class in io.prometheus.client.servlet.jakarta.filter: The MetricsFilter class provides a high-level filter that enables tunable collection of metrics for Servlet performance.
MetricsFilter() - Constructor for class io.prometheus.client.filter.MetricsFilter
MetricsFilter() - Constructor for class io.prometheus.client.servlet.jakarta.filter.MetricsFilter
MetricsFilter(String, String, Integer, double[]) - Constructor for class io.prometheus.client.filter.MetricsFilter
MetricsFilter(String, String, Integer, double[], boolean) - Constructor for class io.prometheus.client.filter.MetricsFilter: See Filter(String, String, Integer, double[], boolean).
MetricsFilter(String, String, Integer, double[], boolean) - Constructor for class io.prometheus.client.servlet.jakarta.filter.MetricsFilter: See Filter(String, String, Integer, double[], boolean).
MetricsHandler - Class in io.prometheus.client.vertx: Metrics Handler for Vert.x Web.
MetricsHandler() - Constructor for class io.prometheus.client.vertx.MetricsHandler: Construct a MetricsHandler for the default registry.
MetricsHandler(CollectorRegistry) - Constructor for class io.prometheus.client.vertx.MetricsHandler: Construct a MetricsHandler for the given registry.
MetricsServlet - Class in io.prometheus.client.exporter: The MetricsServlet class provides a simple way of exposing the metrics values.
MetricsServlet - Class in io.prometheus.client.servlet.jakarta.exporter: The MetricsServlet class provides a simple way of exposing the metrics values.
MetricsServlet() - Constructor for class io.prometheus.client.exporter.MetricsServlet
MetricsServlet() - Constructor for class io.prometheus.client.servlet.jakarta.exporter.MetricsServlet
MetricsServlet(CollectorRegistry) - Constructor for class io.prometheus.client.exporter.MetricsServlet
MetricsServlet(CollectorRegistry) - Constructor for class io.prometheus.client.servlet.jakarta.exporter.MetricsServlet
MetricsServlet(CollectorRegistry, Predicate<String>) - Constructor for class io.prometheus.client.exporter.MetricsServlet
MetricsServlet(CollectorRegistry, Predicate<String>) - Constructor for class io.prometheus.client.servlet.jakarta.exporter.MetricsServlet
MetricsServlet(Predicate<String>) - Constructor for class io.prometheus.client.exporter.MetricsServlet
MetricsServlet(Predicate<String>) - Constructor for class io.prometheus.client.servlet.jakarta.exporter.MetricsServlet
MILLISECONDS_PER_SECOND - Static variable in class io.prometheus.client.Collector: Number of milliseconds in a second.

N

name - Variable in class io.prometheus.client.Collector.MetricFamilySamples
name - Variable in class io.prometheus.client.Collector.MetricFamilySamples.Sample
name() - Method in annotation type io.prometheus.client.spring.web.PrometheusTimeMethod: The metric name to use for recording latencies
name(String) - Method in class io.prometheus.client.SimpleCollector.Builder: Set the name of the metric.
NAME_MUST_BE_EQUAL_TO - Static variable in class io.prometheus.client.servlet.common.exporter.Exporter
NAME_MUST_NOT_BE_EQUAL_TO - Static variable in class io.prometheus.client.servlet.common.exporter.Exporter
NAME_MUST_NOT_START_WITH - Static variable in class io.prometheus.client.servlet.common.exporter.Exporter
NAME_MUST_START_WITH - Static variable in class io.prometheus.client.servlet.common.exporter.Exporter
nameMustBeEqualTo(String...) - Method in class io.prometheus.client.SampleNameFilter.Builder
nameMustBeEqualTo(Collection<String>) - Method in class io.prometheus.client.SampleNameFilter.Builder: Only samples with one of the names will be included.
nameMustNotBeEqualTo(String...) - Method in class io.prometheus.client.SampleNameFilter.Builder
nameMustNotBeEqualTo(Collection<String>) - Method in class io.prometheus.client.SampleNameFilter.Builder: All samples that are not in names will be excluded.
nameMustNotStartWith(String...) - Method in class io.prometheus.client.SampleNameFilter.Builder
nameMustNotStartWith(Collection<String>) - Method in class io.prometheus.client.SampleNameFilter.Builder: Samples with names starting with one of the prefixes will be excluded.
nameMustStartWith(String...) - Method in class io.prometheus.client.SampleNameFilter.Builder
nameMustStartWith(Collection<String>) - Method in class io.prometheus.client.SampleNameFilter.Builder: Only samples whose name starts with one of the prefixes will be included.
namespace(String) - Method in class io.prometheus.client.SimpleCollector.Builder: Set the namespace of the metric.
NANOSECONDS_PER_SECOND - Static variable in class io.prometheus.client.Collector: Number of nanoseconds in a second.
newChild() - Method in class io.prometheus.client.Counter
newChild() - Method in class io.prometheus.client.Enumeration
newChild() - Method in class io.prometheus.client.Gauge
newChild() - Method in class io.prometheus.client.Histogram
newChild() - Method in class io.prometheus.client.Info
newChild() - Method in class io.prometheus.client.SimpleCollector: Return a new child, workaround for Java generics limitations.
newChild() - Method in class io.prometheus.client.Summary
noLabelsChild - Variable in class io.prometheus.client.SimpleCollector

O

observe(double) - Method in class io.prometheus.client.Histogram.Child: Observe the given amount.
observe(double) - Method in class io.prometheus.client.Histogram: Observe the given amount on the histogram with no labels.
observe(double) - Method in class io.prometheus.client.Summary.Child: Observe the given amount.
observe(double) - Method in class io.prometheus.client.Summary: Observe the given amount on the summary with no labels.
observeDuration() - Method in class io.prometheus.client.Histogram.Timer: Observe the amount of time in seconds since Histogram.Child.startTimer() was called.
observeDuration() - Method in class io.prometheus.client.Summary.Timer: Observe the amount of time in seconds since Summary.Child.startTimer() was called.
observeDuration(Filter.MetricData, HttpServletResponseAdapter) - Method in class io.prometheus.client.servlet.common.filter.Filter: To be called at the end of javax.servlet.Filter.doFilter() or jakarta.servlet.Filter.doFilter().
observeDurationWithExemplar(String...) - Method in class io.prometheus.client.Histogram.Timer
observeDurationWithExemplar(Map<String, String>) - Method in class io.prometheus.client.Histogram.Timer
observeWithExemplar(double, String...) - Method in class io.prometheus.client.Histogram.Child: Like Histogram.Child.observe(double), but additionally creates an exemplar.
observeWithExemplar(double, String...) - Method in class io.prometheus.client.Histogram: Like Histogram.Child.observeWithExemplar(double, String...), but for the histogram without labels.
observeWithExemplar(double, Map<String, String>) - Method in class io.prometheus.client.Histogram.Child: Like Histogram.Child.observeWithExemplar(double, String...), but the exemplar labels are passed as a Map.
observeWithExemplar(double, Map<String, String>) - Method in class io.prometheus.client.Histogram: Like Histogram.Child.observeWithExemplar(double, Map), but for the histogram without labels.
of(Predicate<String>) - Static method in class io.prometheus.client.exporter.SampleNameFilterSupplier
OpenTelemetryAgentSpanContextSupplier - Class in io.prometheus.client.exemplars.tracer.otel_agent: This is exactly the same as the OpenTelemetrySpanContextSupplier.
OpenTelemetryAgentSpanContextSupplier() - Constructor for class io.prometheus.client.exemplars.tracer.otel_agent.OpenTelemetryAgentSpanContextSupplier
OpenTelemetrySpanContextSupplier - Class in io.prometheus.client.exemplars.tracer.otel
OpenTelemetrySpanContextSupplier() - Constructor for class io.prometheus.client.exemplars.tracer.otel.OpenTelemetrySpanContextSupplier

P

parseQuery(String) - Static method in class io.prometheus.client.exporter.HTTPServer
Predicate<T> - Interface in io.prometheus.client: Replacement for Java 8's java.util.function.Predicate for compatibility with Java versions < 8.
PrometheusMvcEndpoint - Class in io.prometheus.client.spring.boot
PrometheusMvcEndpoint(PrometheusEndpoint) - Constructor for class io.prometheus.client.spring.boot.PrometheusMvcEndpoint
PrometheusTimeMethod - Annotation Type in io.prometheus.client.spring.web: Enable Spring-AOP-based automated method timing for the annotated method.
push(CollectorRegistry) - Method in class io.prometheus.client.bridge.Graphite: Push samples from the given registry to Graphite.
push(CollectorRegistry, String) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a registry, replacing all those with the same job and no grouping key.
push(CollectorRegistry, String, Map<String, String>) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a registry, replacing all those with the same job and grouping key.
push(Collector, String) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a Collector, replacing all those with the same job and no grouping key.
push(Collector, String, Map<String, String>) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a Collector, replacing all those with the same job and grouping key.
pushAdd(CollectorRegistry, String) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a registry, replacing only previously pushed metrics of the same name and job and no grouping key.
pushAdd(CollectorRegistry, String, Map<String, String>) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a registry, replacing only previously pushed metrics of the same name, job and grouping key.
pushAdd(Collector, String) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name and job and no grouping key.
pushAdd(Collector, String, Map<String, String>) - Method in class io.prometheus.client.exporter.PushGateway: Pushes all metrics in a Collector, replacing only previously pushed metrics of the same name, job and grouping key.
PushGateway - Class in io.prometheus.client.exporter: Export metrics via the Prometheus Pushgateway.
PushGateway(String) - Constructor for class io.prometheus.client.exporter.PushGateway: Construct a Pushgateway, with the given address.
PushGateway(URL) - Constructor for class io.prometheus.client.exporter.PushGateway: Construct a Pushgateway, with the given URL.

Q

quantile(double, double) - Method in class io.prometheus.client.Summary.Builder: The class JavaDoc for Summary has more information on Summary.Builder.quantile(double, double).
quantiles - Variable in class io.prometheus.client.Summary.Child.Value
QueuedThreadPoolStatisticsCollector - Class in io.prometheus.client.jetty
QueuedThreadPoolStatisticsCollector() - Constructor for class io.prometheus.client.jetty.QueuedThreadPoolStatisticsCollector
QueuedThreadPoolStatisticsCollector(QueuedThreadPool, String) - Constructor for class io.prometheus.client.jetty.QueuedThreadPoolStatisticsCollector

R

register() - Method in class io.prometheus.client.Collector: Register the Collector with the default registry.
register() - Method in class io.prometheus.client.SimpleCollector.Builder: Create and register the Collector with the default registry.
register(Collector) - Method in class io.prometheus.client.CollectorRegistry: Register a Collector.
register(CollectorRegistry) - Method in class io.prometheus.client.Collector: Register the Collector with the given registry.
register(CollectorRegistry) - Method in class io.prometheus.client.hibernate.HibernateStatisticsCollector
register(CollectorRegistry) - Static method in class io.prometheus.client.hotspot.DefaultExports: Register the default Hotspot collectors with the given registry.
register(CollectorRegistry) - Method in class io.prometheus.client.jetty.QueuedThreadPoolStatisticsCollector
register(CollectorRegistry) - Method in class io.prometheus.client.SimpleCollector.Builder: Create and register the Collector with the given registry.
remove(String...) - Method in class io.prometheus.client.SimpleCollector: Remove the Child with the given labels.
removeCache(String) - Method in class io.prometheus.client.cache.caffeine.CacheMetricsCollector: Remove the cache with the given name.
removeCache(String) - Method in class io.prometheus.client.guava.cache.CacheMetricsCollector: Remove the cache with the given name.
requiresLayout() - Method in class io.prometheus.client.log4j.InstrumentedAppender
reset() - Method in class io.prometheus.client.DoubleAdder: Resets variables maintaining the sum to zero.
restrictToNamesEqualTo(Predicate<String>, Collection<String>) - Static method in class io.prometheus.client.SampleNameFilter: Helper method to compose a filter such that Sample names must match the existing filter and be in the list of allowedNames This should be used to implement the names[] query parameter in HTTP exporters.

S

sample(double, double, double, Exemplar) - Method in class io.prometheus.client.exemplars.DefaultExemplarSampler
sample(double, double, double, Exemplar) - Method in interface io.prometheus.client.exemplars.HistogramExemplarSampler
sample(double, Exemplar) - Method in interface io.prometheus.client.exemplars.CounterExemplarSampler
sample(double, Exemplar) - Method in class io.prometheus.client.exemplars.DefaultExemplarSampler
Sample(String, List<String>, List<String>, double) - Constructor for class io.prometheus.client.Collector.MetricFamilySamples.Sample
Sample(String, List<String>, List<String>, double, Exemplar) - Constructor for class io.prometheus.client.Collector.MetricFamilySamples.Sample
Sample(String, List<String>, List<String>, double, Exemplar, Long) - Constructor for class io.prometheus.client.Collector.MetricFamilySamples.Sample
Sample(String, List<String>, List<String>, double, Long) - Constructor for class io.prometheus.client.Collector.MetricFamilySamples.Sample
SampleBuilder - Interface in io.prometheus.client.dropwizard.samplebuilder: SampleBuilder defines the action of creating a Collector.MetricFamilySamples.Sample for the given parameters.
SampleNameFilter - Class in io.prometheus.client: Filter samples (i.e.
SampleNameFilter.Builder - Class in io.prometheus.client
SampleNameFilterSupplier - Class in io.prometheus.client.exporter: For convenience, an implementation of a Supplier<Predicate<String>> that always returns the same sampleNameFilter.
samples - Variable in class io.prometheus.client.Collector.MetricFamilySamples
sanitizeMetricName(String) - Static method in class io.prometheus.client.Collector: Sanitize metric name
server - Variable in class io.prometheus.client.exporter.HTTPServer
ServletConfigAdapter - Interface in io.prometheus.client.servlet.common.adapter
ServletConfigurationException - Exception in io.prometheus.client.servlet.common.exporter
ServletConfigurationException() - Constructor for exception io.prometheus.client.servlet.common.exporter.ServletConfigurationException
set(double) - Method in class io.prometheus.client.DoubleAdder
set(double) - Method in class io.prometheus.client.Gauge.Child: Set the gauge to the given value.
set(double) - Method in class io.prometheus.client.Gauge: Set the gauge with no labels to the given value.
setChild(Child, String...) - Method in class io.prometheus.client.SimpleCollector: Replace the Child with the given labels.
setConnectionFactory(HttpConnectionFactory) - Method in class io.prometheus.client.exporter.PushGateway
setContentType(String) - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletResponseAdapter
setCounterExemplarSampler(CounterExemplarSampler) - Static method in class io.prometheus.client.exemplars.ExemplarConfig: Set the default exemplar sampler for Counters.
setDuration() - Method in class io.prometheus.client.Gauge.Timer: Set the amount of time in seconds since Gauge.Child.startTimer() was called.
setHistogramExemplarSampler(HistogramExemplarSampler) - Static method in class io.prometheus.client.exemplars.ExemplarConfig: Set the default exemplar sampler for Histograms.
setLabels(Map<String, String>) - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
setMatch(String) - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
setName(String) - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
setStatus(int) - Method in interface io.prometheus.client.servlet.common.adapter.HttpServletResponseAdapter
setToCurrentTime() - Method in class io.prometheus.client.Gauge.Child: Set the gauge to the current unixtime.
setToCurrentTime() - Method in class io.prometheus.client.Gauge: Set the gauge with no labels to the current unixtime.
setToTime(Runnable) - Method in class io.prometheus.client.Gauge.Child: Executes runnable code (e.g.
setToTime(Runnable) - Method in class io.prometheus.client.Gauge: Executes runnable code (e.g.
setToTime(Callable<E>) - Method in class io.prometheus.client.Gauge.Child: Executes callable code (e.g.
setToTime(Callable<E>) - Method in class io.prometheus.client.Gauge: Executes callable code (e.g.
shouldUseCompression(HttpExchange) - Static method in class io.prometheus.client.exporter.HTTPServer
SimpleCollector<Child> - Class in io.prometheus.client: Common functionality for Gauge, Counter, Summary and Histogram.
SimpleCollector(SimpleCollector.Builder) - Constructor for class io.prometheus.client.SimpleCollector
SimpleCollector.Builder<B extends SimpleCollector.Builder<B,C>,C extends SimpleCollector> - Class in io.prometheus.client: Builders let you configure and then create collectors.
SimpleTimer - Class in io.prometheus.client: SimpleTimer, to measure elapsed duration in seconds as a double.
SimpleTimer() - Constructor for class io.prometheus.client.SimpleTimer
SpanContextSupplier - Interface in io.prometheus.client.exemplars.tracer.common
SpringBootMetricsCollector - Class in io.prometheus.client.spring.boot: Spring boot metrics integration for Prometheus exporter.
SpringBootMetricsCollector(Collection<PublicMetrics>) - Constructor for class io.prometheus.client.spring.boot.SpringBootMetricsCollector
StandardExports - Class in io.prometheus.client.hotspot: Exports the standard exports common across all prometheus clients.
StandardExports() - Constructor for class io.prometheus.client.hotspot.StandardExports
start() - Method in class io.prometheus.client.logback.InstrumentedAppender
start(CollectorRegistry) - Method in class io.prometheus.client.bridge.Graphite: Push samples from the given registry to Graphite every minute.
start(CollectorRegistry, int) - Method in class io.prometheus.client.bridge.Graphite: Push samples from the given registry to Graphite at the given interval.
startTimer() - Method in class io.prometheus.client.Gauge.Child: Start a timer to track a duration.
startTimer() - Method in class io.prometheus.client.Gauge: Start a timer to track a duration, for the gauge with no labels.
startTimer() - Method in class io.prometheus.client.Histogram.Child: Start a timer to track a duration.
startTimer() - Method in class io.prometheus.client.Histogram: Start a timer to track a duration on the histogram with no labels.
startTimer() - Method in class io.prometheus.client.Summary.Child: Start a timer to track a duration.
startTimer() - Method in class io.prometheus.client.Summary: Start a timer to track a duration on the summary with no labels.
startTimer(HttpServletRequestAdapter) - Method in class io.prometheus.client.servlet.common.filter.Filter: To be called at the beginning of javax.servlet.Filter.doFilter() or jakarta.servlet.Filter.doFilter().
state(Enum) - Method in class io.prometheus.client.Enumeration.Child: Set the state.
state(Enum) - Method in class io.prometheus.client.Enumeration: Set the state on the enum with no labels.
state(String) - Method in class io.prometheus.client.Enumeration.Child: Set the state.
state(String) - Method in class io.prometheus.client.Enumeration: Set the state on the enum with no labels.
STATE_SET - io.prometheus.client.Collector.Type
states(Class) - Method in class io.prometheus.client.Enumeration.Builder: Take states from the names of the values in an Enum class.
states(String...) - Method in class io.prometheus.client.Enumeration.Builder
stop() - Method in class io.prometheus.client.exporter.HTTPServer: Deprecated.
renamed to close(), so that the HTTPServer can be used in try-with-resources.
stringToList(String) - Static method in class io.prometheus.client.SampleNameFilter: Helper method to deserialize a delimiter-separated list of Strings into a List<String>.
subsystem(String) - Method in class io.prometheus.client.SimpleCollector.Builder: Set the subsystem of the metric.
sum - Variable in class io.prometheus.client.Histogram.Child.Value
sum - Variable in class io.prometheus.client.Summary.Child.Value
sum() - Method in class io.prometheus.client.DoubleAdder: Returns the current sum.
Summary - Class in io.prometheus.client: Summary metrics and Histogram metrics can both be used to monitor distributions like latencies or request sizes.
SUMMARY - io.prometheus.client.Collector.Type
Summary.Builder - Class in io.prometheus.client
Summary.Child - Class in io.prometheus.client: The value of a single Summary.
Summary.Child.Value - Class in io.prometheus.client
Summary.Timer - Class in io.prometheus.client: Represents an event being timed.
SummaryMetricFamily - Class in io.prometheus.client: Summary metric family, for custom collectors and exporters.
SummaryMetricFamily(String, String, double, double) - Constructor for class io.prometheus.client.SummaryMetricFamily
SummaryMetricFamily(String, String, List<String>) - Constructor for class io.prometheus.client.SummaryMetricFamily
SummaryMetricFamily(String, String, List<String>, List<Double>) - Constructor for class io.prometheus.client.SummaryMetricFamily
sumThenReset() - Method in class io.prometheus.client.DoubleAdder: Equivalent in effect to DoubleAdder.sum() followed by DoubleAdder.reset().
Supplier<T> - Interface in io.prometheus.client: Replacement for Java 8's java.util.function.Supplier for compatibility with Java versions < 8.

T

test(String) - Method in class io.prometheus.client.SampleNameFilter
test(T) - Method in interface io.prometheus.client.Predicate
TextFormat - Class in io.prometheus.client.exporter.common
TextFormat() - Constructor for class io.prometheus.client.exporter.common.TextFormat
ThreadExports - Class in io.prometheus.client.hotspot: Exports metrics about JVM thread areas.
ThreadExports() - Constructor for class io.prometheus.client.hotspot.ThreadExports
ThreadExports(ThreadMXBean) - Constructor for class io.prometheus.client.hotspot.ThreadExports
time(Runnable) - Method in class io.prometheus.client.Histogram.Child: Executes runnable code (e.g.
time(Runnable) - Method in class io.prometheus.client.Histogram: Executes runnable code (e.g.
time(Runnable) - Method in class io.prometheus.client.Summary.Child: Executes runnable code (e.g.
time(Runnable) - Method in class io.prometheus.client.Summary: Executes runnable code (e.g.
time(Callable<E>) - Method in class io.prometheus.client.Histogram.Child: Executes callable code (e.g.
time(Callable<E>) - Method in class io.prometheus.client.Histogram: Executes callable code (e.g.
time(Callable<E>) - Method in class io.prometheus.client.Summary.Child: Executes callable code (e.g.
time(Callable<E>) - Method in class io.prometheus.client.Summary: Executes callable code (e.g.
timeable() - Method in class io.prometheus.client.spring.web.MethodTimer
timeMethod(ProceedingJoinPoint) - Method in class io.prometheus.client.spring.web.MethodTimer
timestampMs - Variable in class io.prometheus.client.Collector.MetricFamilySamples.Sample
timeWithExemplar(Runnable, String...) - Method in class io.prometheus.client.Histogram.Child: Like Histogram.Child.time(Runnable), but additionally create an exemplar.
timeWithExemplar(Runnable, String...) - Method in class io.prometheus.client.Histogram: Like Histogram.time(Runnable), but additionally create an exemplar.
timeWithExemplar(Runnable, Map<String, String>) - Method in class io.prometheus.client.Histogram.Child: Like Histogram.Child.time(Runnable), but additionally create an exemplar.
timeWithExemplar(Runnable, Map<String, String>) - Method in class io.prometheus.client.Histogram: Like Histogram.time(Runnable), but additionally create an exemplar.
timeWithExemplar(Callable<E>, String...) - Method in class io.prometheus.client.Histogram.Child: Like Histogram.Child.time(Callable), but additionally create an exemplar.
timeWithExemplar(Callable<E>, String...) - Method in class io.prometheus.client.Histogram: Like Histogram.time(Callable), but additionally create an exemplar.
timeWithExemplar(Callable<E>, Map<String, String>) - Method in class io.prometheus.client.Histogram.Child: Like Histogram.Child.time(Callable), but additionally create an exemplar.
timeWithExemplar(Callable<E>, Map<String, String>) - Method in class io.prometheus.client.Histogram: Like Histogram.time(Callable), but additionally create an exemplar.
toString() - Method in class io.prometheus.client.Collector.MetricFamilySamples.Sample
toString() - Method in class io.prometheus.client.Collector.MetricFamilySamples
toString() - Method in class io.prometheus.client.DoubleAdder: Returns the String representation of the DoubleAdder.sum().
toString() - Method in class io.prometheus.client.dropwizard.samplebuilder.MapperConfig
type - Variable in class io.prometheus.client.Collector.MetricFamilySamples

U

unit - Variable in class io.prometheus.client.Collector.MetricFamilySamples
unit - Variable in class io.prometheus.client.SimpleCollector
unit(String) - Method in class io.prometheus.client.SimpleCollector.Builder: Set the unit of the metric.
UNKNOWN - io.prometheus.client.Collector.Type
unregister(Collector) - Method in class io.prometheus.client.CollectorRegistry: Unregister a Collector.

V

value - Variable in class io.prometheus.client.Collector.MetricFamilySamples.Sample
value(Set<String>, String) - Method in class io.prometheus.client.spring.boot.PrometheusMvcEndpoint
Value(double, double[], Exemplar[], long) - Constructor for class io.prometheus.client.Histogram.Child.Value
valueOf(String) - Static method in enum io.prometheus.client.Collector.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.prometheus.client.Collector.Type: Returns an array containing the constants of this enum type, in the order they are declared.
VersionInfoExports - Class in io.prometheus.client.hotspot: Exports JVM version info.
VersionInfoExports() - Constructor for class io.prometheus.client.hotspot.VersionInfoExports

W

withAuthenticator(Authenticator) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Optional: Authenticator to use to support authentication.
withDaemonThreads(boolean) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: By default, the HTTPServer uses non-daemon threads.
withExemplars() - Method in class io.prometheus.client.Counter.Builder: Allow this counter to load exemplars from a CounterExemplarSampler.
withExemplars() - Method in class io.prometheus.client.Histogram.Builder: Allow this histogram to load exemplars from a HistogramExemplarSampler.
withExemplarSampler(CounterExemplarSampler) - Method in class io.prometheus.client.Counter.Builder: Enable exemplars and provide a custom CounterExemplarSampler.
withExemplarSampler(HistogramExemplarSampler) - Method in class io.prometheus.client.Histogram.Builder: Enable exemplars and provide a custom HistogramExemplarSampler.
withHostname(String) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Use this hostname to resolve the IP address to bind to.
withHttpsConfigurator(HttpsConfigurator) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Optional: HttpsConfigurator to use to support TLS/SSL
withHttpServer(HttpServer) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Use this httpServer.
withInetAddress(InetAddress) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Bind to this IP address.
withInetSocketAddress(InetSocketAddress) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Listen on this address.
withoutExemplars() - Method in class io.prometheus.client.Counter.Builder: Prevent this counter from loading exemplars from a CounterExemplarSampler.
withoutExemplars() - Method in class io.prometheus.client.Histogram.Builder: Prevent this histogram from loading exemplars from a HistogramExemplarSampler.
withPort(int) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Port to bind to.
withRegistry(CollectorRegistry) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Optional: Default is CollectorRegistry.defaultRegistry.
withSampleNameFilter(Predicate<String>) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Optional: Only export time series where sampleNameFilter.test(name) returns true.
withSampleNameFilterSupplier(Supplier<Predicate<String>>) - Method in class io.prometheus.client.exporter.HTTPServer.Builder: Optional: Only export time series where sampleNameFilter.test(name) returns true.
wrap(FilterConfig) - Static method in class io.prometheus.client.servlet.jakarta.Adapter
wrap(HttpServletRequest) - Static method in class io.prometheus.client.servlet.jakarta.Adapter
wrap(HttpServletResponse) - Static method in class io.prometheus.client.servlet.jakarta.Adapter
wrap(ServletConfig) - Static method in class io.prometheus.client.servlet.jakarta.Adapter
wrap(FilterConfig) - Static method in class io.prometheus.client.Adapter
wrap(HttpServletRequest) - Static method in class io.prometheus.client.Adapter
wrap(HttpServletResponse) - Static method in class io.prometheus.client.Adapter
wrap(ServletConfig) - Static method in class io.prometheus.client.Adapter
write004(Writer, Enumeration<Collector.MetricFamilySamples>) - Static method in class io.prometheus.client.exporter.common.TextFormat: Write out the text version 0.0.4 of the given MetricFamilySamples.
writeFormat(String, Writer, Enumeration<Collector.MetricFamilySamples>) - Static method in class io.prometheus.client.exporter.common.TextFormat: Write out the given MetricFamilySamples in a format per the contentType.
writeOpenMetrics100(Writer, Enumeration<Collector.MetricFamilySamples>) - Static method in class io.prometheus.client.exporter.common.TextFormat: Write out the OpenMetrics text version 1.0.0 of the given MetricFamilySamples.

A B C D E F G H I J L M N O P Q R S T U V W
All Classes All Packages