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

Vote on which instrumentations to implement the migration plan!

Open
#2,351 15 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

instrumentation specification
Dominant language
Python
Stars
1.1k
Forks
1.1k
Avg merge
4d 15h
Merged PRs (30d)
16

Description

Based off of the recent discussion on alleviating some of the implementation burden of implementing the migration plan for instrumentations moving to new semantic conventions, we are now allowed to choose a subset of instrumentations to implement this for. Please comment here on the preferences for "important instrumentations" that we should include as part of the migration plan. Keep in mind non-http instrumentations are included because this affects their eventual migration. A couple of things to also consider:

  1. We can iterate on this list, where we can INCLUDE instrumentations in this list as we see fit but we most likely do not want to REMOVE ones that we already decide to be important.
  2. Once we decide on a preliminary set of instrumentations, we can begin implementing migration plans for them INDIVIDUALLY.
  3. For instrumentations NOT included in the set, we can begin to discuss whether we want to allow for contributions that update PARTIALLY to new semantic conventions.

For starters, I vote:

opentelemetry-instrumentation-aiohttp-client
opentelemetry-instrumentation-asgi
opentelemetry-instrumentation-django
opentelemetry-instrumentation-fastapi
opentelemetry-instrumentation-httplib
opentelemetry-instrumentation-httpx
opentelemetry-instrumentation-flask
opentelemetry-instrumentation-psycopg2
opentelemetry-instrumentation-requests
opentelemetry-instrumentation-sqlalchemy
opentelemetry-instrumentation-requests
opentelemetry-instrumentation-urllib
opentelemetry-instrumentation-urllib3
opentelemetry-instrumentation-wsgi

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 by reading the linked semantic-conventions discussion and this issue's comment thread, then review the listed Python instrumentations. Done means agreeing on a preliminary set of important instrumentations and establishing which individual migration plans should be implemented next.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, fastapi, flask, python, sqlalchemy
Domain
observability-sre
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.