awssdk-instrumentation 0.2.0

Out-of-the-box OpenTelemetry/X-Ray instrumentation for the AWS SDK for Rust, with first-class support for AWS Lambda
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

//! OTel [`Resource`] detection for AWS environments.
//!
//! The central entry point is [`default_resource()`], which probes the runtime
//! environment and returns a [`Resource`] populated with OTel semantic-convention
//! attributes. Detection is attempted in priority order:
//!
//! 1. **Lambda** (`env-lambda`) — checks `AWS_LAMBDA_FUNCTION_NAME`
//! 2. **ECS** (`env-ecs`) — checks `ECS_CONTAINER_METADATA_URI_V4`
//! 3. **EKS** (`env-eks`) — checks for the Kubernetes service-account mount
//! 4. **EC2** (`env-ec2`) — queries IMDSv2 for the instance ID
//!
//! The first detector that succeeds wins. If none match, a minimal resource
//! with `cloud.provider = "aws"` is returned.
//!
//! Each detector is in its own feature-gated sub-module. You can call the
//! per-environment functions directly if you need to bypass the auto-detection
//! logic.
//!
//! [`Resource`]: opentelemetry_sdk::Resource

// Environment resource detection — common types and feature-gated detectors.

use opentelemetry::KeyValue;
use opentelemetry_sdk::Resource;
use opentelemetry_semantic_conventions::attribute as semco;

#[cfg(feature = "env-lambda")]
pub mod lambda;

#[cfg(feature = "env-ecs")]
pub mod ecs;

#[cfg(feature = "env-eks")]
pub mod eks;

#[cfg(feature = "env-ec2")]
pub mod ec2;

#[cfg(any(feature = "env-ec2", feature = "env-eks"))]
mod imds;

/// Auto-detects the AWS runtime environment and returns an OTel [`Resource`].
///
/// Detection is attempted in priority order, stopping at the first success:
///
/// 1. **Lambda** (`env-lambda`) — checks `AWS_LAMBDA_FUNCTION_NAME`; calls
///    [`lambda::lambda_resource`].
/// 2. **ECS** (`env-ecs`) — checks `ECS_CONTAINER_METADATA_URI_V4`; calls
///    [`ecs::ecs_resource`].
/// 3. **EKS** (`env-eks`) — checks for the Kubernetes service-account mount;
///    calls [`eks::eks_resource`].
/// 4. **EC2** (`env-ec2`) — queries IMDSv2; calls [`ec2::ec2_resource`].
///
/// If no detector succeeds (or no environment feature is enabled), a minimal
/// resource with `cloud.provider = "aws"` is returned.
///
/// This function is called automatically by [`crate::init::default_tracer_provider`].
/// Call it directly only when you need to compose a custom [`SdkTracerProvider`].
///
/// # Examples
///
/// ```no_run
/// use awssdk_instrumentation::env::default_resource;
/// use opentelemetry_sdk::trace::SdkTracerProvider;
///
/// let resource = default_resource();
/// let provider = SdkTracerProvider::builder()
///     .with_resource(resource)
///     .build();
/// ```
///
/// [`Resource`]: opentelemetry_sdk::Resource
/// [`SdkTracerProvider`]: opentelemetry_sdk::trace::SdkTracerProvider
pub fn default_resource() -> Resource {
    #[cfg(feature = "env-lambda")]
    if let Some(resource) = lambda::lambda_resource(false) {
        return resource;
    }

    #[cfg(feature = "env-ecs")]
    if let Some(resource) = ecs::ecs_resource() {
        return resource;
    }

    #[cfg(feature = "env-eks")]
    if let Some(resource) = eks::eks_resource() {
        return resource;
    }

    #[cfg(feature = "env-ec2")]
    if let Some(resource) = ec2::ec2_resource() {
        return resource;
    }

    // Fallback: no env feature enabled or detection failed
    Resource::builder()
        .with_attributes([KeyValue::new(semco::CLOUD_PROVIDER, "aws")])
        .build()
}