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
use crate::{
    datadog_ids::{self, DatadogId},
    event_sink::{EventSink, StdoutSink},
    fields::{self, FieldPair, FieldStore},
};
use chrono::Utc;
use tracing::{span::Attributes, Event, Id, Subscriber};
use tracing_subscriber::{layer::Context, registry::LookupSpan, Layer};

/// The layer responsible for formatting tracing events in a way datadog can parse them
#[non_exhaustive]
#[derive(Debug, Clone)]
pub struct DatadogFormattingLayer<Sink: EventSink + 'static> {
    event_sink: Sink,
}

impl<S: EventSink + 'static> DatadogFormattingLayer<S> {
    /// Create a new `DatadogFormattingLayer` with the provided event sink
    pub const fn with_sink(sink: S) -> Self {
        Self { event_sink: sink }
    }
}

impl Default for DatadogFormattingLayer<StdoutSink> {
    fn default() -> Self {
        Self::with_sink(StdoutSink::default())
    }
}

impl<S: Subscriber + for<'a> LookupSpan<'a>, Sink: EventSink + 'static> Layer<S>
    for DatadogFormattingLayer<Sink>
{
    fn on_new_span(&self, span_attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>) {
        #[allow(clippy::expect_used)]
        let span = ctx.span(id).expect("Span not found, this is a bug");

        let mut extensions = span.extensions_mut();

        let fields = fields::from_attributes(span_attrs);

        // insert fields from new span e.g #[instrument(fields(hello = "world"))]
        if extensions.get_mut::<FieldStore>().is_none() {
            extensions.insert(FieldStore { fields });
        }
    }

    // IDEA: maybe a on record implementation is required here

    fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
        let event_fields = fields::from_event(event);

        // find message if present in event fields
        let mut message = event_fields
            .iter()
            .find(|pair| pair.name == "message")
            .map(|pair| pair.value.clone())
            .unwrap_or_default();

        let all_fields: Vec<FieldPair> = Vec::default()
            .into_iter()
            .chain(fields::from_spans(&ctx, event))
            .chain(event_fields)
            .collect();

        // serialize the event metadata and fields
        for field in all_fields {
            // message is just a regular field
            if field.name != "message" {
                message.push_str(&format!(
                    " {}={}",
                    field.name,
                    field.value.trim_matches('\"')
                ));
            }
        }

        // look for datadog trace- and span-id
        let datadog_ids = datadog_ids::read_from_context(&ctx);

        // IDEA: maybe loggerName instead of target
        // IDEA: maybe use fields as attributes or something
        let formatted_event = DatadogFormattedEvent {
            timestamp: Utc::now().to_rfc3339(),
            level: event.metadata().level().to_string(),
            message,
            target: event.metadata().target().to_string(),
            datadog_trace_id: datadog_ids.0,
            datadog_span_id: datadog_ids.1,
        };

        let mut serialized_event = serde_json::to_string(&formatted_event)
            .unwrap_or_else(|_| "Failed to serialize an event to json".to_string());

        serialized_event.push('\n');

        self.event_sink.write(serialized_event);
    }
}

#[derive(serde::Serialize)]
#[cfg_attr(test, derive(Debug, serde::Deserialize))]
struct DatadogFormattedEvent {
    timestamp: String,
    level: String,
    message: String,
    target: String,
    #[serde(skip_serializing_if = "Option::is_none", rename = "dd.trace_id")]
    datadog_trace_id: Option<DatadogId>,
    #[serde(skip_serializing_if = "Option::is_none", rename = "dd.span_id")]
    datadog_span_id: Option<DatadogId>,
}

#[cfg(test)]
mod simple {
    use super::setup::{first_span, setup_simple_subscriber};
    use smoothy::assert_that;
    use tracing::{debug, error, info, trace, warn};

    #[test]
    fn single_event() {
        let (sink, _guard) = setup_simple_subscriber();

        info!("Hello World!");

        let events = sink.events();
        assert_that(&events).size().is(1);

        assert_that(events[0].timestamp.is_empty()).is(false);
        assert_that(events[0].level.clone()).equals("INFO");
        assert_that(events[0].message.clone()).equals("Hello World!");
        assert_that(events[0].target.clone()).equals("datadog_formatting_layer::layer::simple");
        assert_that(events[0].datadog_span_id.clone()).is_none();
        assert_that(events[0].datadog_trace_id.clone()).is_none();
    }

