S3 Downstream Span Pointers

bottlecap/LICENSE-3rdparty.yml

@@ -40,7 +40,19 @@ third_party_libraries:
   license: 0BSD OR MIT OR Apache-2.0
   licenses:
   - license: 0BSD
-    text: NOT FOUND
+    text: |
+      Copyright (C) Jonas Schievink <[email protected]>
+
+      Permission to use, copy, modify, and/or distribute this software for
+      any purpose with or without fee is hereby granted.
+
+      THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+      WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+      MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+      ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+      WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+      AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+      OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   - license: MIT
     text: |
       Permission is hereby granted, free of charge, to any

bottlecap/src/lifecycle/invocation/processor.rs

@@ -361,6 +361,7 @@ impl Processor {
                 header_tags,
                 vec![traces],
                 body_size,
+                self.inferrer.span_pointers.clone(),
             );
 
             if let Err(e) = trace_agent_tx.send(send_data).await {

bottlecap/src/lifecycle/invocation/span_inferrer.rs

@@ -22,6 +22,7 @@ use crate::lifecycle::invocation::{
         Trigger, FUNCTION_TRIGGER_EVENT_SOURCE_ARN_TAG,
     },
 };
+use crate::traces::span_pointers::SpanPointer;
 use crate::traces::{context::SpanContext, propagation::Propagator};
 
 #[derive(Default)]
@@ -39,6 +40,8 @@ pub struct SpanInferrer {
     generated_span_context: Option<SpanContext>,
     // Tags generated from the trigger
     trigger_tags: Option<HashMap<String, String>>,
+    // Span pointers from S3 or DynamoDB streams
+    pub span_pointers: Option<Vec<SpanPointer>>,
 }
 
 impl SpanInferrer {
@@ -52,6 +55,7 @@ impl SpanInferrer {
             carrier: None,
             generated_span_context: None,
             trigger_tags: None,
+            span_pointers: None,
         }
     }
 
@@ -178,6 +182,7 @@ impl SpanInferrer {
         } else if S3Record::is_match(payload_value) {
             if let Some(t) = S3Record::new(payload_value.clone()) {
                 t.enrich_span(&mut inferred_span, &self.service_mapping);
+                self.span_pointers = t.get_span_pointers();
 
                 trigger = Some(Box::new(t));
             }

bottlecap/src/lifecycle/invocation/triggers/s3_event.rs

@@ -10,6 +10,7 @@ use crate::lifecycle::invocation::{
     processor::MS_TO_NS,
     triggers::{ServiceNameResolver, Trigger, FUNCTION_TRIGGER_EVENT_SOURCE_TAG},
 };
+use crate::traces::span_pointers::{generate_span_pointer_hash, SpanPointer};
 
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
 pub struct S3Event {
@@ -133,6 +134,28 @@ impl ServiceNameResolver for S3Record {
     }
 }
 
+impl S3Record {
+    pub fn get_span_pointers(&self) -> Option<Vec<SpanPointer>> {
+        let bucket_name = &self.s3.bucket.name;
+        let key = &self.s3.object.key;
+        // The AWS SDK sometimes wraps the S3 eTag in quotes, but sometimes doesn't.
+        let e_tag = self.s3.object.e_tag.trim_matches('"');
+
+        if bucket_name.is_empty() || key.is_empty() || e_tag.is_empty() {
+            debug!("Unable to create span pointer because bucket name, key, or etag is missing.");
+            return None;
+        }
+
+        // https://github.com/DataDog/dd-span-pointer-rules/blob/main/AWS/S3/Object/README.md
+        let hash = generate_span_pointer_hash(&[bucket_name, key, e_tag]);
+
+        Some(vec![SpanPointer {
+            hash,
+            kind: String::from("aws.s3.object"),
+        }])
+    }
+}
+
 #[cfg(test)]
 #[allow(clippy::unwrap_used)]
 mod tests {
@@ -274,4 +297,51 @@ mod tests {
             "generic-service"
         );
     }
+
+    #[test]
+    fn test_get_span_pointers() {
+        let event = S3Record {
+            event_source: String::from("aws:s3"),
+            event_time: Utc::now(),
+            event_name: String::from("ObjectCreated:Put"),
+            s3: S3Entity {
+                bucket: S3Bucket {
+                    name: String::from("test-bucket"),
+                    arn: String::from("arn:aws:s3:::test-bucket"),
+                },
+                object: S3Object {
+                    key: String::from("test/key"),
+                    size: 1024,
+                    e_tag: String::from("0123456789abcdef0123456789abcdef"),
+                },
+            },
+        }; //
+
+        let span_pointers = event.get_span_pointers().expect("Should return Some(vec)");
+        assert_eq!(span_pointers.len(), 1);
+        assert_eq!(span_pointers[0].kind, "aws.s3.object");
+        assert_eq!(span_pointers[0].hash, "40df87dbfdf59f32253a2668c23e51b4");
+    }
+
+    #[test]
+    fn test_get_span_pointers_missing_fields() {
+        let event = S3Record {
+            event_source: String::from("aws:s3"),
+            event_time: Utc::now(),
+            event_name: String::from("ObjectCreated:Put"),
+            s3: S3Entity {
+                bucket: S3Bucket {
+                    name: String::new(), // Empty bucket name
+                    arn: String::from("arn"),
+                },
+                object: S3Object {
+                    key: String::from("key"),
+                    size: 0,
+                    e_tag: String::from("etag"),
+                },
+            },
+        };
+
+        assert!(event.get_span_pointers().is_none());
+    }
 }

bottlecap/src/traces/mod.rs

@@ -3,6 +3,7 @@
 
 pub mod context;
 pub mod propagation;
+pub mod span_pointers;
 pub mod stats_flusher;
 pub mod stats_processor;
 pub mod trace_agent;