Index

A B D E F G H I J L M P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

address(String) - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties.Builder

ALLOW_UTF8 - Enum constant in enum class io.prometheus.metrics.config.EscapingScheme

NO_ESCAPING indicates that a name will not be escaped.

allowedNames(String...) - Method in class io.prometheus.metrics.config.ExporterFilterProperties.Builder

Only allowed metric names will be exposed.

allowedPrefixes(String...) - Method in class io.prometheus.metrics.config.ExporterFilterProperties.Builder

Only metrics with a name starting with an allowed prefix will be exposed.

B

build() - Method in class io.prometheus.metrics.config.ExemplarsProperties.Builder

build() - Method in class io.prometheus.metrics.config.ExporterFilterProperties.Builder

build() - Method in class io.prometheus.metrics.config.ExporterHttpServerProperties.Builder

build() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

build() - Method in class io.prometheus.metrics.config.ExporterProperties.Builder

build() - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties.Builder

build() - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

build() - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

builder() - Static method in class io.prometheus.metrics.config.ExemplarsProperties

builder() - Static method in class io.prometheus.metrics.config.ExporterFilterProperties

builder() - Static method in class io.prometheus.metrics.config.ExporterHttpServerProperties

builder() - Static method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

builder() - Static method in class io.prometheus.metrics.config.ExporterProperties

builder() - Static method in class io.prometheus.metrics.config.ExporterPushgatewayProperties

builder() - Static method in class io.prometheus.metrics.config.MetricsProperties

builder() - Static method in class io.prometheus.metrics.config.PrometheusProperties

D

DEFAULT - Static variable in enum class io.prometheus.metrics.config.EscapingScheme

Default escaping scheme for names when not specified.

