Add S3 Downstream Span Pointers #587
Conversation
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
src/utils/span-pointers.ts
Outdated
| * @param {any} event - The event object containing source-specific data. | ||
| * @returns {SpanPointerAttributes[] | undefined} An array of span pointer attribute objects, or undefined if none could be computed. | ||
| */ | ||
| export function getSpanPointerAttributes(eventSource: eventTypes | undefined, event: any): SpanPointerAttributes[] | undefined { |
There was a problem hiding this comment.
⚪ Code Quality Violation
Unexpected any. Specify a different type. (...read more)
Do not use the any type, as it is too broad and can lead to unexpected behavior.
| } | ||
| } | ||
|
|
||
| function processS3Event(event: any): SpanPointerAttributes[] { |
There was a problem hiding this comment.
⚪ Code Quality Violation
Unexpected any. Specify a different type. (...read more)
Do not use the any type, as it is too broad and can lead to unexpected behavior.
| @@ -323,9 +323,8 @@ function extractHTTPTags(event: APIGatewayEvent | APIGatewayProxyEventV2 | ALBEv | |||
| /** | |||
| * extractTriggerTags parses the trigger event object for tags to be added to the span metadata | |||
| */ | |||
| export function extractTriggerTags(event: any, context: Context) { | |||
| export function extractTriggerTags(event: any, context: Context, eventSource: eventTypes | undefined) { | |||
There was a problem hiding this comment.
⚪ Code Quality Violation
Unexpected any. Specify a different type. (...read more)
Do not use the any type, as it is too broad and can lead to unexpected behavior.
nhulston
force-pushed
the
nicholas.hulston/s3-span-pointers
branch
from
d0a666e
to
c8aa5a8
Compare
| */ | ||
| export function getSpanPointerAttributes( | ||
| eventSource: eventTypes | undefined, | ||
| event: any, |
There was a problem hiding this comment.
⚪ Code Quality Violation
Unexpected any. Specify a different type. (...read more)
Do not use the any type, as it is too broad and can lead to unexpected behavior.
nhulston
force-pushed
the
nicholas.hulston/s3-span-pointers
branch
from
c8aa5a8
to
a3b587b
Compare
|
|
||
| for (const record of records) { | ||
| const eventName = record.eventName; | ||
| if (!["ObjectCreated:Put", "ObjectCreated:Copy", "ObjectCreated:CompleteMultipartUpload"].includes(eventName)) { |
There was a problem hiding this comment.
why restrict us to only these particular object created types instead of ObjectCreated:*?
There was a problem hiding this comment.
We only support creating span pointers for these three operations on the upstream case. I guess it doesn't hurt to create span pointers downstream in other cases; we could change the check to
if (!eventName.startsWith("ObjectCreated"))
src/utils/span-pointers.ts
Outdated
| eventSource: eventTypes | undefined, | ||
| event: any, | ||
| ): SpanPointerAttributes[] | undefined { | ||
| console.log('[LIBRARY] getSpanPointerAttributes(): ', eventSource) |
There was a problem hiding this comment.
🟠 Code Quality Violation
Unexpected console statement. (...read more)
Debugging with console is not considered a bad practice, but it's easy to forget about console statements and leave them in production code. There is no need to pollute production builds with debugging statements.
src/trace/listener.ts
Outdated
| this.stepFunctionContext = StepFunctionContextService.instance().context; | ||
|
|
||
| console.log('[LIBRARY] Getting span pointer attributes') |
There was a problem hiding this comment.
🟠 Code Quality Violation
Unexpected console statement. (...read more)
Debugging with console is not considered a bad practice, but it's easy to forget about console statements and leave them in production code. There is no need to pollute production builds with debugging statements.
src/trace/listener.ts
Outdated
|
|
||
| if (this.wrappedCurrentSpan) { | ||
| for (const attributes of this.spanPointerAttributesList) { | ||
| console.log('[LIBRARY] Adding attributes:', attributes) |
There was a problem hiding this comment.
🟠 Code Quality Violation
Unexpected console statement. (...read more)
Debugging with console is not considered a bad practice, but it's easy to forget about console statements and leave them in production code. There is no need to pollute production builds with debugging statements.
src/trace/listener.ts
Outdated
|
|
||
| console.log('[LIBRARY] Getting span pointer attributes') | ||
| const result = getSpanPointerAttributes(eventSource, event); | ||
| console.log('[LIBRARY] result:', result) |
There was a problem hiding this comment.
🟠 Code Quality Violation
Unexpected console statement. (...read more)
Debugging with console is not considered a bad practice, but it's easy to forget about console statements and leave them in production code. There is no need to pollute production builds with debugging statements.
nhulston
force-pushed
the
nicholas.hulston/s3-span-pointers
branch
from
c9e623b
to
ea5594b
Compare
What does this PR do?
Tests will fail until my changes in DataDog/dd-trace-js#4875 are out.
Adds span pointers to spans for Lambdas triggered by
putObject,copyObject, andcompleteMultipartUploadevents.Span pointers are similar to Span Links, but for cases when it is impossible to pass the Trace ID and Span ID between the spans that need to be linked.
When the calculated hashes for the upstream and downstream lambdas match, the Datadog backend will automatically link the two traces together.
Motivation
This feature already exists in Python, and I'm working on adding it to all other runtimes (Node, .NET, Java, Golang).
Testing Guidelines
Run this Lambda function with the event payload
{ "shouldPutObject": false, "shouldCopyObject": false, "shouldMultipartUpload": false, "useV2": true }and change one of the bools to true. Also, try both with AWS SDK v2 and v3. Enable the span pointers feature flag, and check Datadog to ensure that the spans are properly linked.
Additional Notes
Types of Changes
Check all that apply