Skip to content
This repository was archived by the owner on Oct 31, 2024. It is now read-only.

Commit f9a4353

Browse files
author
Amir Blum
committed
docs: update docs for sqs service
1 parent 5b81008 commit f9a4353

File tree

1 file changed

+4
-4
lines changed
  • packages/plugin-aws-sdk/docs

1 file changed

+4
-4
lines changed

packages/plugin-aws-sdk/docs/sqs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ SQS is amazon's managed message queue. Thus, it should follow the [Open Telemetr
55
The following methods are automatically enhanced:
66

77
### sendMessage / sendMessageBatch
8-
- [Message Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#messaging-attributes) are added by this plugin according to the spec.
9-
- TODO: Inject trace context as SQS MessageAttributes, so the service receiving the message can link cascading spans to the trace which created the message.
8+
- [Messaging Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#messaging-attributes) are added by this plugin according to the spec.
9+
- Open Telemetry trace context is injected as SQS MessageAttributes, so the service receiving the message can link cascading spans to the trace which created the message.
1010

1111
### receiveMessage
12-
- [Message Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#messaging-attributes) are added by this plugin according to the spec.
12+
- [Messaging Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/messaging.md#messaging-attributes) are added by this plugin according to the spec.
1313
- Additional "processing spans" are created for each message received by the application.
1414
If an application invoked `receiveMessage`, and received a 10 messages batch, a single `messaging.operation` = `receive` span will be created for the `receiveMessage` operation, and 10 `messaging.operation` = `process` spans will be created, one for each message.
1515
Those processing spans are created by the library. This behavior is partially implemented, [See discussion below](#processing-spans).
1616
- Sets the inter process context correctly, so that additional spans created through the process will be linked to parent spans correctly.
1717
This behavior is partially implemented, [See discussion below](#processing-spans).
18-
- TODO: Extract trace context from SQS MessageAttributes, and set span's `parent` and `links` correctly according to the spec.
18+
- Extract trace context from SQS MessageAttributes, and set span's `parent` and `links` correctly according to the spec.
1919

2020
#### Processing Spans
2121
According to open telemetry specification (and to reasonable expectation for trace structure), user of this library would expect to see one span for the operation of receiving messages batch from SQS, and then, for each message, a span with it's own sub-tree for the processing of this specific message.

0 commit comments

Comments
 (0)