open-telemetry / open-telemetry/opentelemetry-python-contrib

AWS services support expansion for opentelemetry-instrumentation-botocore

Open
#2,515 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
Python
Stars
1.1k
Forks
1.1k
Avg merge
4d 15h
Merged PRs (30d)
16

Description

Currently the opentelemetry-instrumentation-botocore pkg only support limited AWS services with extension, as application ecosystem grows, we want to broaden our support to encompass a wider range of services and add more resource attributes into span. Right now, we are considering improving instrumentation support for Kinesis, S3, SQS and SNS. There will be more support coming up for other AWS services in the future.

Describe the solution you'd like
We want to expand _KNOWN_EXTENSIONS in opentelemetry-instrumentation-botocore . For example, in _SqsExtension, we will add "aws.sqs.queue_name" into span attributes. And adding more for the other services as well.

Additional context
We have a aws-otel-python-instrumentation pkg, which builds aws python distro for AWS Application Signals enablement. This pkg depends on opentelemetry-python-contrib for manual/auto instrumentation. We want to expand support for AWS Application Signals, thus want to contribute to upstream instrumentation pkg.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/extensions/init.py and review the existing _KNOWN_EXTENSIONS entries, then inspect extensions/sqs.py and the corresponding Kinesis, S3, and SNS support. Done means the requested services are covered and their relevant resource attributes, including aws.sqs.queue_name, are added to spans.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
cloud, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.