    #[test]
    fn events_with_different_level() {
        let (sink, _guard) = setup_simple_subscriber();

        trace!("Trace");
        debug!("Debug");
        info!("Info");
        warn!("Warn");
        error!("Error");

        let events = sink.events();
        assert_that(&events).size().is(5);

        assert_that(events[0].level.clone()).equals("TRACE");
        assert_that(events[1].level.clone()).equals("DEBUG");
        assert_that(events[2].level.clone()).equals("INFO");
        assert_that(events[3].level.clone()).equals("WARN");
        assert_that(events[4].level.clone()).equals("ERROR");
    }

    #[test]
    fn event_with_single_field() {
        let (sink, _guard) = setup_simple_subscriber();

        info!(user = "Kevin", "Hello World!");

        let events = sink.events();
        assert_that(&events).size().is(1);

        assert_that(events[0].message.clone()).equals("Hello World! user=Kevin");
    }

    #[test]
    fn event_with_multiple_fields() {
        let (sink, _guard) = setup_simple_subscriber();

        info!(yaks = 42, yaks_shaved = true, "Shaving");

        let events = sink.events();
        assert_that(&events).size().is(1);

        // Order of fields is not guaranteed
        assert_that(events[0].message.clone())
            .contains("Shaving")
            .and()
            .contains("yaks=42")
            .and()
            .contains("yaks_shaved=true");
    }

    #[test]
    fn spans_with_fields() {
        let (sink, _guard) = setup_simple_subscriber();

        first_span("Argument");

        let events = sink.events();
        assert_that(&events).size().is(3);

        // Order of fields is not guaranteed
        assert_that(events[0].message.clone()).equals("First Span! first_value=Argument");
        assert_that(events[1].message.clone())
            .contains("Second Span!")
            .and()
            .contains("first_value=Argument")
            .and()
            .contains("attr=value");
        assert_that(events[2].message.clone())
            .contains("return=Return Value")
            .and()
            .contains("first_value=Argument")
            .and()
            .contains("attr=value");
    }
}

#[cfg(test)]
mod otel {
    use super::setup::{first_span, setup_otel_subscriber, SmoothyExt};
    use smoothy::assert_that;
    use tracing::{debug, error, info, trace, warn};

    #[test]
    fn single_event() {
        let (sink, _guard) = setup_otel_subscriber();

        info!("Hello World!");

        let events = sink.events();
        assert_that(&events).size().is(1);

        assert_that(events[0].timestamp.is_empty()).is(false);
        assert_that(events[0].level.clone()).equals("INFO");
        assert_that(events[0].message.clone()).equals("Hello World!");
        assert_that(events[0].target.clone()).equals("datadog_formatting_layer::layer::otel");
        assert_that(events[0].datadog_span_id.clone()).is_none();
        assert_that(events[0].datadog_trace_id.clone()).is_none();
    }

    #[test]
    fn events_with_different_level() {
        let (sink, _guard) = setup_otel_subscriber();

        trace!("Trace");
        debug!("Debug");
        info!("Info");
        warn!("Warn");
        error!("Error");

        let events = sink.events();
        assert_that(&events).size().is(5);

        assert_that(events[0].level.clone()).equals("TRACE");
        assert_that(events[1].level.clone()).equals("DEBUG");
        assert_that(events[2].level.clone()).equals("INFO");
        assert_that(events[3].level.clone()).equals("WARN");
        assert_that(events[4].level.clone()).equals("ERROR");
    }

    #[test]
    fn event_with_single_field() {
        let (sink, _guard) = setup_otel_subscriber();

        info!(user = "Kevin", "Hello World!");

        let events = sink.events();
        assert_that(&events).size().is(1);

        assert_that(events[0].message.clone()).equals("Hello World! user=Kevin");
    }

    #[test]
    fn event_with_multiple_fields() {
        let (sink, _guard) = setup_otel_subscriber();

        info!(yaks = 42, yaks_shaved = true, "Shaving");

        let events = sink.events();
        assert_that(&events).size().is(1);

        // Order of fields is not guaranteed
        assert_that(events[0].message.clone())
            .contains("Shaving")
            .and()
            .contains("yaks=42")
            .and()
            .contains("yaks_shaved=true");
    }

    #[test]
    fn spans_with_fields() {
        let (sink, _guard) = setup_otel_subscriber();

        first_span("Argument");

        let events = sink.events();
        assert_that(&events).size().is(3);

        // Order of fields is not guaranteed
        assert_that(events[0].message.clone()).equals("First Span! first_value=Argument");
        assert_that(events[1].message.clone())
            .contains("Second Span!")
            .and()
            .contains("first_value=Argument")
            .and()
            .contains("attr=value");
        assert_that(events[2].message.clone())
            .contains("return=Return Value")
            .and()
            .contains("first_value=Argument")
            .and()
            .contains("attr=value");
    }

    #[test]
    fn events_within_spans_contain_trace_and_span_id() {
        let (sink, _guard) = setup_otel_subscriber();

        first_span("Argument");

        let events = sink.events();
        assert_that(&events).size().is(3);

        let first_span_id = events[0].datadog_span_id.clone().unwrap();
        let first_trace_id = events[0].datadog_trace_id.clone().unwrap();
        let second_span_id = events[1].datadog_span_id.clone().unwrap();
        let second_trace_id = events[1].datadog_trace_id.clone().unwrap();
        let third_span_id = events[2].datadog_span_id.clone().unwrap();
        let third_trace_id = events[2].datadog_trace_id.clone().unwrap();

        assert_that(first_span_id.clone()).is_valid_datadog_id();
        // first event does not have a trace id
        assert_that(first_trace_id.0).is(0);

        assert_that(second_span_id.clone()).is_valid_datadog_id();
        assert_that(second_span_id.0).is_not(first_span_id.0);
        assert_that(second_trace_id.clone()).is_valid_datadog_id();

        assert_that(third_span_id.clone()).is_valid_datadog_id();
        assert_that(third_span_id.0).is_not(first_span_id.0);
        assert_that(third_span_id.0).is(second_span_id.0);
        assert_that(third_trace_id.0).is(second_trace_id.0);
    }
}

#[cfg(test)]
mod setup {
    use super::*;
    use opentelemetry::global;
    use opentelemetry_datadog::ApiVersion;
    use opentelemetry_sdk::{
        propagation::TraceContextPropagator,
        trace::{config, RandomIdGenerator, Sampler},
    };
    use smoothy::BasicAsserter;
    use std::sync::{Arc, Mutex};
    use tracing::{debug, instrument, subscriber::DefaultGuard, warn};
    use tracing_subscriber::prelude::*;

    pub fn setup_simple_subscriber() -> (ObservableSink, DefaultGuard) {
        let sink = ObservableSink::default();

        let subscriber = tracing_subscriber::registry()
            .with(DatadogFormattingLayer::with_sink(sink.clone()))
            .with(tracing_subscriber::fmt::layer());

        let guard = tracing::subscriber::set_default(subscriber);

        (sink, guard)
    }

    pub fn setup_otel_subscriber() -> (ObservableSink, DefaultGuard) {
        let sink = ObservableSink::default();

        // otel boilerplate
        global::set_text_map_propagator(TraceContextPropagator::new());

        let tracer = opentelemetry_datadog::new_pipeline()
            .with_service_name("my-service")
            .with_trace_config(
                config()
                    .with_sampler(Sampler::AlwaysOn)
                    .with_id_generator(RandomIdGenerator::default()),
            )
            .with_api_version(ApiVersion::Version05)
            .with_env("rls")
            .with_version("420")
            .install_simple()
            .unwrap();

        let subscriber = tracing_subscriber::registry()
            .with(DatadogFormattingLayer::with_sink(sink.clone()))
            .with(tracing_opentelemetry::layer().with_tracer(tracer));

        let guard = tracing::subscriber::set_default(subscriber);

        (sink, guard)
    }

    #[derive(Debug, Clone, Default)]
    pub struct ObservableSink {
        events: Arc<Mutex<Vec<String>>>,
    }

    impl EventSink for ObservableSink {
        fn write(&self, event: String) {
            self.events.lock().unwrap().push(event);
        }
    }

    impl ObservableSink {
        pub fn events(&self) -> Vec<DatadogFormattedEvent> {
            let serialized_events = self.events.lock().unwrap().clone();
            serialized_events
                .into_iter()
                .map(|serialized_event| serde_json::from_str(&serialized_event).unwrap())
                .collect()
        }
    }

    #[instrument]
    pub fn first_span(first_value: &str) {
        debug!("First Span!");
        second_span();
    }

    #[instrument(fields(attr = "value"), ret)]
    pub fn second_span() -> String {
        debug!("Second Span!");
        String::from("Return Value")
    }

    pub trait SmoothyExt {
        #[allow(clippy::wrong_self_convention)]
        fn is_valid_datadog_id(self);
    }

    impl SmoothyExt for BasicAsserter<DatadogId> {
        fn is_valid_datadog_id(self) {
            self.is_not(DatadogId(0));
        }
    }
}