Class ExporterOpenTelemetryProperties

java.lang.Object

io.prometheus.metrics.config.ExporterOpenTelemetryProperties

public class ExporterOpenTelemetryProperties
extends Object

Properties for configuring the OpenTelemetry exporter.

These properties can be configured via prometheus.properties, system properties, or programmatically.

All properties are prefixed with io.prometheus.exporter.opentelemetry.

Available properties:

• protocol - OTLP protocol: "grpc" or "http/protobuf"
• endpoint - OTLP endpoint URL
• headers - HTTP headers for outgoing requests
• intervalSeconds - Export interval in seconds
• timeoutSeconds - Request timeout in seconds
• serviceName - Service name resource attribute
• serviceNamespace - Service namespace resource attribute
• serviceInstanceId - Service instance ID resource attribute
• serviceVersion - Service version resource attribute
• resourceAttributes - Additional resource attributes

See Also:

• OpenTelemetry SDK Environment Variables

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExporterOpenTelemetryProperties.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final String	endpoint
private static final String	ENDPOINT
private final Map<String,String>	headers
private static final String	HEADERS
private final String	interval
private static final String	INTERVAL_SECONDS
private static final String	PREFIX
private final String	protocol
private static final String	PROTOCOL
private static final String	RESOURCE_ATTRIBUTES
private final Map<String,String>	resourceAttributes
private static final String	SERVICE_INSTANCE_ID
private static final String	SERVICE_NAME
private static final String	SERVICE_NAMESPACE
private static final String	SERVICE_VERSION
private final String	serviceInstanceId
private final String	serviceName
private final String	serviceNamespace
private final String	serviceVersion
private final String	timeout
private static final String	TIMEOUT_SECONDS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExporterOpenTelemetryProperties(String protocol, String endpoint, Map<String,String> headers, String interval, String timeout, String serviceName, String serviceNamespace, String serviceInstanceId, String serviceVersion, Map<String,String> resourceAttributes)

Method Summary

Modifier and Type	Method	Description
static ExporterOpenTelemetryProperties.Builder	builder()
String	getEndpoint()
Map<String,String>	getHeaders()
String	getInterval()
String	getProtocol()
Map<String,String>	getResourceAttributes()
String	getServiceInstanceId()
String	getServiceName()
String	getServiceNamespace()
String	getServiceVersion()
String	getTimeout()
(package private) static ExporterOpenTelemetryProperties	load(PropertySource propertySource)	Note that this will remove entries from propertySource.

Methods inherited from class Object

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

Field Details

PROTOCOL

private static final String PROTOCOL

See Also:

• Constant Field Values

ENDPOINT

private static final String ENDPOINT

See Also:

• Constant Field Values

HEADERS

private static final String HEADERS

See Also:

• Constant Field Values

INTERVAL_SECONDS

private static final String INTERVAL_SECONDS

See Also:

• Constant Field Values

TIMEOUT_SECONDS

private static final String TIMEOUT_SECONDS

See Also:

• Constant Field Values

SERVICE_NAME

private static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_NAMESPACE

private static final String SERVICE_NAMESPACE

See Also:

• Constant Field Values

SERVICE_INSTANCE_ID

private static final String SERVICE_INSTANCE_ID

See Also:

• Constant Field Values

SERVICE_VERSION

private static final String SERVICE_VERSION

See Also:

• Constant Field Values

RESOURCE_ATTRIBUTES

private static final String RESOURCE_ATTRIBUTES

See Also:

• Constant Field Values

PREFIX

private static final String PREFIX

See Also:

• Constant Field Values

endpoint

private final String endpoint

protocol

private final String protocol

headers

private final Map<String,String> headers

interval

private final String interval

timeout

private final String timeout

serviceName

private final String serviceName

serviceNamespace

private final String serviceNamespace

serviceInstanceId

private final String serviceInstanceId

serviceVersion

private final String serviceVersion

resourceAttributes

private final Map<String,String> resourceAttributes

Constructor Details

ExporterOpenTelemetryProperties

private ExporterOpenTelemetryProperties(String protocol,
 String endpoint,
 Map<String,String> headers,
 String interval,
 String timeout,
 String serviceName,
 String serviceNamespace,
 String serviceInstanceId,
 String serviceVersion,
 Map<String,String> resourceAttributes)

Method Details

getProtocol

public String getProtocol()

getEndpoint

public String getEndpoint()

getHeaders

public Map<String,String> getHeaders()

getInterval

public String getInterval()

getTimeout

public String getTimeout()

getServiceName

public String getServiceName()

getServiceNamespace

public String getServiceNamespace()

getServiceInstanceId

public String getServiceInstanceId()

getServiceVersion

public String getServiceVersion()

getResourceAttributes

public Map<String,String> getResourceAttributes()

load

static ExporterOpenTelemetryProperties load(PropertySource propertySource)
                                     throws PrometheusPropertiesException

Note that this will remove entries from propertySource. This is because we want to know if there are unused properties remaining after all properties have been loaded.

Throws:

PrometheusPropertiesException

builder

public static ExporterOpenTelemetryProperties.Builder builder()