defaultMetricsProperties(MetricsProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

DOTS_ESCAPING - Enum constant in enum class io.prometheus.metrics.config.EscapingScheme

DOTS_ESCAPING is similar to UNDERSCORE_ESCAPING, except that dots are converted to `_dot_` and pre-existing underscores are converted to `__`.

E

endpoint(String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

escapingScheme(EscapingScheme) - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties.Builder

EscapingScheme - Enum Class in io.prometheus.metrics.config

excludedNames(String...) - Method in class io.prometheus.metrics.config.ExporterFilterProperties.Builder

Excluded metric names will not be exposed.

excludedPrefixes(String...) - Method in class io.prometheus.metrics.config.ExporterFilterProperties.Builder

Metrics with a name starting with an excluded prefix will not be exposed.

exemplarProperties(ExemplarsProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

exemplarsEnabled(Boolean) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getExemplarsEnabled()

exemplarsOnAllMetricTypes(boolean) - Method in class io.prometheus.metrics.config.ExporterProperties.Builder

See ExporterProperties.getExemplarsOnAllMetricTypes().

ExemplarsProperties - Class in io.prometheus.metrics.config

Properties starting with io.prometheus.exemplars

ExemplarsProperties.Builder - Class in io.prometheus.metrics.config

exporterFilterProperties(ExporterFilterProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

ExporterFilterProperties - Class in io.prometheus.metrics.config

Properties starting with io.prometheus.exporter.filter

ExporterFilterProperties.Builder - Class in io.prometheus.metrics.config

exporterHttpServerProperties(ExporterHttpServerProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

ExporterHttpServerProperties - Class in io.prometheus.metrics.config

Properties starting with io.prometheus.exporter.httpServer

ExporterHttpServerProperties.Builder - Class in io.prometheus.metrics.config

exporterOpenTelemetryProperties(ExporterOpenTelemetryProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

ExporterOpenTelemetryProperties - Class in io.prometheus.metrics.config

ExporterOpenTelemetryProperties.Builder - Class in io.prometheus.metrics.config

exporterProperties(ExporterProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

ExporterProperties - Class in io.prometheus.metrics.config

Properties starting with io.prometheus.exporter

ExporterProperties.Builder - Class in io.prometheus.metrics.config

ExporterPushgatewayProperties - Class in io.prometheus.metrics.config

ExporterPushgatewayProperties.Builder - Class in io.prometheus.metrics.config

F

fromAcceptHeader(String) - Static method in enum class io.prometheus.metrics.config.EscapingScheme

fromAcceptHeader returns an EscapingScheme depending on the Accept header.

G

get() - Static method in class io.prometheus.metrics.config.PrometheusProperties

Get the properties instance.

getAddress() - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties

Address of the Pushgateway in the form host:port.

getAllowedMetricNamePrefixes() - Method in class io.prometheus.metrics.config.ExporterFilterProperties

getAllowedMetricNames() - Method in class io.prometheus.metrics.config.ExporterFilterProperties

getDefaultMetricProperties() - Method in class io.prometheus.metrics.config.PrometheusProperties

The default metric properties apply for metrics where PrometheusProperties.getMetricProperties(String) is null.

getEndpoint() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getEscapingScheme() - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties

Escaping scheme to be used when pushing metric data to the pushgateway.

getExcludedMetricNamePrefixes() - Method in class io.prometheus.metrics.config.ExporterFilterProperties

getExcludedMetricNames() - Method in class io.prometheus.metrics.config.ExporterFilterProperties

getExemplarProperties() - Method in class io.prometheus.metrics.config.PrometheusProperties

getExemplarsEnabled() - Method in class io.prometheus.metrics.config.MetricsProperties

This is the only configuration property that can be applied to all metric types.

getExemplarsOnAllMetricTypes() - Method in class io.prometheus.metrics.config.ExporterProperties

Allow Exemplars on all metric types in OpenMetrics format?

getExporterFilterProperties() - Method in class io.prometheus.metrics.config.PrometheusProperties

getExporterHttpServerProperties() - Method in class io.prometheus.metrics.config.PrometheusProperties

getExporterOpenTelemetryProperties() - Method in class io.prometheus.metrics.config.PrometheusProperties

getExporterProperties() - Method in class io.prometheus.metrics.config.PrometheusProperties

getExporterPushgatewayProperties() - Method in class io.prometheus.metrics.config.PrometheusProperties

getHeaders() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getHistogramClassicOnly() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.classicOnly()

getHistogramClassicUpperBounds() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.classicBuckets()

getHistogramNativeInitialSchema() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.nativeInitialSchema()

getHistogramNativeMaxNumberOfBuckets() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.nativeMaxNumberOfBuckets()

getHistogramNativeMaxZeroThreshold() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.nativeMaxZeroThreshold()

getHistogramNativeMinZeroThreshold() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.nativeMinZeroThreshold()

getHistogramNativeOnly() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.nativeOnly()

getHistogramNativeResetDurationSeconds() - Method in class io.prometheus.metrics.config.MetricsProperties

See Histogram.Builder.nativeResetDuration()

getIncludeCreatedTimestamps() - Method in class io.prometheus.metrics.config.ExporterProperties

Include the _created timestamps in text format?

getInterval() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getJob() - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties

job label for metrics being pushed.

getMaxRetentionPeriodSeconds() - Method in class io.prometheus.metrics.config.ExemplarsProperties

Maximum time how long Exemplars are kept before they are evicted.

getMetricProperties(String) - Method in class io.prometheus.metrics.config.PrometheusProperties

Properties specific for one metric.

getMinRetentionPeriodSeconds() - Method in class io.prometheus.metrics.config.ExemplarsProperties

Minimum time how long Exemplars are kept before they may be replaced by new Exemplars.

getPort() - Method in class io.prometheus.metrics.config.ExporterHttpServerProperties

getPrometheusTimestampsInMs() - Method in class io.prometheus.metrics.config.ExporterProperties

Use milliseconds for timestamps in prometheus text format?

getProtocol() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getResourceAttributes() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getSampleIntervalMilliseconds() - Method in class io.prometheus.metrics.config.ExemplarsProperties

Time between attempts to sample new Exemplars.

getScheme() - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties

Scheme to be used when pushing metrics to the pushgateway.

getServiceInstanceId() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getServiceName() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getServiceNamespace() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getServiceVersion() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getSummaryMaxAgeSeconds() - Method in class io.prometheus.metrics.config.MetricsProperties

See Summary.Builder.maxAgeSeconds()

getSummaryNumberOfAgeBuckets() - Method in class io.prometheus.metrics.config.MetricsProperties

See Summary.Builder.numberOfAgeBuckets()

getSummaryQuantileErrors() - Method in class io.prometheus.metrics.config.MetricsProperties

See Summary.Builder.quantile()

getSummaryQuantiles() - Method in class io.prometheus.metrics.config.MetricsProperties

See Summary.Builder.quantile()

getTimeout() - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties

getValue() - Method in enum class io.prometheus.metrics.config.EscapingScheme

H

header(String, String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

Add a request header.

histogramClassicOnly(Boolean) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramClassicOnly()

histogramClassicUpperBounds(double...) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramClassicUpperBounds()

histogramNativeInitialSchema(Integer) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramNativeInitialSchema()

histogramNativeMaxNumberOfBuckets(Integer) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramNativeMaxNumberOfBuckets()

histogramNativeMaxZeroThreshold(Double) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramNativeMaxZeroThreshold()

histogramNativeMinZeroThreshold(Double) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramNativeMinZeroThreshold()

histogramNativeOnly(Boolean) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramNativeOnly()

histogramNativeResetDurationSeconds(Long) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getHistogramNativeResetDurationSeconds()

I

includeCreatedTimestamps(boolean) - Method in class io.prometheus.metrics.config.ExporterProperties.Builder

See ExporterProperties.getIncludeCreatedTimestamps()

intervalSeconds(int) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

io.prometheus.metrics.config - module io.prometheus.metrics.config

io.prometheus.metrics.config - package io.prometheus.metrics.config

J

job(String) - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties.Builder

L

load() - Static method in class io.prometheus.metrics.config.PrometheusPropertiesLoader

See PrometheusProperties.get().

load(Map<Object, Object>) - Static method in class io.prometheus.metrics.config.PrometheusPropertiesLoader

M

maxRetentionPeriodSeconds(int) - Method in class io.prometheus.metrics.config.ExemplarsProperties.Builder

METRIC_NAME_MUST_BE_EQUAL_TO - Static variable in class io.prometheus.metrics.config.ExporterFilterProperties

METRIC_NAME_MUST_NOT_BE_EQUAL_TO - Static variable in class io.prometheus.metrics.config.ExporterFilterProperties

METRIC_NAME_MUST_NOT_START_WITH - Static variable in class io.prometheus.metrics.config.ExporterFilterProperties

METRIC_NAME_MUST_START_WITH - Static variable in class io.prometheus.metrics.config.ExporterFilterProperties

metricProperties(Map<String, MetricsProperties>) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

MetricsProperties - Class in io.prometheus.metrics.config

Properties starting with io.prometheus.metrics

MetricsProperties(Boolean, Boolean, Boolean, List<Double>, Integer, Double, Double, Integer, Long, List<Double>, List<Double>, Long, Integer) - Constructor for class io.prometheus.metrics.config.MetricsProperties

MetricsProperties.Builder - Class in io.prometheus.metrics.config

minRetentionPeriodSeconds(int) - Method in class io.prometheus.metrics.config.ExemplarsProperties.Builder

P

port(int) - Method in class io.prometheus.metrics.config.ExporterHttpServerProperties.Builder

PrometheusProperties - Class in io.prometheus.metrics.config

The Prometheus Java client library can be configured at runtime (e.g. using a properties file).

PrometheusProperties(MetricsProperties, Map<String, MetricsProperties>, ExemplarsProperties, ExporterProperties, ExporterFilterProperties, ExporterHttpServerProperties, ExporterPushgatewayProperties, ExporterOpenTelemetryProperties) - Constructor for class io.prometheus.metrics.config.PrometheusProperties

PrometheusProperties.Builder - Class in io.prometheus.metrics.config

PrometheusPropertiesException - Exception in io.prometheus.metrics.config

PrometheusPropertiesException(String) - Constructor for exception io.prometheus.metrics.config.PrometheusPropertiesException

PrometheusPropertiesException(String, Exception) - Constructor for exception io.prometheus.metrics.config.PrometheusPropertiesException

PrometheusPropertiesLoader - Class in io.prometheus.metrics.config

The Properties Loader is early stages.

PrometheusPropertiesLoader() - Constructor for class io.prometheus.metrics.config.PrometheusPropertiesLoader

prometheusTimestampsInMs(boolean) - Method in class io.prometheus.metrics.config.ExporterProperties.Builder

See ExporterProperties.getPrometheusTimestampsInMs().

protocol(String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

pushgatewayProperties(ExporterPushgatewayProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

putMetricProperty(String, MetricsProperties) - Method in class io.prometheus.metrics.config.PrometheusProperties.Builder

Convenience for adding a single named MetricsProperties

R

resourceAttribute(String, String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

S

sampleIntervalMilliseconds(int) - Method in class io.prometheus.metrics.config.ExemplarsProperties.Builder

scheme(String) - Method in class io.prometheus.metrics.config.ExporterPushgatewayProperties.Builder

serviceInstanceId(String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

serviceName(String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

serviceNamespace(String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

serviceVersion(String) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

summaryMaxAgeSeconds(Long) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getSummaryMaxAgeSeconds()

summaryNumberOfAgeBuckets(Integer) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getSummaryNumberOfAgeBuckets()

summaryQuantileErrors(double...) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getSummaryQuantileErrors()

summaryQuantiles(double...) - Method in class io.prometheus.metrics.config.MetricsProperties.Builder

See MetricsProperties.getSummaryQuantiles()

T

timeoutSeconds(int) - Method in class io.prometheus.metrics.config.ExporterOpenTelemetryProperties.Builder

toHeaderFormat() - Method in enum class io.prometheus.metrics.config.EscapingScheme

U

UNDERSCORE_ESCAPING - Enum constant in enum class io.prometheus.metrics.config.EscapingScheme

UNDERSCORE_ESCAPING replaces all legacy-invalid characters with underscores.

V

VALUE_ENCODING_ESCAPING - Enum constant in enum class io.prometheus.metrics.config.EscapingScheme

VALUE_ENCODING_ESCAPING prepends the name with `U__` and replaces all invalid characters with the Unicode value, surrounded by underscores.

valueOf(String) - Static method in enum class io.prometheus.metrics.config.EscapingScheme

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.prometheus.metrics.config.EscapingScheme

Returns an array containing the constants of this enum class, in the order they are declared.

A B D E F G H I J L M P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form