agents-features-opentelemetry/ai.koog.agents.features.opentelemetry.feature/OpenTelemetryConfig

OpenTelemetryConfig

class OpenTelemetryConfig : FeatureConfig(source)

Configuration class for OpenTelemetry integration.

Provides seamless integration with the OpenTelemetry SDK, allowing initialization and customization of various components such as the tracer, meter, exporters, etc.

Constructors

OpenTelemetryConfig

constructor()

Properties

isVerbose

val isVerbose: Boolean

Indicates whether verbose telemetry data is enabled.

messageProcessor

val messageProcessor: List<FeatureMessageProcessor>

sdk

val sdk: OpenTelemetrySdk

Provides an instance of the OpenTelemetrySdk.

serviceName

val serviceName: String

The name of the service associated with this OpenTelemetry configuration.

serviceVersion

val serviceVersion: String

The version of the service used in the OpenTelemetry configuration.

tracer

val tracer: Tracer

Provides access to the Tracer instance for tracking and recording tracing data.

Functions

addMessageProcessor

fun addMessageProcessor(processor: FeatureMessageProcessor)

addResourceAttributes

fun <T : Any> addResourceAttributes(attributes: Map<AttributeKey<T>, T>)

Adds resource attributes to the OpenTelemetry configuration. Resource attributes are key-value pairs that provide metadata describing the entity producing telemetry data.

addSpanExporter

fun addSpanExporter(exporter: SpanExporter)

Adds a SpanExporter to the OpenTelemetry configuration. This exporter will be used to export spans collected during the application's execution.

addSpanProcessor

fun addSpanProcessor(processor: (SpanExporter) -> SpanProcessor)

Adds a SpanProcessor creator function to the OpenTelemetry configuration.

setSampler

fun setSampler(sampler: Sampler)

Sets the sampler to be used by the OpenTelemetry configuration. The sampler determines which spans are sampled and exported during application execution.

setServiceInfo

fun setServiceInfo(serviceName: String, serviceVersion: String)

Sets the service information for the OpenTelemetry configuration. This information is used to identify the service in telemetry data.

setVerbose

fun setVerbose(verbose: Boolean)

Controls whether verbose telemetry data should be captured during application execution. When set to true, the application collects more detailed telemetry data. This option can be useful for debugging and fine-grained monitoring but may impact performance.