strands-agents 0.1.0

A Rust implementation of the Strands AI Agents SDK
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
//! OpenTelemetry configuration and setup utilities for Strands agents.
//!
//! This module provides centralized configuration and initialization functionality
//! for OpenTelemetry components and other telemetry infrastructure shared across
//! Strands applications.

use opentelemetry::global;
use opentelemetry::trace::TracerProvider;
use opentelemetry_sdk::{
    propagation::TraceContextPropagator,
    trace::SdkTracerProvider,
    Resource,
};

/// Resource information for telemetry.
#[derive(Debug, Clone)]
pub struct OtelResource {
    pub service_name: String,
    pub service_version: String,
    pub sdk_name: String,
    pub sdk_language: String,
}

impl Default for OtelResource {
    fn default() -> Self {
        Self {
            service_name: "strands-agents".to_string(),
            service_version: env!("CARGO_PKG_VERSION").to_string(),
            sdk_name: "opentelemetry".to_string(),
            sdk_language: "rust".to_string(),
        }
    }
}

impl OtelResource {
    pub fn new() -> Self {
        Self::default()
    }

    /// Get resource attributes as a map.
    pub fn attributes(&self) -> std::collections::HashMap<String, String> {
        let mut attrs = std::collections::HashMap::new();
        attrs.insert("service.name".to_string(), self.service_name.clone());
        attrs.insert("service.version".to_string(), self.service_version.clone());
        attrs.insert("telemetry.sdk.name".to_string(), self.sdk_name.clone());
        attrs.insert("telemetry.sdk.language".to_string(), self.sdk_language.clone());
        attrs
    }

    /// Convert to OpenTelemetry SDK Resource.
    fn to_otel_resource(&self) -> Resource {
        Resource::builder()
            .with_service_name(self.service_name.clone())
            .with_attributes([
                opentelemetry::KeyValue::new("service.version", self.service_version.clone()),
                opentelemetry::KeyValue::new("telemetry.sdk.name", self.sdk_name.clone()),
                opentelemetry::KeyValue::new("telemetry.sdk.language", self.sdk_language.clone()),
            ])
            .build()
    }
}

/// OpenTelemetry configuration and setup for Strands applications.
///
/// Automatically initializes a tracer provider with text map propagators.
/// Trace exporters (console, OTLP) can be set up individually using dedicated methods
/// that support method chaining for convenient configuration.
///
/// # Examples
///
/// Quick setup with method chaining:
/// ```ignore
/// StrandsTelemetry::new().setup_console_exporter().setup_otlp_exporter();
/// ```
///
/// Using a custom tracer provider:
/// ```ignore
/// StrandsTelemetry::with_tracer_provider(my_provider).setup_console_exporter();
/// ```
///
/// Step-by-step configuration:
/// ```ignore
/// let telemetry = StrandsTelemetry::new();
/// telemetry.setup_console_exporter();
/// telemetry.setup_otlp_exporter();
/// ```
///
/// To setup global meter provider:
/// ```ignore
/// telemetry.setup_meter(true, true); // enable_console, enable_otlp
/// ```
pub struct StrandsTelemetry {
    pub resource: OtelResource,
    tracer_provider: Option<SdkTracerProvider>,
    console_enabled: bool,
    otlp_enabled: bool,
    meter_enabled: bool,
}

impl Default for StrandsTelemetry {
    fn default() -> Self {
        Self::new()
    }
}

impl StrandsTelemetry {
    /// Create a new StrandsTelemetry instance.
    ///
    /// This initializes a new tracer provider and sets it as the global provider.
    pub fn new() -> Self {
        let mut instance = Self {
            resource: OtelResource::default(),
            tracer_provider: None,
            console_enabled: false,
            otlp_enabled: false,
            meter_enabled: false,
        };
        instance.initialize_tracer();
        instance
    }

    /// Create a new StrandsTelemetry instance with a pre-configured tracer provider.
    pub fn with_tracer_provider(tracer_provider: SdkTracerProvider) -> Self {
        Self {
            resource: OtelResource::default(),
            tracer_provider: Some(tracer_provider),
            console_enabled: false,
            otlp_enabled: false,
            meter_enabled: false,
        }
    }

    /// Initialize the OpenTelemetry tracer.
    fn initialize_tracer(&mut self) {
        tracing::info!("Initializing tracer");

        let resource = self.resource.to_otel_resource();
        let tracer_provider = SdkTracerProvider::builder()
            .with_resource(resource)
            .build();

        global::set_tracer_provider(tracer_provider.clone());

        let propagator = TraceContextPropagator::new();
        global::set_text_map_propagator(propagator);

        self.tracer_provider = Some(tracer_provider);
    }

