Package io.prometheus.metrics.exporter.opentelemetry

Class OpenTelemetryExporter.Builder

Object

Builder

Enclosing class:

OpenTelemetryExporter

public static class OpenTelemetryExporter.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
OpenTelemetryExporter	buildAndStart()
OpenTelemetryExporter.Builder	endpoint(String endpoint)	The OTLP endpoint to send metric data to.
OpenTelemetryExporter.Builder	header(String name, String value)	Add an HTTP header to be applied to outgoing requests.
OpenTelemetryExporter.Builder	intervalSeconds(int intervalSeconds)	The interval between the start of two export attempts.
OpenTelemetryExporter.Builder	protocol(String protocol)	Specifies the OTLP transport protocol to be used when exporting metrics.
OpenTelemetryExporter.Builder	registry(PrometheusRegistry registry)
OpenTelemetryExporter.Builder	resourceAttribute(String name, String value)	Add a resource attribute.
OpenTelemetryExporter.Builder	serviceInstanceId(String serviceInstanceId)	The service.instance.id resource attribute.
OpenTelemetryExporter.Builder	serviceName(String serviceName)	The service.name resource attribute.
OpenTelemetryExporter.Builder	serviceNamespace(String serviceNamespace)	The service.namespace resource attribute.
OpenTelemetryExporter.Builder	serviceVersion(String serviceVersion)	The service.version resource attribute.
OpenTelemetryExporter.Builder	timeoutSeconds(int timeoutSeconds)	The timeout for outgoing requests.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

registry

public OpenTelemetryExporter.Builder registry(PrometheusRegistry registry)

protocol

public OpenTelemetryExporter.Builder protocol(String protocol)

Specifies the OTLP transport protocol to be used when exporting metrics.

Supported values are "grpc" and "http/protobuf". Default is "grpc".

See OpenTelemetry's OTEL_EXPORTER_OTLP_PROTOCOL.

endpoint

public OpenTelemetryExporter.Builder endpoint(String endpoint)

The OTLP endpoint to send metric data to.

The default depends on the protocol:

• "grpc": "http://localhost:4317"
• "http/protobuf": "http://localhost:4318/v1/metrics"

If the protocol is "http/protobuf" and the endpoint does not have the "/v1/metrics" suffix, the "/v1/metrics" suffix will automatically be appended.

See OpenTelemetry's OTEL_EXPORTER_OTLP_METRICS_ENDPOINT.

header

public OpenTelemetryExporter.Builder header(String name,
 String value)

Add an HTTP header to be applied to outgoing requests. Call multiple times to add multiple headers.

See OpenTelemetry's OTEL_EXPORTER_OTLP_HEADERS.

intervalSeconds

public OpenTelemetryExporter.Builder intervalSeconds(int intervalSeconds)

The interval between the start of two export attempts. Default is 60000.

Like OpenTelemetry's OTEL_METRIC_EXPORT_INTERVAL, but in seconds rather than milliseconds.

timeoutSeconds

public OpenTelemetryExporter.Builder timeoutSeconds(int timeoutSeconds)

The timeout for outgoing requests. Default is 10.

Like OpenTelemetry's OTEL_EXPORTER_OTLP_METRICS_TIMEOUT, but in seconds rather than milliseconds.

serviceName

public OpenTelemetryExporter.Builder serviceName(String serviceName)

The service.name resource attribute.

If not explicitly specified, client_java will try to initialize it with a reasonable default, like the JAR file name.

See service.name in OpenTelemetry's Resource Semantic Conventions.

serviceNamespace

public OpenTelemetryExporter.Builder serviceNamespace(String serviceNamespace)

The service.namespace resource attribute.

See service.namespace in OpenTelemetry's Resource Semantic Conventions.

serviceInstanceId

public OpenTelemetryExporter.Builder serviceInstanceId(String serviceInstanceId)

The service.instance.id resource attribute.

See service.instance.id in OpenTelemetry's Resource Semantic Conventions.

serviceVersion

public OpenTelemetryExporter.Builder serviceVersion(String serviceVersion)

The service.version resource attribute.

See service.version in OpenTelemetry's Resource Semantic Conventions.

resourceAttribute

public OpenTelemetryExporter.Builder resourceAttribute(String name,
 String value)

Add a resource attribute. Call multiple times to add multiple resource attributes.

See OpenTelemetry's OTEL_RESOURCE_ATTRIBUTES.

buildAndStart

public OpenTelemetryExporter buildAndStart()