relay_event_schema/protocol/contexts/
otel.rs

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
use relay_protocol::{Annotated, Empty, FromValue, IntoValue, Object, Value};

use crate::processor::ProcessValue;

/// OpenTelemetry Context
///
/// If an event has this context, it was generated from an OpenTelemetry signal (trace, metric, log).
#[derive(Clone, Debug, Default, PartialEq, Empty, FromValue, IntoValue, ProcessValue)]
pub struct OtelContext {
    /// Attributes of the OpenTelemetry span that maps to a Sentry event.
    ///
    /// <https://github.com/open-telemetry/opentelemetry-proto/blob/724e427879e3d2bae2edc0218fff06e37b9eb46e/opentelemetry/proto/trace/v1/trace.proto#L174-L186>
    #[metastructure(pii = "maybe", max_depth = 7, max_bytes = 8192)]
    attributes: Annotated<Object<Value>>,

    /// Information about an OpenTelemetry resource.
    ///
    /// <https://github.com/open-telemetry/opentelemetry-proto/blob/724e427879e3d2bae2edc0218fff06e37b9eb46e/opentelemetry/proto/resource/v1/resource.proto>
    #[metastructure(pii = "maybe", max_depth = 7, max_bytes = 8192)]
    resource: Annotated<Object<Value>>,

    /// Additional arbitrary fields for forwards compatibility.
    #[metastructure(additional_properties, retain = true, pii = "maybe")]
    pub other: Object<Value>,
}

impl super::DefaultContext for OtelContext {
    fn default_key() -> &'static str {
        "otel"
    }

    fn from_context(context: super::Context) -> Option<Self> {
        match context {
            super::Context::Otel(c) => Some(*c),
            _ => None,
        }
    }

    fn cast(context: &super::Context) -> Option<&Self> {
        match context {
            super::Context::Otel(c) => Some(c),
            _ => None,
        }
    }

    fn cast_mut(context: &mut super::Context) -> Option<&mut Self> {
        match context {
            super::Context::Otel(c) => Some(c),
            _ => None,
        }
    }

    fn into_context(self) -> super::Context {
        super::Context::Otel(Box::new(self))
    }
}

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

    #[test]
    fn test_otel_context_roundtrip() {
        let json = r#"{
  "attributes": {
    "app.payment.amount": 394.25,
    "rpc.grpc.status_code": "1",
    "rpc.method": "Charge",
    "rpc.service": "hipstershop.PaymentService",
    "rpc.system": "grpc"
  },
  "resource": {
    "process.command": "/usr/src/app/index.js",
    "process.command_line": "/usr/local/bin/node /usr/src/app/index.js",
    "process.executable.name": "node",
    "process.pid": 1,
    "process.runtime.description": "Node.js",
    "process.runtime.name": "nodejs",
    "process.runtime.version": "16.18.0",
    "service.name": "paymentservice",
    "telemetry.sdk.language": "nodejs",
    "telemetry.sdk.name": "opentelemetry",
    "telemetry.sdk.version": "1.7.0"
  },
  "other": "value",
  "type": "otel"
}"#;
        let context = Annotated::new(Context::Otel(Box::new(OtelContext {
            attributes: Annotated::new(Object::from([
                (
                    "app.payment.amount".to_string(),
                    Annotated::new(Value::F64(394.25)),
                ),
                (
                    "rpc.grpc.status_code".to_string(),
                    Annotated::new(Value::String("1".to_string())),
                ),
                (
                    "rpc.method".to_string(),
                    Annotated::new(Value::String("Charge".to_string())),
                ),
                (
                    "rpc.service".to_string(),
                    Annotated::new(Value::String("hipstershop.PaymentService".to_string())),
                ),
                (
                    "rpc.system".to_string(),
                    Annotated::new(Value::String("grpc".to_string())),
                ),
            ])),
            resource: Annotated::new(Object::from([
                (
                    "process.command".to_string(),
                    Annotated::new(Value::String("/usr/src/app/index.js".to_string())),
                ),
                (
                    "process.command_line".to_string(),
                    Annotated::new(Value::String(
                        "/usr/local/bin/node /usr/src/app/index.js".to_string(),
                    )),
                ),
                (
                    "process.executable.name".to_string(),
                    Annotated::new(Value::String("node".to_string())),
                ),
                ("process.pid".to_string(), Annotated::new(Value::I64(1))),
                (
                    "process.runtime.description".to_string(),
                    Annotated::new(Value::String("Node.js".to_string())),
                ),
                (
                    "process.runtime.name".to_string(),
                    Annotated::new(Value::String("nodejs".to_string())),
                ),
                (
                    "process.runtime.version".to_string(),
                    Annotated::new(Value::String("16.18.0".to_string())),
                ),
                (
                    "service.name".to_string(),
                    Annotated::new(Value::String("paymentservice".to_string())),
                ),
                (
                    "telemetry.sdk.language".to_string(),
                    Annotated::new(Value::String("nodejs".to_string())),
                ),
                (
                    "telemetry.sdk.name".to_string(),
                    Annotated::new(Value::String("opentelemetry".to_string())),
                ),
                (
                    "telemetry.sdk.version".to_string(),
                    Annotated::new(Value::String("1.7.0".to_string())),
                ),
            ])),
            other: {
                let mut map = Object::new();
                map.insert(
                    "other".to_string(),
                    Annotated::new(Value::String("value".to_string())),
                );
                map
            },
        })));

        assert_eq!(context, Annotated::from_json(json).unwrap());
        assert_eq!(json, context.to_json_pretty().unwrap());
    }
}