    /// Set up console exporter for traces.
    ///
    /// This method configures a SimpleSpanProcessor with a ConsoleSpanExporter,
    /// allowing trace data to be output to the console.
    #[cfg(feature = "otel-stdout")]
    pub fn setup_console_exporter(mut self) -> Self {
        use opentelemetry_stdout::SpanExporter as StdoutSpanExporter;

        tracing::info!("Enabling console export");
        self.console_enabled = true;

        let exporter = StdoutSpanExporter::default();
        let new_provider = SdkTracerProvider::builder()
            .with_simple_exporter(exporter)
            .with_resource(self.resource.to_otel_resource())
            .build();

        global::set_tracer_provider(new_provider.clone());
        self.tracer_provider = Some(new_provider);

        self
    }

    /// Set up console exporter for traces (no-op when feature not enabled).
    #[cfg(not(feature = "otel-stdout"))]
    pub fn setup_console_exporter(mut self) -> Self {
        tracing::warn!("otel-stdout feature not enabled, console exporter not available");
        self.console_enabled = false;
        self
    }

    /// Set up OTLP exporter for traces.
    ///
    /// This method configures a BatchSpanProcessor with an OTLPSpanExporter,
    /// allowing trace data to be exported to an OTLP endpoint.
    #[cfg(feature = "otel-otlp")]
    pub fn setup_otlp_exporter(mut self) -> Self {
        use opentelemetry_otlp::SpanExporter;

        tracing::info!("Enabling OTLP export");
        self.otlp_enabled = true;

        match SpanExporter::builder().with_tonic().build() {
            Ok(exporter) => {
                let new_provider = SdkTracerProvider::builder()
                    .with_batch_exporter(exporter)
                    .with_resource(self.resource.to_otel_resource())
                    .build();

                global::set_tracer_provider(new_provider.clone());
                self.tracer_provider = Some(new_provider);
                tracing::info!("OTLP exporter configured");
            }
            Err(e) => {
                tracing::error!("error=<{}> | Failed to configure OTLP exporter", e);
            }
        }

        self
    }

    /// Set up OTLP exporter for traces (no-op when feature not enabled).
    #[cfg(not(feature = "otel-otlp"))]
    pub fn setup_otlp_exporter(mut self) -> Self {
        tracing::warn!("otel-otlp feature not enabled, OTLP exporter not available");
        self.otlp_enabled = false;
        self
    }

    /// Set up the meter provider for metrics.
    #[cfg(all(feature = "otel-stdout", feature = "otel-otlp"))]
    pub fn setup_meter(mut self, enable_console: bool, enable_otlp: bool) -> Self {
        use opentelemetry_sdk::metrics::SdkMeterProvider;

        tracing::info!("Initializing meter");
        self.meter_enabled = true;

        let resource = self.resource.to_otel_resource();
        let mut builder = SdkMeterProvider::builder().with_resource(resource);

        if enable_console {
            tracing::info!("Enabling console metrics exporter");
            let exporter = opentelemetry_stdout::MetricExporter::default();
            builder = builder.with_periodic_exporter(exporter);
        }

        if enable_otlp {
            tracing::info!("Enabling OTLP metrics exporter");
            match opentelemetry_otlp::MetricExporter::builder()
                .with_tonic()
                .build()
            {
                Ok(exporter) => {
                    builder = builder.with_periodic_exporter(exporter);
                }
                Err(e) => {
                    tracing::error!("error=<{}> | Failed to configure OTLP metrics exporter", e);
                }
            }
        }

        let meter_provider = builder.build();
        opentelemetry::global::set_meter_provider(meter_provider);
        tracing::info!("Strands Meter configured");

        self
    }

    /// Set up the meter provider for metrics (console only).
    #[cfg(all(feature = "otel-stdout", not(feature = "otel-otlp")))]
    pub fn setup_meter(mut self, enable_console: bool, _enable_otlp: bool) -> Self {
        use opentelemetry_sdk::metrics::SdkMeterProvider;

        tracing::info!("Initializing meter");
        self.meter_enabled = true;

        let resource = self.resource.to_otel_resource();
        let mut builder = SdkMeterProvider::builder().with_resource(resource);

        if enable_console {
            tracing::info!("Enabling console metrics exporter");
            let exporter = opentelemetry_stdout::MetricExporter::default();
            builder = builder.with_periodic_exporter(exporter);
        }

        let meter_provider = builder.build();
        opentelemetry::global::set_meter_provider(meter_provider);
        tracing::info!("Strands Meter configured");

        self
    }

    /// Set up the meter provider for metrics (OTLP only).
    #[cfg(all(not(feature = "otel-stdout"), feature = "otel-otlp"))]
    pub fn setup_meter(mut self, _enable_console: bool, enable_otlp: bool) -> Self {
        use opentelemetry_sdk::metrics::SdkMeterProvider;

        tracing::info!("Initializing meter");
        self.meter_enabled = true;

        let resource = self.resource.to_otel_resource();
        let mut builder = SdkMeterProvider::builder().with_resource(resource);

        if enable_otlp {
            tracing::info!("Enabling OTLP metrics exporter");
            match opentelemetry_otlp::MetricExporter::builder()
                .with_tonic()
                .build()
            {
                Ok(exporter) => {
                    builder = builder.with_periodic_exporter(exporter);
                }
                Err(e) => {
                    tracing::error!("error=<{}> | Failed to configure OTLP metrics exporter", e);
                }
            }
        }

        let meter_provider = builder.build();
        opentelemetry::global::set_meter_provider(meter_provider);
        tracing::info!("Strands Meter configured");

        self
    }

