Struct OpenTelemetryPlugin 

pub struct OpenTelemetryPlugin { /* private fields */ }

OpenTelemetry tracing plugin.

Sets up OTLP trace export via tracing-opentelemetry. All tracing spans in the application are exported as OpenTelemetry traces.

Depends on TracingPlugin which owns the subscriber.

Lifecycle

• build() — builds the OTLP exporter and tracer, and pushes the OTel layer into TracingLayersApi.
• cleanup() — shuts down the tracer provider, flushing pending spans.

Example

use polaris_core_plugins::OpenTelemetryPlugin;

OpenTelemetryPlugin::new("http://localhost:4318/v1/traces")
    .with_service_name("my-agent")
    .with_env_filter("polaris=debug,hyper=warn")
    .with_resource_attribute("deployment.environment.name", "production")
    .with_export_header("x-api-key", api_key);

Implementations

impl OpenTelemetryPlugin

pub fn new(endpoint: impl Into<String>) -> OpenTelemetryPlugin

Creates a new plugin targeting the given OTLP HTTP endpoint.

Arguments

• endpoint - OTLP HTTP endpoint

pub fn with_service_name(self, name: impl Into<String>) -> OpenTelemetryPlugin

Sets the service name reported in traces.

pub fn with_env_filter(self, filter: impl Into<String>) -> OpenTelemetryPlugin

Sets a custom environment filter for OTel span export.

Format: target=level,target=level,...

pub fn with_resource_attribute( self, key: impl Into<String>, value: impl Into<String>, ) -> OpenTelemetryPlugin

Adds an OTel resource attribute to the trace provider.

Resource attributes identify the entity producing telemetry (e.g., deployment environment, service version, host).

use polaris_core_plugins::OpenTelemetryPlugin;

OpenTelemetryPlugin::new("http://localhost:4318/v1/traces")
    .with_resource_attribute("deployment.environment.name", "production")
    .with_resource_attribute("service.version", "1.2.0");

pub fn with_export_header( self, key: impl Into<String>, value: impl Into<String>, ) -> OpenTelemetryPlugin

Adds an HTTP header to OTLP export requests.

use polaris_core_plugins::OpenTelemetryPlugin;

OpenTelemetryPlugin::new("https://api.honeycomb.io/v1/traces")
    .with_export_header("x-api-key", api_key);

Trait Implementations

impl Plugin for OpenTelemetryPlugin

const ID: &'static str = "polaris::otel"

Stable, unique identifier for this plugin type.

const VERSION: Version

Semantic version of this plugin.

fn build(&self, server: &mut Server)

Configures the server. Called once when the plugin is added.

async fn ready(&self, _server: &mut Server)

Called after all plugins have been built and the server is ready to run.

async fn cleanup(&self, _server: &mut Server)

Called when the server is shutting down.

fn dependencies(&self) -> Vec<PluginId>

Declares plugins that must be added before this one.

fn update(&self, _server: &mut Server, _schedule: ScheduleId)

Called when a schedule this plugin registered for is triggered.

fn tick_schedules(&self) -> Vec<ScheduleId>

Declares which schedules this plugin wants to receive updates on.