Interface PrometheusNamingConventionConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

PrometheusNamingConventionConfig.BuilderBase.PrometheusNamingConventionConfigImpl

public interface PrometheusNamingConventionConfig
extends Prototype.Api

Settings controlling Prometheus naming conventions.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PrometheusNamingConventionConfig.Builder	Fluent API builder for PrometheusNamingConventionConfig.
static class	PrometheusNamingConventionConfig.BuilderBase<BUILDER extends PrometheusNamingConventionConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends PrometheusNamingConventionConfig>	Fluent API builder base for PrometheusNamingConventionConfig.

Method Summary

Modifier and Type	Method	Description
static PrometheusNamingConventionConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static PrometheusNamingConventionConfig.Builder	builder(PrometheusNamingConventionConfig instance)	Create a new fluent API builder from an existing instance.
static PrometheusNamingConventionConfig	create()	Create a new instance with default values.
static PrometheusNamingConventionConfig	create(Config config)	Create a new instance from configuration.
Optional<String>	nonLetterPrefix()	Prefix to add to metric names and tag keys which do not begin with a letter; configuring this setting enables legacy simpleclient-compatible normalization, with m_ reproducing the naming from earlier Helidon releases, and preserves user-supplied reserved suffixes such as _total, _created, _bucket, and _info, whereas leaving it unset uses the new Prometheus client's normalization; the prefix must be non-empty and match [A-Za-z][A-Za-z0-9_]*, and constructing the publisher fails if the value is invalid.
String	timerSuffix()	Suffix which identifies a timer name before Prometheus adds _seconds.

Method Details

builder

static PrometheusNamingConventionConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static PrometheusNamingConventionConfig.Builder builder(PrometheusNamingConventionConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static PrometheusNamingConventionConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static PrometheusNamingConventionConfig create()

Create a new instance with default values.

Returns:

a new instance

timerSuffix

String timerSuffix()

Suffix which identifies a timer name before Prometheus adds _seconds.

Returns:

timer suffix

nonLetterPrefix

Optional<String> nonLetterPrefix()

Prefix to add to metric names and tag keys which do not begin with a letter; configuring this setting enables legacy simpleclient-compatible normalization, with m_ reproducing the naming from earlier Helidon releases, and preserves user-supplied reserved suffixes such as _total, _created, _bucket, and _info, whereas leaving it unset uses the new Prometheus client's normalization; the prefix must be non-empty and match [A-Za-z][A-Za-z0-9_]*, and constructing the publisher fails if the value is invalid.

Returns:

non-letter prefix