open-telemetry/opentelemetry-ruby-contrib

AWS SDK: Add an option to add tracing information to request headers instead of message attributes

Open

#718 opened on Nov 11, 2023

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Ruby (252 forks)auto 404
help wantedinstrumentation-aws_sdkkeep

Repository metrics

Stars
 (135 stars)
PR merge metrics
 (PR metrics pending)

Description

This concerns the AWS SDK instrumentation

Right now, the instrumentation injects the tracing information in SNS/SQS message attributes. If you want to make use of SNS active tracing in X-Ray, tracing information is only passed along if it is in the request header.

We could introduce a configuration option for giving the user control whether it should be injected in the message attributes or as request header.

Contributor guide

Research direction
Examine the current AWS SDK instrumentation code to understand how tracing is injected into SNS/SQS message attributes. Identify where to add a configuration option to switch to request header injection. Consider the impact on X Ray active tracing.
Tech stack
ruby
Domain
backendcloudobservability
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RubyOpenTelemetryAWS SDK
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60