io.honeycomb.opentelemetry

Class OpenTelemetryConfiguration.Builder

java.lang.Object

io.honeycomb.opentelemetry.OpenTelemetryConfiguration.Builder

Enclosing class:

OpenTelemetryConfiguration

public static class OpenTelemetryConfiguration.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
OpenTelemetryConfiguration.Builder	addResourceAttribute(java.lang.String key, boolean value) Add a boolean attribute as a resource attribute.
OpenTelemetryConfiguration.Builder	addResourceAttribute(java.lang.String key, double value) Add a double attribute as a resource attribute.
OpenTelemetryConfiguration.Builder	addResourceAttribute(java.lang.String key, long value) Add a long attribute as a resource attribute.
OpenTelemetryConfiguration.Builder	addResourceAttribute(java.lang.String key, java.lang.String... value) Add a String array attribute as a resource attribute.
OpenTelemetryConfiguration.Builder	addResourceAttribute(java.lang.String key, java.lang.String value) Add a string attribute as a resource attribute.
OpenTelemetryConfiguration.Builder	addSpanProcessor(io.opentelemetry.sdk.trace.SpanProcessor spanProcessor) Configures additional SpanProcessor.
io.opentelemetry.api.OpenTelemetry	build() Returns a new OpenTelemetry built with the configuration of this OpenTelemetryConfiguration.Builder.
io.opentelemetry.api.OpenTelemetry	buildAndRegisterGlobal() Returns a new OpenTelemetry built with the configuration of this OpenTelemetryConfiguration.Builder and registers it as the global OpenTelemetry.
OpenTelemetryConfiguration.Builder	enableDebug(boolean enabled) Enables debug mode.
OpenTelemetryConfiguration.Builder	setApiKey(java.lang.String apiKey) Sets the Honeycomb API Key to use.
OpenTelemetryConfiguration.Builder	setDataset(java.lang.String dataset) Sets the Honeycomb dataset to use.
OpenTelemetryConfiguration.Builder	setEndpoint(java.lang.String endpoint) Sets the Honeycomb endpoint to use.
OpenTelemetryConfiguration.Builder	setOtlpProtocol(java.lang.String protocol) Sets the OTLP procotol used to export trace spans.
OpenTelemetryConfiguration.Builder	setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators) Sets the ContextPropagators to use.
OpenTelemetryConfiguration.Builder	setSampler(io.opentelemetry.sdk.trace.samplers.Sampler sampler) Sets the Sampler to use.
OpenTelemetryConfiguration.Builder	setServiceName(java.lang.String serviceName) Sets the service name as a resource attribute.
OpenTelemetryConfiguration.Builder	setTracesApiKey(java.lang.String apiKey) Sets the Honeycomb API key to send trace data.
OpenTelemetryConfiguration.Builder	setTracesDataset(java.lang.String dataset) Sets the Honeycomb dataset to store trace data.
OpenTelemetryConfiguration.Builder	setTracesEndpoint(java.lang.String endpoint) Sets the Honeycomb endpoint to send trace data.

Methods inherited from class java.lang.Object

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

Method Detail

setApiKey

public OpenTelemetryConfiguration.Builder setApiKey(java.lang.String apiKey)

Sets the Honeycomb API Key to use.

This value is sent to Honeycomb on every request and is used to identify the team making a request.

Parameters:

apiKey - a String to use as the API key. See team settings in Honeycomb.

Returns:

builder

setTracesApiKey

public OpenTelemetryConfiguration.Builder setTracesApiKey(java.lang.String apiKey)

Sets the Honeycomb API key to send trace data.

This value is sent to Honeycomb on every request and is used to identify the team making a request.

Parameters:

apiKey - a String to use as the API key. See team settings in Honeycomb.

Returns:

builder

setDataset

public OpenTelemetryConfiguration.Builder setDataset(java.lang.String dataset)

Sets the Honeycomb dataset to use.

This value is sent to Honeycomb on every request and is used to identify the dataset that trace data is being written to.

Parameters:

dataset - a String to use as the dataset name.

Returns:

builder

setTracesDataset

public OpenTelemetryConfiguration.Builder setTracesDataset(java.lang.String dataset)

Sets the Honeycomb dataset to store trace data.

This value is sent to Honeycomb on every request and is used to identify the dataset that metrics data is being written to.

Parameters:

dataset - a String to use as the metrics dataset name.

Returns:

builder

setEndpoint

public OpenTelemetryConfiguration.Builder setEndpoint(java.lang.String endpoint)

Sets the Honeycomb endpoint to use. Optional, defaults to the Honeycomb ingest API.

Parameters:

endpoint - a String to use as the endpoint URI. Must begin with https or http.

Returns:

builder