    /// Set up the meter provider for metrics (no-op when features not enabled).
    #[cfg(not(any(feature = "otel-stdout", feature = "otel-otlp")))]
    pub fn setup_meter(mut self, _enable_console: bool, _enable_otlp: bool) -> Self {
        tracing::warn!("Neither otel-stdout nor otel-otlp features enabled, meter not available");
        self.meter_enabled = false;
        self
    }

    /// Check if console exporter is enabled.
    pub fn is_console_enabled(&self) -> bool {
        self.console_enabled
    }

    /// Check if OTLP exporter is enabled.
    pub fn is_otlp_enabled(&self) -> bool {
        self.otlp_enabled
    }

    /// Check if meter is enabled.
    pub fn is_meter_enabled(&self) -> bool {
        self.meter_enabled
    }

    /// Get the resource.
    pub fn resource(&self) -> &OtelResource {
        &self.resource
    }

    /// Get the tracer provider.
    pub fn tracer_provider(&self) -> Option<&SdkTracerProvider> {
        self.tracer_provider.as_ref()
    }

    /// Get a tracer from the provider.
    pub fn tracer(&self, name: &'static str) -> Option<opentelemetry_sdk::trace::Tracer> {
        self.tracer_provider.as_ref().map(|p| p.tracer(name))
    }
}

/// Builder for StrandsTelemetry.
pub struct StrandsTelemetryBuilder {
    resource: OtelResource,
    enable_console: bool,
    enable_otlp: bool,
    enable_console_metrics: bool,
    enable_otlp_metrics: bool,
}

impl Default for StrandsTelemetryBuilder {
    fn default() -> Self {
        Self::new()
    }
}

impl StrandsTelemetryBuilder {
    pub fn new() -> Self {
        Self {
            resource: OtelResource::default(),
            enable_console: false,
            enable_otlp: false,
            enable_console_metrics: false,
            enable_otlp_metrics: false,
        }
    }

    pub fn with_resource(mut self, resource: OtelResource) -> Self {
        self.resource = resource;
        self
    }

    pub fn with_console_exporter(mut self) -> Self {
        self.enable_console = true;
        self
    }

    pub fn with_otlp_exporter(mut self) -> Self {
        self.enable_otlp = true;
        self
    }

    pub fn with_console_metrics(mut self) -> Self {
        self.enable_console_metrics = true;
        self
    }

    pub fn with_otlp_metrics(mut self) -> Self {
        self.enable_otlp_metrics = true;
        self
    }

    pub fn build(self) -> StrandsTelemetry {
        let mut telemetry = StrandsTelemetry {
            resource: self.resource,
            tracer_provider: None,
            console_enabled: false,
            otlp_enabled: false,
            meter_enabled: false,
        };

        telemetry.initialize_tracer();

        if self.enable_console {
            telemetry = telemetry.setup_console_exporter();
        }
        if self.enable_otlp {
            telemetry = telemetry.setup_otlp_exporter();
        }
        if self.enable_console_metrics || self.enable_otlp_metrics {
            telemetry = telemetry.setup_meter(self.enable_console_metrics, self.enable_otlp_metrics);
        }

        telemetry
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_otel_resource_default() {
        let resource = OtelResource::default();
        assert_eq!(resource.service_name, "strands-agents");
        assert_eq!(resource.sdk_language, "rust");
    }

    #[test]
    fn test_otel_resource_attributes() {
        let resource = OtelResource::default();
        let attrs = resource.attributes();
        assert!(attrs.contains_key("service.name"));
        assert!(attrs.contains_key("telemetry.sdk.language"));
    }

    #[test]
    fn test_strands_telemetry_builder() {
        let telemetry = StrandsTelemetryBuilder::new()
            .with_console_exporter()
            .build();
        
        assert!(telemetry.tracer_provider().is_some());
    }

    #[test]
    fn test_strands_telemetry_new() {
        let telemetry = StrandsTelemetry::new();
        assert!(telemetry.tracer_provider().is_some());
        assert!(!telemetry.is_console_enabled());
        assert!(!telemetry.is_otlp_enabled());
    }

    #[test]
    fn test_strands_telemetry_chaining() {
        let telemetry = StrandsTelemetry::new()
            .setup_console_exporter();
        
        assert!(telemetry.tracer_provider().is_some());
    }

    #[tokio::test]
    #[cfg(feature = "otel-otlp")]
    async fn test_strands_telemetry_otlp() {
        let telemetry = StrandsTelemetry::new()
            .setup_otlp_exporter();
        
        assert!(telemetry.tracer_provider().is_some());
    }
}