Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(aws-sdk): sns-sqs extract the correct context key from message payload #761

Merged
merged 17 commits into from
Nov 30, 2021
Merged

fix(aws-sdk): sns-sqs extract the correct context key from message payload #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
c7d4d9d
adding sns content propagation
habmic Nov 4, 2021
e27cfd9
adding tests
habmic Nov 7, 2021
fb39de6
merge
habmic Nov 7, 2021
c338000
merge main
habmic Nov 7, 2021
da45517
sns-context-propagation
habmic Nov 7, 2021
9bef9cf
fix merge
habmic Nov 7, 2021
123023f
lint:fix
habmic Nov 7, 2021
3bacb1c
adding docs and some fixes
habmic Nov 7, 2021
ec13519
fix capital letter
habmic Nov 7, 2021
0d977fc
Update instrumentation docs
habmic Nov 7, 2021
5ffc4cb
Merge branch 'main' into main
habmic Nov 9, 2021
b4e9063
Merge branch 'open-telemetry:main' into main
habmic Nov 14, 2021
5dda537
Merge branch 'open-telemetry:main' into main
habmic Nov 28, 2021
52753a3
fix: context propagation sns to sqs
habmic Nov 28, 2021
963a82c
fix: ts types
habmic Nov 28, 2021
294fd37
fix: lint
habmic Nov 28, 2021
e295fe3
test: StringValue to Value
habmic Nov 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/MessageAttributes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import {
diag,
} from '@opentelemetry/api';
import type { SQS, SNS } from 'aws-sdk';
import type { MessageBodyAttributeMap } from 'aws-sdk/clients/sqs';

// https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html
export const MAX_MESSAGE_ATTRIBUTES = 10;
Expand All @@ -42,6 +41,13 @@ class ContextSetter
}
export const contextSetter = new ContextSetter();

export interface AwsSdkContextObject {
[key: string]: {
StringValue?: string;
Value?: string;
};
}

class ContextGetter
implements
TextMapGetter<SQS.MessageBodyAttributeMap | SNS.MessageAttributeMap>
Expand All @@ -53,10 +59,10 @@ class ContextGetter
}

get(
carrier: SQS.MessageBodyAttributeMap | SNS.MessageAttributeMap,
carrier: AwsSdkContextObject,
key: string
): undefined | string | string[] {
return carrier?.[key]?.StringValue;
return carrier?.[key]?.StringValue || carrier?.[key]?.Value;
}
}
export const contextGetter = new ContextGetter();
Expand All @@ -78,7 +84,7 @@ export const injectPropagationContext = (
export const extractPropagationContext = (
message: SQS.Message,
sqsExtractContextPropagationFromPayload: boolean | undefined
): MessageBodyAttributeMap | undefined => {
): AwsSdkContextObject | undefined => {
const propagationFields = propagation.fields();
const hasPropagationFields = Object.keys(
message.MessageAttributes || []
Expand Down
6 changes: 2 additions & 4 deletions plugins/node/opentelemetry-instrumentation-aws-sdk/test/sqs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,9 +458,8 @@ describe('SQS', () => {
it('should extract from payload', async () => {
const traceparent = {
traceparent: {
StringValue:
'00-a1d050b7c8ad93c405e7a0d94cda5b03-23a485dc98b24027-01',
DataType: 'String',
Value: '00-a1d050b7c8ad93c405e7a0d94cda5b03-23a485dc98b24027-01',
Type: 'String',
},
};
instrumentation.setConfig({
Expand All @@ -478,7 +477,6 @@ describe('SQS', () => {
QueueUrl: 'queue/url/for/unittests',
})
.promise();

expect(extractContextSpy.returnValues[0]?.traceparent).toStrictEqual(
traceparent
);
Expand Down