setTracesEndpoint

public OpenTelemetryConfiguration.Builder setTracesEndpoint(java.lang.String endpoint)

Sets the Honeycomb endpoint to send trace data. Optional, defaults to the Honeycomb ingest API.

Parameters:

endpoint - a String to use as the endpoint URI. Must begin with https or http.

Returns:

builder

setServiceName

public OpenTelemetryConfiguration.Builder setServiceName(java.lang.String serviceName)

Sets the service name as a resource attribute.

Parameters:

serviceName - a String to use as the service name

Returns:

builder

setPropagators

public OpenTelemetryConfiguration.Builder setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)

Sets the ContextPropagators to use.

Note that if none are specified, W3CTraceContextPropagator and W3CBaggagePropagator will be used by default.

Parameters:

propagators - ContextPropagators to use for context propagation

Returns:

builder

setSampler

public OpenTelemetryConfiguration.Builder setSampler(io.opentelemetry.sdk.trace.samplers.Sampler sampler)

Sets the Sampler to use.

Note that if no sampler is specified, a DeterministicTraceSampler with a sample rate of 1 (always sample) will be used by default.

Parameters:

sampler - Sampler instance

Returns:

builder

addSpanProcessor

public OpenTelemetryConfiguration.Builder addSpanProcessor(io.opentelemetry.sdk.trace.SpanProcessor spanProcessor)

Configures additional SpanProcessor. BaggageSpanProcessor and BatchSpanProcessor are always configured by default.

Parameters:

spanProcessor - Instance of a SpanProcessor.

Returns:

builder

enableDebug

public OpenTelemetryConfiguration.Builder enableDebug(boolean enabled)

Enables debug mode. When set to true a LoggingSpanExporter is added to the export pipeline that will output traces and metrics data.

Parameters:

enabled - defaults to false

Returns:

Builder

addResourceAttribute

public OpenTelemetryConfiguration.Builder addResourceAttribute(java.lang.String key,
                                                               java.lang.String value)

Add a string attribute as a resource attribute.

Parameters:

key - The key to associate a value with

value - The value to store as an attribute

Returns:

Builder

addResourceAttribute

public OpenTelemetryConfiguration.Builder addResourceAttribute(java.lang.String key,
                                                               long value)

Add a long attribute as a resource attribute.

Parameters:

key - The key to associate a value with

value - The value to store as an attribute

Returns:

Builder

addResourceAttribute

public OpenTelemetryConfiguration.Builder addResourceAttribute(java.lang.String key,
                                                               double value)

Add a double attribute as a resource attribute.

Parameters:

key - The key to associate a value with

value - The value to store as an attribute

Returns:

Builder

addResourceAttribute

public OpenTelemetryConfiguration.Builder addResourceAttribute(java.lang.String key,
                                                               boolean value)

Add a boolean attribute as a resource attribute.

Parameters:

key - The key to associate a value with

value - The value to store as an attribute

Returns:

Builder

addResourceAttribute

public OpenTelemetryConfiguration.Builder addResourceAttribute(java.lang.String key,
                                                               java.lang.String... value)

Add a String array attribute as a resource attribute.

Parameters:

key - The key to associate a value with

value - The value to store as an attribute

Returns:

Builder

setOtlpProtocol

public OpenTelemetryConfiguration.Builder setOtlpProtocol(java.lang.String protocol)

Sets the OTLP procotol used to export trace spans. Can be to either 'grpc' or 'http/protobuf'. Default is grpc.

Parameters:

protocol - The protocol to use to export spans with

Returns:

Builder

buildAndRegisterGlobal

public io.opentelemetry.api.OpenTelemetry buildAndRegisterGlobal()

Returns a new OpenTelemetry built with the configuration of this OpenTelemetryConfiguration.Builder and registers it as the global OpenTelemetry. An exception will be thrown if this method is attempted to be called multiple times in the lifecycle of an application - ensure you have only one SDK for use as the global instance. If you need to configure multiple SDKs for tests, use GlobalOpenTelemetry.resetForTest() between them.

Returns:

OpenTelemetry instance

See Also:

GlobalOpenTelemetry

build

public io.opentelemetry.api.OpenTelemetry build()

Returns a new OpenTelemetry built with the configuration of this OpenTelemetryConfiguration.Builder. This SDK is not registered as the global OpenTelemetry. It is recommended that you register one SDK using buildAndRegisterGlobal() for use by instrumentation that requires access to a global instance of OpenTelemetry.

Note that the OpenTelemetryConfiguration.Builder automatically assigns a SdkTracerProvider with a BatchSpanProcessor that has an OtlpGrpcSpanExporter configured.

Returns:

OpenTelemetry instance

See Also:

GlobalOpenTelemetry