opentelemetry-trace-sqs propagates Open Telemetry tracing with SQS messages for the Go language. Injecting with SNS Publish is also supported since SNS-to-SQS fanout is a common case.
Use SqsCarrierAttributes.Extract() to extract trace context from SQS message.
import (
"github.com/aws/aws-sdk-go-v2/service/sqs/types"
"github.com/udhos/opentelemetry-trace-sqs/otelsqs"
)
// handleSQSMessage is an example function that uses SqsCarrierAttributes.Extract to
// extract tracing context from inbound SQS message.
func handleSQSMessage(app *application, inboundSqsMessage types.Message) {
// Extract the tracing context from a received SQS message
ctx := otelsqs.NewCarrier().Extract(context.Background(), inboundSqsMessage.MessageAttributes)
// Use the trace context as usual, for instance, starting a new span
ctxNew, span := app.tracer.Start(ctx, "handleSQSMessage")
defer span.End()
// One could log the traceID
log.Printf("handleSQSMessage: traceID=%s", span.SpanContext().TraceID().String())
// Now handle the SQS messageUse SqsCarrierAttributes.Inject() to inject trace context into SQS message before sending it.
import (
"github.com/aws/aws-sdk-go-v2/service/sqs/types"
"github.com/udhos/opentelemetry-trace-sqs/otelsqs"
)
// sendSQSMessage is an example function that uses SqsCarrierAttributes.Inject to
// propagate tracing context into outgoing SQS message.
// 'ctx' holds current tracing context.
func sendSQSMessage(ctx context.Context, app *application, outboundSqsMessage types.Message) {
// You have a trace context in 'ctx' that you need to propagate into SQS message 'outboundSqsMessage'
ctxNew, span := app.tracer.Start(ctx, "sendSQSMessage")
defer span.End()
// Inject the tracing context
otelsqs.NewCarrier().Inject(ctxNew, outboundSqsMessage.MessageAttributes)
// Now you can send the SQS messageUse SnsCarrierAttributes.Inject to inject trace context into SNS publishing.
import (
"github.com/aws/aws-sdk-go-v2/service/sns"
"github.com/aws/aws-sdk-go-v2/service/sns/types"
"github.com/udhos/opentelemetry-trace-sqs/otelsns"
)
// publish is an example function that uses SnsCarrierAttributes.Inject to
// propagate tracing context with SNS publishing.
// 'ctx' holds current tracing context.
func publish(ctx context.Context, topicArn, msg string) {
input := &sns.PublishInput{
TopicArn: aws.String(topicArn),
Message: aws.String(msg),
MessageAttributes: make(map[string]types.MessageAttributeValue),
}
// Inject the tracing context
otelsns.NewCarrier().Inject(ctx, input.MessageAttributes)
// Now invoke SNS publish for input- Initialize the tracing - see main.go
- Enable trace propagation - see internal/tracing
- Retrieve tracing from request context
3.1. If using GIN
GIN - Use otelgin middleware
// gin
import "go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"
router.Use(otelgin.Middleware("virtual-service"))GIN - Get context with c.Request.Context()
// gin
func handlerRoute(c *gin.Context, app *application) {
const me = "handlerRoute"
ctx, span := app.tracer.Start(c.Request.Context(), me)
defer span.End()
// ...3.2. If using standard http package
HTTP - Wrap handler with otelhttp.NewHandler
wrappedHandler := otelhttp.NewHandler(handler, "hello-instrumented")
http.Handle("/hello-instrumented", wrappedHandler)HTTP - Get context with r.Context()
func httpHandler(w http.ResponseWriter, r *http.Request) {
const me = "httpHandler"
ctx, span := app.tracer.Start(r.Context(), me)
defer span.End()
// ...- For http client, create a Request from Context and wrap transport with otelhttp.NewTransport
newCtx, span := app.tracer.Start(ctx, "backendHTTP.fetch")
req, errReq := http.NewRequestWithContext(newCtx, "GET", u, nil)
client := http.Client{Transport: otelhttp.NewTransport(http.DefaultTransport)}
resp, errGet := client.Do(req)# Jaeger
./run-jaeger-local.sh
open jaeger: http:https://localhost:16686
# Server 1
export QUEUE_URL_INPUT=https://sqs.us-east-1.amazonaws.com/100010001000/q1
export QUEUE_URL_OUTPUT=https://sqs.us-east-1.amazonaws.com/100010001000/q2
export OTEL_SERVICE_NAME=opentelemetry-trace-sqs-gin-1
export HTTP_ADDR=:8001
export BACKEND_URL=http:https://localhost:8002/send
opentelemetry-trace-sqs-gin
# Server 2
export QUEUE_URL_INPUT=https://sqs.us-east-1.amazonaws.com/100010001000/q2
export QUEUE_URL_OUTPUT=https://sqs.us-east-1.amazonaws.com/100010001000/q3
export OTEL_SERVICE_NAME=opentelemetry-trace-sqs-gin-2
export HTTP_ADDR=:8002
export BACKEND_URL=http:https://localhost:8003/send
opentelemetry-trace-sqs-gin
# Server 3
export QUEUE_URL_INPUT=https://sqs.us-east-1.amazonaws.com/100010001000/q3
export QUEUE_URL_OUTPUT=https://sqs.us-east-1.amazonaws.com/100010001000/q4
export OTEL_SERVICE_NAME=opentelemetry-trace-sqs-gin-3
export HTTP_ADDR=:8003
export BACKEND_URL=http:https://wrong:8002/send
opentelemetry-trace-sqs-gin
curl -d '{"a":"b"}' localhost:8001/send
https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation