Interface MetricExporterConfig

All Superinterfaces:

OtlpExporterConfig, Prototype.Api

All Known Implementing Classes:

MetricExporterConfig.BuilderBase.MetricExporterConfigImpl

public interface MetricExporterConfig
extends Prototype.Api, OtlpExporterConfig

OpenTelemetry metric exporter settings.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MetricExporterConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static MetricExporterConfig.Builder	builder(MetricExporterConfig instance)	Create a new fluent API builder from an existing instance.
static MetricExporterConfig	create()	Create a new instance with default values.
static MetricExporterConfig	create(Config config)	Create a new instance from configuration.
Optional<io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector>	defaultHistogramAggregation()	Preferred default histogram aggregation technique, configurable as MetricDefaultHistogramAggregationConfig.
Optional<io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector>	temporalityPreference()	Preferred output aggregation technique (how transmitted values reflect the values recorded locally), configurable as a MetricTemporalityPreferenceType value: CUMULATIVE, DELTA, LOWMEMORY.
MetricExporterType	type()	Metric exporter type.

Methods inherited from interface OtlpExporterConfig

clientTlsCertificatePem, clientTlsPrivateKeyPem, compression, connectTimeout, endpoint, headers, internalTelemetryVersion, memoryMode, meterProvider, protocol, retryPolicy, sslContext, timeout, trustedCertificatesPem, trustManager

Modifier and Type	Method	Description
Optional<Resource>	clientTlsCertificatePem()	TLS certificate.
Optional<Resource>	clientTlsPrivateKeyPem()	TLS client key.
Optional<CompressionType>	compression()	Compression the exporter uses.
Optional<Duration>	connectTimeout()	Connection timeout.
Optional<URI>	endpoint()	Endpoint of the collector to which the exporter should transmit.
Map<String,String>	headers()	Headers added to each export message.
Optional<io.opentelemetry.sdk.common.InternalTelemetryVersion>	internalTelemetryVersion()	Self-monitoring telemetry OpenTelemetry should collect.
Optional<io.opentelemetry.sdk.common.export.MemoryMode>	memoryMode()	Memory mode.
Optional<io.opentelemetry.api.metrics.MeterProvider>	meterProvider()	Meter provider for the exporter.
Optional<OtlpExporterProtocolType>	protocol()	Exporter protocol type.
Optional<io.opentelemetry.sdk.common.export.RetryPolicy>	retryPolicy()	Retry policy.
Optional<SSLContext>	sslContext()	SSL context for the exporter.
Optional<Duration>	timeout()	Exporter timeout.
Optional<Resource>	trustedCertificatesPem()	Trusted certificates.
Optional<X509TrustManager>	trustManager()	X509 trust manager for the exporter.

Method Details

builder

static MetricExporterConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static MetricExporterConfig.Builder builder(MetricExporterConfig 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 MetricExporterConfig 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 MetricExporterConfig create()

Create a new instance with default values.

Returns:

a new instance

type

MetricExporterType type()

Metric exporter type.

Returns:

metric exporter type

temporalityPreference

Optional<io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector> temporalityPreference()

Preferred output aggregation technique (how transmitted values reflect the values recorded locally), configurable as a MetricTemporalityPreferenceType value: CUMULATIVE, DELTA, LOWMEMORY.

Returns:

output aggregation technique

defaultHistogramAggregation

Optional<io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector> defaultHistogramAggregation()

Preferred default histogram aggregation technique, configurable as MetricDefaultHistogramAggregationConfig.

Returns:

default histogram aggregation technique