Update version to 1.36.0.dev/0.57b0.dev (#3633)

Co-authored-by: otelbot <197425009+otelbot@users.noreply.github.com>

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+# skipping auto generated folders
+skip = ./.tox,./.mypy_cache,./docs/_build,./target,*/LICENSE,./venv
+ignore-words-list = ot

.coveragerc

@@ -1,5 +1,4 @@
 [run]
 omit =
     */tests/*
-    */setup.py
     */gen/*

.flake8

@@ -1,23 +0,0 @@
-[flake8]
-ignore =
-  E501  # line too long, defer to black
-  W503  # allow line breaks before binary ops
-  W504  # allow line breaks after binary ops
-  E203  # allow whitespace before ':' (https://github.com/psf/black#slices) 
-exclude =
-  .bzr
-  .git
-  .hg
-  .svn
-  .tox
-  CVS
-  .venv*/
-  venv*/
-  target
-  __pycache__
-  exporter/opentelemetry-exporter-jaeger/src/opentelemetry/exporter/jaeger/gen/
-  exporter/opentelemetry-exporter-jaeger/build/*
-  docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/grpc/gen/
-  docs/examples/opentelemetry-example-app/build/*
-  opentelemetry-proto/build/*
-  opentelemetry-proto/src/opentelemetry/proto/

.github/CODEOWNERS

@@ -1,26 +1,12 @@
-# Code owners file.
-# This file controls who is tagged for review for any given pull request.
-#
-# What is a "CODEOWNER"?
-#
-# A CODEOWNER lends their expertise to a specific package hosted by an OpenTelemetry repository.
-#
-# A CODEOWNER MUST:
-# - introduce themselves on the CNCF OTel Python channel: https://cloud-native.slack.com/archives/C01PD4HUVBL
-# - have enough knowledge of the corresponding instrumented library
-# - respond to issues
-# - fix failing unit tests or any other blockers to the CI/CD workflow
-# - update usage of `opentelemetry-python-core` APIs upon the introduction of breaking changes
-# - be a member of the OpenTelemetry community so that the `component-owners.yml` action to automatically assign CODEOWNERS to PRs works correctly.
-#
+# This file is only used as a way to assign any change to the approvers team
+# except for a change in any of the instrumentations. The actual codeowners
+# of the instrumentations are in .github/component_owners.yml.
 
-
-# For anything not explicitly taken by someone else:
+# Assigns any change to the approvers team...
 * @open-telemetry/opentelemetry-python-contrib-approvers
 
+# ...except for changes in any instrumentation.
+/instrumentation
+
 # Learn about CODEOWNERS file format:
 # https://help.github.com/en/articles/about-code-owners
-#
-# Learn about membership in OpenTelemetry community:
-# https://github.com/open-telemetry/community/blob/main/community-membership.md
-#

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,19 +0,0 @@
----
-name: Bug Report
-about: Create a report to help us improve
-labels: bug
----
-
-**Describe your environment** Describe any aspect of your environment relevant to the problem, including your Python version, [platform](https://docs.python.org/3/library/platform.html), version numbers of installed dependencies, information about your cloud hosting provider, etc. If you're reporting a problem with a specific version of a library in this repo, please check whether the problem has been fixed on main.
-
-**Steps to reproduce**
-Describe exactly how to reproduce the error. Include a code sample if applicable.
-
-**What is the expected behavior?**
-What did you expect to see?
-
-**What is the actual behavior?**
-What did you see instead?
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,66 @@
+---
+name: Bug Report
+description: Create a report to help us improve
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! Please make sure to fill out the entire form below, providing as much context as you can in order to help us triage and track down your bug as quickly as possible.
+
+        Before filing a bug, please be sure you have searched through [existing bugs](https://github.com/open-telemetry/opentelemetry-python-contrib/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug) to see if your bug is already addressed.  
+  
+  - type: textarea
+    id: environment
+    attributes:
+      label: Describe your environment
+      description: |
+        Please describe any aspect of your environment relevant to the problem, including your Python version, [platform](https://docs.python.org/3/library/platform.html), version numbers of installed dependencies, information about your cloud hosting provider, etc. If you're reporting a problem with a specific version of a library in this repo, please check whether the problem has been fixed on main.
+      value: |
+        OS: (e.g, Ubuntu)
+        Python version: (e.g., Python 3.9.10)
+        Package version: (e.g., 0.46.0)
+  
+  - type: textarea
+    attributes:
+      label: What happened?
+      description: Please provide as much detail as you reasonably can.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: Provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) if possible and the needed steps to reproduce the problem.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Result
+      description: What did you expect to see?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Actual Result
+      description: What did you see instead?
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+      placeholder: Any additional information...
+
+  - type: dropdown
+    id: contribute
+    attributes:
+      label: Would you like to implement a fix?
+      description: For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/CONTRIBUTING.md).
+      options:
+        - "No"
+        - "Yes"

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: Slack
+    url: https://cloud-native.slack.com/archives/C01PD4HUVBL
+    about: Or the `#otel-python` channel in the CNCF Slack instance.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,19 +0,0 @@
----
-name: Feature Request
-about: Suggest an idea for this project
-labels: feature-request
----
-
-Before opening a feature request against this repo, consider whether the feature should/could be implemented in the [other OpenTelemetry client libraries](https://github.com/open-telemetry/). If so, please [open an issue on opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification/issues/new) first.
-
-**Is your feature request related to a problem?**
-If so, provide a concise description of the problem.
-
-**Describe the solution you'd like**
-What do you want to happen instead? What is the expected behavior?
-
-**Describe alternatives you've considered**
-Which alternative solutions or features have you considered?
-
-**Additional context**
-Add any other context about the feature request here.

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,50 @@
+---
+name: Feature Request
+description: Suggest an idea for this project
+labels: [feature-request]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before opening a feature request against this repo, consider whether the feature should/could be implemented in the [other OpenTelemetry client libraries](https://github.com/open-telemetry/). If so, please [open an issue on opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification/issues/new) first.
+  - type: textarea
+    id: related-problem
+    attributes:
+      label: What problem do you want to solve?
+      description: Is your feature request related to a problem? If so, provide a concise description of the problem.
+      placeholder: Describe the problem and include relevant issue IDs
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: What do you want to happen instead? What is the expected behavior?
+      placeholder: I'd like to ...
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: Which alternative solutions or features have you considered?
+      placeholder: Some potential solutions
+    validations:
+      required: false
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the feature request here.
+      placeholder: Some related requests in other projects or upstream spec proposals.
+    validations:
+      required: false
+  - type: dropdown
+    id: contribute
+    attributes:
+      label: Would you like to implement a fix?
+      description: |
+        For guidance on how to get started, refer to the [contribution guide](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/CONTRIBUTING.md).
+      options:
+        - "No"
+        - "Yes"

.github/component_owners.yml

@@ -1,11 +1,83 @@
 components:
+
+  docs/instrumentation:
+    - nemoshlag
+
+
+  instrumentation/opentelemetry-instrumentation-aio-pika:
+    - ofek1weiss
+
+  instrumentation/opentelemetry-instrumentation-boto3sqs:
+    - oxeye-nikolay
+    - nikosokolik
+  
+  instrumentation/opentelemetry-instrumentation-asyncclick:
+    - jomcgi
+
+  instrumentation/opentelemetry-instrumentation-kafka-python:
+    - nozik
   
   instrumentation/opentelemetry-instrumentation-pika:
     - oxeye-nikolay
     - nikosokolik
 
+  instrumentation/opentelemetry-instrumentation-redis:
+    - sungwonh
+
+  instrumentation/opentelemetry-instrumentation-remoulade:
+    - ben-natan
+    - machine424
+
+  instrumentation/opentelemetry-instrumentation-confluent-kafka:
+    - oxeye-dorkolog
+    - dorkolog
+
   propagator/opentelemetry-propagator-aws-xray:
     - NathanielRN
 
   sdk-extension/opentelemetry-sdk-extension-aws:
     - NathanielRN
+    - Kausik-A
+    - srprash
+
+  instrumentation/opentelemetry-instrumentation-tortoiseorm:
+    - tonybaloney
+
+  instrumentation/opentelemetry-instrumentation-tornado:
+    - shalevr
+
+  instrumentation/opentelemetry-instrumentation-urllib:
+    - shalevr
+
+  instrumentation/opentelemetry-instrumentation-urllib3:
+    - shalevr
+
+  instrumentation/opentelemetry-instrumentation-sqlalchemy:
+    - shalevr
+
+  instrumentation/opentelemetry-instrumentation-cassandra:
+    - mattcontinisio
+
+  instrumentation/opentelemetry-instrumentation-asyncio:
+    - bourbonkk
+
+  instrumentation/opentelemetry-instrumentation-psycopg:
+    - federicobond
+
+  instrumentation/opentelemetry-instrumentation-pymssql:
+    - guillaumep
+
+  instrumentation/opentelemetry-instrumentation-aiokafka:
+    - dimastbk
+
+  processor/opentelemetry-processor-baggage:
+    - codeboten
+
+  instrumentation-genai/:
+    - karthikscale3
+    - lmolkova
+    - lzchen
+    - gyliu513
+    - nirga
+    - alizenhom
+    - codefromthecrypt

.github/scripts/update-version-patch.sh

@@ -0,0 +1,11 @@
+#!/bin/bash -e
+
+sed -i "/\[stable\]/{n;s/version=.*/version=$1/}" eachdist.ini
+sed -i "/\[prerelease\]/{n;s/version=.*/version=$2/}" eachdist.ini
+
+./scripts/eachdist.py update_patch_versions \
+    --stable_version=$1 \
+    --unstable_version=$2 \
+    --stable_version_prev=$3 \
+    --unstable_version_prev=$4
+

.github/scripts/update-version.sh

@@ -0,0 +1,6 @@
+#!/bin/bash -e
+
+sed -i "/\[stable\]/{n;s/version=.*/version=$1/}" eachdist.ini
+sed -i "/\[prerelease\]/{n;s/version=.*/version=$2/}" eachdist.ini
+
+./scripts/eachdist.py update_versions --versions stable,prerelease

.github/scripts/use-cla-approved-github-bot.sh

@@ -0,0 +1,4 @@
+#!/bin/bash -e
+
+git config user.name opentelemetrybot
+git config user.email 107717825+opentelemetrybot@users.noreply.github.com

.github/workflows/backport.yml

@@ -0,0 +1,43 @@
+name: Backport
+on:
+  workflow_dispatch:
+    inputs:
+      number:
+        description: "The pull request # to backport"
+        required: true
+
+jobs:
+  backport:
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          if [[ ! $GITHUB_REF_NAME =~ ^release/v[0-9]+\.[0-9]+\.x-0\.[0-9]+bx$ ]]; then
+            echo this workflow should only be run against long-term release branches
+            exit 1
+          fi
+
+      - uses: actions/checkout@v4
+        with:
+          # history is needed to run git cherry-pick below
+          fetch-depth: 0
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request
+        env:
+          NUMBER: ${{ github.event.inputs.number }}
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          commit=$(gh pr view $NUMBER --json mergeCommit --jq .mergeCommit.oid)
+          title=$(gh pr view $NUMBER --json title --jq .title)
+
+          branch="opentelemetrybot/backport-${NUMBER}-to-${GITHUB_REF_NAME//\//-}"
+
+          git cherry-pick $commit
+          git push origin HEAD:$branch
+          gh pr create --title "[$GITHUB_REF_NAME] $title" \
+                       --body "Clean cherry-pick of #$NUMBER to the \`$GITHUB_REF_NAME\` branch." \
+                       --head $branch \
+                       --base $GITHUB_REF_NAME

.github/workflows/changelog.yml

@@ -13,10 +13,12 @@ on:
 jobs:
   changelog:
     runs-on: ubuntu-latest
-    if: "!contains(github.event.pull_request.labels.*.name, 'Skip Changelog')"
+    if: |
+      !contains(github.event.pull_request.labels.*.name, 'Skip Changelog')
+      && github.actor != 'opentelemetrybot'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Check for CHANGELOG changes
         run: |
@@ -31,4 +33,4 @@ jobs:
             echo "No CHANGELOG was modified."
             echo "Please add a CHANGELOG entry, or add the \"Skip Changelog\" label if not required."
             false
-          fi
+          fi

.github/workflows/codeql-analysis.yml

@@ -20,16 +20,16 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v3
         with:
           languages: python
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v1
+        uses: github/codeql-action/autobuild@v3
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v3

.github/workflows/component-owners.yml

@@ -10,6 +10,10 @@ jobs:
   run_self:
     runs-on: ubuntu-latest
     name: Auto Assign Owners
+    permissions: 
+      contents: read          # to read changed files 
+      issues: write           # to read/write issue assignees 
+      pull-requests: write    # to read/write PR reviewers 
     # Don't fail tests if this workflow fails. Some pending issues:
     # - https://github.com/dyladan/component-owners/issues/8
     continue-on-error: true

.github/workflows/fossa.yml

@@ -0,0 +1,20 @@
+name: FOSSA scanning
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  fossa:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - uses: fossas/fossa-action@93a52ecf7c3ac7eb40f5de77fd69b1a19524de94 # v1.5.0
+        with:
+          api-key: ${{secrets.FOSSA_API_KEY}}
+          team: OpenTelemetry

.github/workflows/generate_workflows.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+
+from generate_workflows_lib import (
+    generate_contrib_workflow,
+    generate_lint_workflow,
+    generate_misc_workflow,
+    generate_test_workflow,
+)
+
+tox_ini_path = Path(__file__).parent.parent.parent.joinpath("tox.ini")
+workflows_directory_path = Path(__file__).parent
+
+generate_test_workflow(tox_ini_path, workflows_directory_path, "ubuntu-latest")
+generate_lint_workflow(tox_ini_path, workflows_directory_path)
+generate_misc_workflow(tox_ini_path, workflows_directory_path)
+generate_contrib_workflow(workflows_directory_path)

.github/workflows/generate_workflows_lib/hatch_build.py

@@ -0,0 +1,17 @@
+from pathlib import Path
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+class CustomBuildHook(BuildHookInterface):
+    def initialize(self, version, build_data):
+        with open(
+            Path(__file__).parent.parent.parent.parent.joinpath("tox.ini")
+        ) as tox_ini_file_0:
+            with open(
+                Path(__file__).parent.joinpath(
+                    "src/generate_workflows_lib/tox.ini"
+                ),
+                "w",
+            ) as tox_ini_file_1:
+                tox_ini_file_1.write(tox_ini_file_0.read())

.github/workflows/generate_workflows_lib/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "generate-workflows-lib"
+dynamic = ["version"]
+description = "A library to generate workflows"
+license = "Apache-2.0"
+requires-python = ">=3.9"
+authors = [
+  { name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+dependencies = ["Jinja2", "tox"]
+
+[tool.hatch.version]
+path = "src/generate_workflows_lib/version.py"
+
+[tool.hatch.build.targets.wheel.hooks.custom]

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/.gitignore

@@ -0,0 +1 @@
+tox.ini

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/__init__.py

@@ -0,0 +1,236 @@
+from collections import defaultdict
+from pathlib import Path
+from re import compile as re_compile
+
+from jinja2 import Environment, FileSystemLoader
+from tox.config.cli.parse import get_options
+from tox.config.sets import CoreConfigSet
+from tox.config.source.tox_ini import ToxIni
+from tox.session.state import State
+
+_tox_test_env_regex = re_compile(
+    r"(?P<python_version>py\w+)-test-"
+    r"(?P<name>[-\w]+\w)-?(?P<test_requirements>\d+)?"
+)
+_tox_lint_env_regex = re_compile(r"lint-(?P<name>[-\w]+)")
+_tox_contrib_env_regex = re_compile(
+    r"py39-test-(?P<name>[-\w]+\w)-?(?P<contrib_requirements>\d+)?"
+)
+
+
+def get_tox_envs(tox_ini_path: Path) -> list:
+    tox_ini = ToxIni(tox_ini_path)
+
+    conf = State(get_options(), []).conf
+
+    tox_section = next(tox_ini.sections())
+
+    core_config_set = CoreConfigSet(
+        conf, tox_section, tox_ini_path.parent, tox_ini_path
+    )
+
+    (
+        core_config_set.loaders.extend(
+            tox_ini.get_loaders(
+                tox_section,
+                base=[],
+                override_map=defaultdict(list, {}),
+                conf=core_config_set,
+            )
+        )
+    )
+
+    return core_config_set.load("env_list")
+
+
+def get_test_job_datas(tox_envs: list, operating_systems: list) -> list:
+    os_alias = {"ubuntu-latest": "Ubuntu", "windows-latest": "Windows"}
+
+    python_version_alias = {
+        "pypy3": "pypy-3.9",
+        "pypy310": "pypy-3.10",
+        "py39": "3.9",
+        "py310": "3.10",
+        "py311": "3.11",
+        "py312": "3.12",
+        "py313": "3.13",
+    }
+
+    test_job_datas = []
+
+    for operating_system in operating_systems:
+        for tox_env in tox_envs:
+            tox_test_env_match = _tox_test_env_regex.match(tox_env)
+
+            if tox_test_env_match is None:
+                continue
+
+            groups = tox_test_env_match.groupdict()
+
+            aliased_python_version = python_version_alias[
+                groups["python_version"]
+            ]
+            tox_env = tox_test_env_match.string
+
+            test_requirements = groups["test_requirements"]
+
+            if test_requirements is None:
+                test_requirements = " "
+
+            else:
+                test_requirements = f"-{test_requirements} "
+
+            test_job_datas.append(
+                {
+                    "name": f"{tox_env}_{operating_system}",
+                    "ui_name": (
+                        f"{groups['name']}"
+                        f"{test_requirements}"
+                        f"{aliased_python_version} "
+                        f"{os_alias[operating_system]}"
+                    ),
+                    "python_version": aliased_python_version,
+                    "tox_env": tox_env,
+                    "os": operating_system,
+                }
+            )
+
+    return test_job_datas
+
+
+def get_lint_job_datas(tox_envs: list) -> list:
+    lint_job_datas = []
+
+    for tox_env in tox_envs:
+        tox_lint_env_match = _tox_lint_env_regex.match(tox_env)
+
+        if tox_lint_env_match is None:
+            continue
+
+        tox_env = tox_lint_env_match.string
+
+        lint_job_datas.append(
+            {
+                "name": f"{tox_env}",
+                "ui_name": f"{tox_lint_env_match.groupdict()['name']}",
+                "tox_env": tox_env,
+            }
+        )
+
+    return lint_job_datas
+
+
+def get_contrib_job_datas(tox_envs: list) -> list:
+    contrib_job_datas = []
+
+    for tox_env in tox_envs:
+        tox_contrib_env_match = _tox_contrib_env_regex.match(tox_env)
+
+        if tox_contrib_env_match is None:
+            continue
+
+        groups = tox_contrib_env_match.groupdict()
+
+        tox_env = tox_contrib_env_match.string
+
+        contrib_requirements = groups["contrib_requirements"]
+
+        if contrib_requirements is None:
+            contrib_requirements = " "
+
+        else:
+            contrib_requirements = f"-{contrib_requirements} "
+
+        contrib_job_datas.append(
+            {
+                "ui_name": (f"{groups['name']}" f"{contrib_requirements}"),
+                "tox_env": tox_env,
+            }
+        )
+
+    return contrib_job_datas
+
+
+def get_misc_job_datas(tox_envs: list) -> list:
+    misc_job_datas = []
+
+    _tox_benchmark_env_regex = re_compile(r"benchmark.+")
+
+    for tox_env in tox_envs:
+        if (
+            _tox_test_env_regex.match(tox_env) is not None
+            or _tox_lint_env_regex.match(tox_env) is not None
+            or _tox_contrib_env_regex.match(tox_env) is not None
+            or _tox_benchmark_env_regex.match(tox_env) is not None
+        ):
+            continue
+
+        misc_job_datas.append(tox_env)
+
+    return misc_job_datas
+
+
+def _generate_workflow(
+    job_datas: list, name: str, workflow_directory_path: Path, max_jobs=250
+):
+    # Github seems to limit the amount of jobs in a workflow file, that is why
+    # they are split in groups of 250 per workflow file.
+    for file_number, job_datas in enumerate(
+        [
+            job_datas[index : index + max_jobs]
+            for index in range(0, len(job_datas), max_jobs)
+        ]
+    ):
+        with open(
+            workflow_directory_path.joinpath(f"{name}_{file_number}.yml"), "w"
+        ) as test_yml_file:
+            test_yml_file.write(
+                Environment(loader=FileSystemLoader(Path(__file__).parent))
+                .get_template(f"{name}.yml.j2")
+                .render(job_datas=job_datas, file_number=file_number)
+            )
+            test_yml_file.write("\n")
+
+
+def generate_test_workflow(
+    tox_ini_path: Path, workflow_directory_path: Path, *operating_systems
+) -> None:
+    _generate_workflow(
+        get_test_job_datas(get_tox_envs(tox_ini_path), operating_systems),
+        "test",
+        workflow_directory_path,
+    )
+
+
+def generate_lint_workflow(
+    tox_ini_path: Path,
+    workflow_directory_path: Path,
+) -> None:
+    _generate_workflow(
+        get_lint_job_datas(get_tox_envs(tox_ini_path)),
+        "lint",
+        workflow_directory_path,
+    )
+
+
+def generate_contrib_workflow(
+    workflow_directory_path: Path,
+) -> None:
+    _generate_workflow(
+        get_contrib_job_datas(
+            get_tox_envs(Path(__file__).parent.joinpath("tox.ini"))
+        ),
+        "core_contrib_test",
+        workflow_directory_path,
+    )
+
+
+def generate_misc_workflow(
+    tox_ini_path: Path,
+    workflow_directory_path: Path,
+) -> None:
+    _generate_workflow(
+        get_misc_job_datas(get_tox_envs(tox_ini_path)),
+        "misc",
+        workflow_directory_path,
+    )

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/core_contrib_test.yml.j2

@@ -0,0 +1,46 @@
+# Do not edit this file.
+# This file is generated automatically by executing tox -e generate-workflows
+
+name: Core Contrib Test {{ file_number }}
+
+on:
+  workflow_call:
+    inputs:
+      CORE_REPO_SHA:
+        required: true
+        type: string
+      CONTRIB_REPO_SHA:
+        required: true
+        type: string
+
+env:
+  CORE_REPO_SHA: ${% raw %}{{ inputs.CORE_REPO_SHA }}{% endraw %}
+  CONTRIB_REPO_SHA: ${% raw %}{{ inputs.CONTRIB_REPO_SHA }}{% endraw %}
+  PIP_EXISTS_ACTION: w
+
+jobs:
+  {%- for job_data in job_datas %}
+
+  {{ job_data.tox_env }}:
+    name: {{ job_data.ui_name }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout contrib repo @ SHA - ${% raw %}{{ env.CONTRIB_REPO_SHA }}{% endraw %}
+        uses: actions/checkout@v4
+        with:
+          repository: open-telemetry/opentelemetry-python-contrib
+          ref: ${% raw %}{{ env.CONTRIB_REPO_SHA }}{% endraw %}
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+          architecture: "x64"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e {{ job_data.tox_env }} -- -ra
+  {%- endfor %}

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/lint.yml.j2

@@ -0,0 +1,50 @@
+# Do not edit this file.
+# This file is generated automatically by executing tox -e generate-workflows
+
+name: Lint {{ file_number }}
+
+on:
+  push:
+    branches-ignore:
+    - 'release/*'
+  pull_request:
+
+concurrency:
+  group: ${% raw %}{{ github.workflow }}-${{ github.head_ref || github.run_id }}{% endraw %}
+  cancel-in-progress: true
+
+env:
+  # Set the SHA to the branch name if the PR has a label 'prepare-release' or 'backport' otherwise, set it to 'main'
+  # For PRs you can change the inner fallback ('main')
+  # For pushes you change the outer fallback ('main')
+  # The logic below is used during releases and depends on having an equivalent branch name in the core repo.
+  CORE_REPO_SHA: {% raw %}${{ github.event_name == 'pull_request' && (
+       contains(github.event.pull_request.labels.*.name, 'prepare-release') && github.event.pull_request.head.ref ||
+       contains(github.event.pull_request.labels.*.name, 'backport') && github.event.pull_request.base.ref ||
+       'main'
+    ) || 'main' }}{% endraw %}
+  CONTRIB_REPO_SHA: main
+  PIP_EXISTS_ACTION: w
+
+jobs:
+  {%- for job_data in job_datas %}
+
+  {{ job_data.name }}:
+    name: {{ job_data.ui_name }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${% raw %}{{ github.sha }}{% endraw %}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e {{ job_data.tox_env }}
+  {%- endfor %}

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/misc.yml.j2

@@ -0,0 +1,87 @@
+# Do not edit this file.
+# This file is generated automatically by executing tox -e generate-workflows
+
+name: Misc {{ file_number }}
+
+on:
+  push:
+    branches-ignore:
+    - 'release/*'
+  pull_request:
+
+concurrency:
+  group: ${% raw %}{{ github.workflow }}-${{ github.head_ref || github.run_id }}{% endraw %}
+  cancel-in-progress: true
+
+env:
+  # Set the SHA to the branch name if the PR has a label 'prepare-release' or 'backport' otherwise, set it to 'main'
+  # For PRs you can change the inner fallback ('main')
+  # For pushes you change the outer fallback ('main')
+  # The logic below is used during releases and depends on having an equivalent branch name in the core repo.
+  CORE_REPO_SHA: {% raw %}${{ github.event_name == 'pull_request' && (
+       contains(github.event.pull_request.labels.*.name, 'prepare-release') && github.event.pull_request.head.ref ||
+       contains(github.event.pull_request.labels.*.name, 'backport') && github.event.pull_request.base.ref ||
+       'main'
+    ) || 'main' }}{% endraw %}
+  CONTRIB_REPO_SHA: main
+  PIP_EXISTS_ACTION: w
+
+jobs:
+  {%- for job_data in job_datas %}
+
+  {{ job_data }}:
+    name: {{ job_data }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    {%- if job_data == "generate-workflows" %}
+    if: |
+      !contains(github.event.pull_request.labels.*.name, 'Skip generate-workflows')
+      && github.event.pull_request.user.login != 'opentelemetrybot' && github.event_name == 'pull_request'
+    {%- endif %}
+    {%- if job_data == "public-symbols-check" %}
+    if: |
+      !contains(github.event.pull_request.labels.*.name, 'Approve Public API check')
+      && github.actor != 'opentelemetrybot' && github.event_name == 'pull_request'
+    {%- endif %}
+    {%- if job_data == "docs" %}
+    if: |
+      github.event.pull_request.user.login != 'opentelemetrybot' && github.event_name == 'pull_request'
+    {%- endif %}
+    steps:
+      - name: Checkout repo @ SHA - ${% raw %}{{ github.sha }}{% endraw %}
+        uses: actions/checkout@v4
+      {%- if job_data == "public-symbols-check" %}
+        with:
+          fetch-depth: 0
+
+      - name: Checkout main
+        run: git checkout main
+
+      - name: Pull origin
+        run: git pull --rebase=false origin main
+
+      - name: Checkout pull request
+        run: git checkout ${% raw %}{{ github.event.pull_request.head.sha }}{% endraw %}
+      {%- endif %}
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e {{ job_data }}
+      {%- if job_data == "generate-workflows" %}
+
+      - name: Check workflows are up to date
+        run: git diff --exit-code || (echo 'Generated workflows are out of date, run "tox -e generate-workflows" and commit the changes in this PR.' && exit 1)
+      {%- endif %}
+      {%- if job_data == "generate" %}
+
+      - name: Check workflows are up to date
+        run: git diff --exit-code || (echo 'Generated code is out of date, run "tox -e generate" and commit the changes in this PR.' && exit 1)
+      {%- endif %}
+  {%- endfor %}

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/test.yml.j2

@@ -0,0 +1,55 @@
+# Do not edit this file.
+# This file is generated automatically by executing tox -e generate-workflows
+
+name: Test {{ file_number }}
+
+on:
+  push:
+    branches-ignore:
+    - 'release/*'
+  pull_request:
+
+concurrency:
+  group: ${% raw %}{{ github.workflow }}-${{ github.head_ref || github.run_id }}{% endraw %}
+  cancel-in-progress: true
+
+env:
+  # Set the SHA to the branch name if the PR has a label 'prepare-release' or 'backport' otherwise, set it to 'main'
+  # For PRs you can change the inner fallback ('main')
+  # For pushes you change the outer fallback ('main')
+  # The logic below is used during releases and depends on having an equivalent branch name in the core repo.
+  CORE_REPO_SHA: {% raw %}${{ github.event_name == 'pull_request' && (
+       contains(github.event.pull_request.labels.*.name, 'prepare-release') && github.event.pull_request.head.ref ||
+       contains(github.event.pull_request.labels.*.name, 'backport') && github.event.pull_request.base.ref ||
+       'main'
+    ) || 'main' }}{% endraw %}
+  CONTRIB_REPO_SHA: main
+  PIP_EXISTS_ACTION: w
+
+jobs:
+  {%- for job_data in job_datas %}
+
+  {{ job_data.name }}:
+    name: {{ job_data.ui_name }}
+    runs-on: {{ job_data.os }}
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${% raw %}{{ github.sha }}{% endraw %}
+        uses: actions/checkout@v4
+
+      - name: Set up Python {{ job_data.python_version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "{{ job_data.python_version }}"
+
+      - name: Install tox
+        run: pip install tox-uv
+      {%- if job_data.os == "windows-latest" %}
+
+      - name: Configure git to support long filenames
+        run: git config --system core.longpaths true
+      {%- endif %}
+
+      - name: Run tests
+        run: tox -e {{ job_data.tox_env }} -- -ra
+  {%- endfor %}

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

.github/workflows/misc_0.yml

@@ -0,0 +1,192 @@
+# Do not edit this file.
+# This file is generated automatically by executing tox -e generate-workflows
+
+name: Misc 0
+
+on:
+  push:
+    branches-ignore:
+    - 'release/*'
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  # Set the SHA to the branch name if the PR has a label 'prepare-release' or 'backport' otherwise, set it to 'main'
+  # For PRs you can change the inner fallback ('main')
+  # For pushes you change the outer fallback ('main')
+  # The logic below is used during releases and depends on having an equivalent branch name in the core repo.
+  CORE_REPO_SHA: ${{ github.event_name == 'pull_request' && (
+       contains(github.event.pull_request.labels.*.name, 'prepare-release') && github.event.pull_request.head.ref ||
+       contains(github.event.pull_request.labels.*.name, 'backport') && github.event.pull_request.base.ref ||
+       'main'
+    ) || 'main' }}
+  CONTRIB_REPO_SHA: main
+  PIP_EXISTS_ACTION: w
+
+jobs:
+
+  spellcheck:
+    name: spellcheck
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e spellcheck
+
+  docker-tests:
+    name: docker-tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e docker-tests
+
+  docs:
+    name: docs
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    if: |
+      github.event.pull_request.user.login != 'opentelemetrybot' && github.event_name == 'pull_request'
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e docs
+
+  generate:
+    name: generate
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e generate
+
+      - name: Check workflows are up to date
+        run: git diff --exit-code || (echo 'Generated code is out of date, run "tox -e generate" and commit the changes in this PR.' && exit 1)
+
+  generate-workflows:
+    name: generate-workflows
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    if: |
+      !contains(github.event.pull_request.labels.*.name, 'Skip generate-workflows')
+      && github.event.pull_request.user.login != 'opentelemetrybot' && github.event_name == 'pull_request'
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e generate-workflows
+
+      - name: Check workflows are up to date
+        run: git diff --exit-code || (echo 'Generated workflows are out of date, run "tox -e generate-workflows" and commit the changes in this PR.' && exit 1)
+
+  shellcheck:
+    name: shellcheck
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e shellcheck
+
+  ruff:
+    name: ruff
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e ruff
+
+  typecheck:
+    name: typecheck
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e typecheck

.github/workflows/ossf-scorecard.yml

@@ -0,0 +1,47 @@
+name: OSSF Scorecard
+
+on:
+  push:
+    branches:
+      - main
+  schedule:
+    - cron: "10 6 * * 1" # once a week
+  workflow_dispatch:
+
+permissions: read-all
+
+jobs:
+  analysis:
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed for Code scanning upload
+      security-events: write
+      # Needed for GitHub OIDC token if publish_results is true
+      id-token: write
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable
+      # uploads of run results in SARIF format to the repository Actions tab.
+      # https://docs.github.com/en/actions/advanced-guides/storing-workflow-data-as-artifacts
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@5f8171a638ada777af81d42b55959a643bb29017 # v3.28.12
+        with:
+          sarif_file: results.sarif

.github/workflows/package-prepare-patch-release.yml

@@ -0,0 +1,121 @@
+name: "[Package] Prepare patch release"
+on:
+  workflow_dispatch:
+    inputs:
+      package:
+        type: choice
+        options:
+        - opentelemetry-propagator-aws-xray
+        - opentelemetry-resource-detector-azure
+        - opentelemetry-sdk-extension-aws
+        - opentelemetry-instrumentation-openai-v2
+        - opentelemetry-instrumentation-vertexai
+        - opentelemetry-instrumentation-google-genai
+        description: 'Package to be released'
+        required: true
+run-name: "[Package][${{ inputs.package }}] Prepare patch release"
+
+jobs:
+  prepare-patch-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Verify prerequisites
+        run: |
+          if [[ $GITHUB_REF_NAME != package-release/${{ inputs.package }}/v* ]]; then
+            echo this workflow should only be run against package-release/${{ inputs.package }}* branches, but is running on $GITHUB_REF_NAME
+            exit 1
+          fi
+
+          path=./$(./scripts/eachdist.py find-package --package ${{ inputs.package }})
+          changelog=$path/CHANGELOG.md
+
+          if [ ! -f $changelog ]; then
+            echo "missing $changelog file"
+            exit 1
+          fi
+
+          if ! grep --quiet "^## Unreleased$" CHANGELOG.md; then
+            echo the $changelog is missing an \"Unreleased\" section
+            exit 1
+          fi
+
+          version=$(./scripts/eachdist.py version --package ${{ inputs.package }})
+
+          version_file=$(find $path -type f -path "*version*.py")
+          file_count=$(echo "$version_file" | wc -l)
+
+          if [ "$file_count" -ne 1 ]; then
+            echo "Error: expected one version file, found $file_count"
+            echo "$version_file"
+            exit 1
+          fi
+
+          if [[ $version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+            # 1.2.3 or 1.2.3rc1
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            patch="${BASH_REMATCH[3]}"
+            next_version="$major.$minor.$((patch + 1))"
+            release_branch_name="package-release/${{ inputs.package }}/v$major.$minor.x"
+          elif [[ $version =~ ^([0-9]+)\.([0-9]+)b([0-9]+)$ ]]; then
+            # 0.1b1
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            patch="${BASH_REMATCH[3]}"
+            next_version="$major.${minor}b$((patch + 1))"
+            release_branch_name="package-release/${{ inputs.package }}/v$major.${minor}bx"
+          else
+            echo "unexpected version: '$version'"
+            exit 1
+          fi
+
+          if [[ $GITHUB_REF_NAME != $release_branch_name ]]; then
+            echo this workflow should only be run against $release_branch_name branch, but is running on $GITHUB_REF_NAME
+            exit 1
+          fi
+
+          echo "PACKAGE_NAME=${{ inputs.package }}" >> $GITHUB_ENV
+          echo "VERSION=$version" >> $GITHUB_ENV
+          echo "NEXT_VERSION=$next_version" >> $GITHUB_ENV
+          echo "CHANGELOG=$changelog" >> $GITHUB_ENV
+          echo "VERSION_FILE=$version_file" >> $GITHUB_ENV
+
+      - name: Update version
+        run: |
+          # replace the version in the version file (1.2.3 -> 1.2.4)
+          sed -i -E "s/__version__\s*=\s*\"${VERSION}\"/__version__ = \"${NEXT_VERSION}\"/g" $VERSION_FILE
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install tox
+        run: pip install tox
+      - name: run tox
+        run: tox -e generate
+
+      - name: Update the change log with the approximate release date
+        run: |
+          # the actual release date on main will be updated at the end of the release workflow
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Unreleased\n\n## Version ${NEXT_VERSION} ($date)/" ${CHANGELOG}
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          message="Prepare patch release for ${PACKAGE_NAME} v${NEXT_VERSION}"
+          branch="opentelemetrybot/patch-${PACKAGE_NAME}-version-to-v${NEXT_VERSION}"
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          gh pr create --title "[$GITHUB_REF_NAME] $message" \
+                       --body "$message." \
+                       --head $branch \
+                       --base $GITHUB_REF_NAME

.github/workflows/package-prepare-release.yml

@@ -0,0 +1,198 @@
+name: "[Package] Prepare release"
+on:
+  workflow_dispatch:
+    inputs:
+      package:
+        type: choice
+        options:
+        - opentelemetry-propagator-aws-xray
+        - opentelemetry-resource-detector-azure
+        - opentelemetry-sdk-extension-aws
+        - opentelemetry-instrumentation-openai-v2
+        - opentelemetry-instrumentation-vertexai
+        - opentelemetry-instrumentation-google-genai
+        description: 'Package to be released'
+        required: true
+
+run-name: "[Package][${{ inputs.package }}] Prepare release"
+jobs:
+  prereqs:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.verify.outputs.version }}
+      changelog: ${{ steps.verify.outputs.changelog }}
+      version_file: ${{ steps.verify.outputs.version_file }}
+      release_branch_name: ${{ steps.verify.outputs.release_branch_name }}
+      next_version: ${{ steps.verify.outputs.next_version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - id: verify
+        name: Verify prerequisites
+        run: |
+          if [[ $GITHUB_REF_NAME != main ]]; then
+            echo this workflow should only be run against main
+            exit 1
+          fi
+
+          path=./$(./scripts/eachdist.py find-package --package ${{ inputs.package }})
+          changelog=$path/CHANGELOG.md
+
+          if [ ! -f $changelog ]; then
+            echo "missing $changelog file"
+            exit 1
+          fi
+
+          if ! grep --quiet "^## Unreleased$" $changelog; then
+            echo the $changelog is missing an \"Unreleased\" section
+            exit 1
+          fi
+
+          version_dev=$(./scripts/eachdist.py version --package ${{ inputs.package }})
+
+          if [[ ! $version_dev =~ ^([0-9]+)\.([0-9]+)[\.|b]{1}([0-9]+).*.dev$ ]]; then
+            echo "unexpected version: $version"
+            exit 1
+          fi
+
+          version=${version_dev%.dev}
+
+          version_file=$(find $path -type f -path "*version*.py")
+          file_count=$(echo "$version_file" | wc -l)
+
+          if [ "$file_count" -ne 1 ]; then
+            echo "Error: expected one version file, found $file_count"
+            echo "$version_file"
+            exit 1
+          fi
+
+          if [[ $version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+            # 1.2.3 or 1.2.3rc1
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            release_branch_name="package-release/${{ inputs.package }}/v$major.$minor.x"
+            next_version="$major.$((minor + 1)).0"
+          elif [[ $version =~ ^([0-9]+)\.([0-9]+)b([0-9]+)$ ]]; then
+            # 0.1b1
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            release_branch_name="package-release/${{ inputs.package }}/v$major.${minor}bx"
+            next_version="$major.$((minor + 1))b0"
+          else
+            echo "unexpected version: '$version'"
+            exit 1
+          fi
+
+          echo "version=$version" >> $GITHUB_OUTPUT
+          echo "changelog=$changelog" >> $GITHUB_OUTPUT
+          echo "version_file=$version_file" >> $GITHUB_OUTPUT
+          echo "release_branch_name=$release_branch_name" >> $GITHUB_OUTPUT
+          echo "next_version=$next_version" >> $GITHUB_OUTPUT
+
+  create-pull-request-against-release-branch:
+    runs-on: ubuntu-latest
+    needs: prereqs
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables
+        run: |
+          echo "RELEASE_BRANCH_NAME=${{ needs.prereqs.outputs.release_branch_name }}" >> $GITHUB_ENV
+          echo "VERSION=${{ needs.prereqs.outputs.version }}" >> $GITHUB_ENV
+          echo "CHANGELOG=${{ needs.prereqs.outputs.changelog }}" >> $GITHUB_ENV
+          echo "VERSION_FILE=${{ needs.prereqs.outputs.version_file }}" >> $GITHUB_ENV
+          echo "PACKAGE_NAME=${{ github.event.inputs.package }}" >> $GITHUB_ENV
+
+      - name: Create package release branch
+        run: |
+          git push origin HEAD:$RELEASE_BRANCH_NAME
+
+      - name: Update package version
+        run: |
+          # replace the version in the version file (1.2.3dev -> 1.2.3)
+          sed -i -E "s/__version__\s*=\s*\"${VERSION}\.dev\"/__version__ = \"${VERSION}\"/g" $VERSION_FILE
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install tox
+        run: pip install tox
+      - name: run tox
+        run: tox -e generate
+
+      - name: Update the change log with the approximate release date
+        run: |
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Version ${VERSION} ($date)/" ${CHANGELOG}
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request against the release branch
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          message="Prepare release for ${PACKAGE_NAME} v${VERSION}"
+          branch="opentelemetrybot/prepare-${RELEASE_BRANCH_NAME}"
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          gh pr create --title "[$RELEASE_BRANCH_NAME] $message" \
+                       --body "$message." \
+                       --head $branch \
+                       --base $RELEASE_BRANCH_NAME
+
+  create-pull-request-against-main:
+    runs-on: ubuntu-latest
+    needs: prereqs
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables
+        run: |
+          echo "PACKAGE_NAME=${{ github.event.inputs.package }}" >> $GITHUB_ENV
+          echo "VERSION=${{ needs.prereqs.outputs.version }}" >> $GITHUB_ENV
+          echo "VERSION_FILE=${{ needs.prereqs.outputs.version_file }}" >> $GITHUB_ENV
+          echo "NEXT_VERSION=${{ needs.prereqs.outputs.next_version }}" >> $GITHUB_ENV
+          echo "CHANGELOG=${{ needs.prereqs.outputs.changelog }}" >> $GITHUB_ENV
+
+      - name: Update version
+        run: |
+          # replace the version in the version file (1.2.3dev -> 1.3.3.dev)
+          sed -i -E "s/__version__\s*=\s*\"${VERSION}\.dev\"/__version__ = \"${NEXT_VERSION}.dev\"/g" $VERSION_FILE
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install tox
+        run: pip install tox
+      - name: run tox
+        run: tox -e generate
+
+      - name: Update the change log on main
+        run: |
+          # the actual release date on main will be updated at the end of the release workflow
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Unreleased\n\n## Version ${VERSION} ($date)/" ${CHANGELOG}
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request against main
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          message="Update ${PACKAGE_NAME} version to v${NEXT_VERSION}"
+          body="Update \`${PACKAGE_NAME}\` version to v\`${NEXT_VERSION}\`."
+          branch="opentelemetrybot/update-${PACKAGE_NAME}-version-to-v${NEXT_VERSION}"
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          gh pr create --title "$message" \
+                       --body "$body" \
+                       --head $branch \
+                       --base main

.github/workflows/package-release.yml

@@ -0,0 +1,160 @@
+name: "[Package] Release"
+on:
+  workflow_dispatch:
+    inputs:
+      package:
+        type: choice
+        options:
+        - opentelemetry-propagator-aws-xray
+        - opentelemetry-resource-detector-azure
+        - opentelemetry-sdk-extension-aws
+        - opentelemetry-instrumentation-openai-v2
+        - opentelemetry-instrumentation-vertexai
+        - opentelemetry-instrumentation-google-genai
+        description: 'Package to be released'
+        required: true
+run-name: "[Package][${{ inputs.package }}] Release"
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          if [[ $GITHUB_REF_NAME != package-release/${{ inputs.package }}* ]]; then
+            echo this workflow should only be run against package-release/${{ inputs.package }}* branches
+            exit 1
+          fi
+
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables
+        run: |
+          version=$(./scripts/eachdist.py version --package ${{ inputs.package }})
+          if [[ $version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            patch="${BASH_REMATCH[3]}"
+            if [[ $patch != 0 ]]; then
+              prior_version_when_patch="${major}.${minor}.$((patch - 1))"
+            fi
+          elif [[ $version =~ ^([0-9]+)\.([0-9]+)b([0-9]+)$ ]]; then
+            major="${BASH_REMATCH[1]}"
+            minor="${BASH_REMATCH[2]}"
+            patch="${BASH_REMATCH[3]}"
+
+            if [[ $patch != 0 ]]; then
+              prior_version_when_patch="${major}.${minor}b$((patch - 1))"
+            fi
+          else
+            echo "unexpected version: $version"
+            exit 1
+          fi
+
+          path=$(./scripts/eachdist.py find-package --package ${{ inputs.package }})
+          echo "CHANGELOG=./$path/CHANGELOG.md" >> $GITHUB_ENV
+          echo "PACKAGE_NAME=${{ inputs.package }}" >> $GITHUB_ENV
+          echo "VERSION=$version" >> $GITHUB_ENV
+          echo "RELEASE_TAG=${{ inputs.package }}==$version" >> $GITHUB_ENV
+          echo "PRIOR_VERSION_WHEN_PATCH=$prior_version_when_patch" >> $GITHUB_ENV
+
+      # check out main branch to verify there won't be problems with merging the change log
+      # at the end of this workflow
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Check that change log update was merged to main
+        run: |
+          if [[ -z $PRIOR_VERSION_WHEN_PATCH ]]; then
+            # not making a patch release
+            if ! grep --quiet "^## Version ${VERSION}" ${CHANGELOG}; then
+              echo the pull request generated by prepare-release-branch.yml needs to be merged first
+              exit 1
+            fi
+          fi
+
+        # back to the release branch
+      - uses: actions/checkout@v4
+
+        # next few steps publish to pypi
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Build wheels
+        run: ./scripts/build_a_package.sh
+
+      - name: Install twine
+        run: |
+          pip install twine
+
+      # The step below publishes to testpypi in order to catch any issues
+      # with the package configuration that would cause a failure to upload
+      # to pypi. One example of such a failure is if a classifier is
+      # rejected by pypi (e.g "3 - Beta"). This would cause a failure during the
+      # middle of the package upload causing the action to fail, and certain packages
+      # might have already been updated, this would be bad.
+      # EDIT: 5/31/2024 - TestPypi now requires a verified email. Commenting out as a temporary measure
+      # until we found TestPypi credentials.
+      # - name: Publish to TestPyPI
+      #   env:
+      #     TWINE_USERNAME: '__token__'
+      #     TWINE_PASSWORD: ${{ secrets.test_pypi_token }}
+      #   run: |
+      #     twine upload --repository testpypi --skip-existing --verbose dist/*
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: '__token__'
+          TWINE_PASSWORD: ${{ secrets.pypi_password }}
+        run: |
+          twine upload --skip-existing --verbose dist/*
+
+      - name: Generate release notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./scripts/generate_release_notes.sh
+
+      - name: Create GitHub release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create --target $GITHUB_REF_NAME \
+                            --title "${PACKAGE_NAME} ${VERSION}" \
+                            --notes-file /tmp/release-notes.txt \
+                            --discussion-category announcements \
+                            $RELEASE_TAG
+
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Copy change log updates to main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./scripts/merge_changelog_to_main.sh
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request against main
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          message="Copy changelog updates from $GITHUB_REF_NAME"
+          body="Copy changelog updates from \`$GITHUB_REF_NAME\`."
+          branch="opentelemetrybot/changelog-${GITHUB_REF_NAME//\//-}"
+
+          if [[ -z $PRIOR_VERSION_WHEN_PATCH ]]; then
+            if git diff --quiet; then
+              echo there are no updates needed to the change log on main, not creating pull request
+              exit 0 # success
+            fi
+          fi
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          gh pr create --title "$message" \
+                       --body "$body" \
+                       --head $branch \
+                       --base main

.github/workflows/prepare-patch-release.yml

@@ -0,0 +1,95 @@
+name: Prepare patch release
+on:
+  workflow_dispatch:
+
+jobs:
+  prepare-patch-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: |
+          if [[ ! $GITHUB_REF_NAME =~ ^release/v[0-9]+\.[0-9]+\.x-0\.[0-9]+bx$ ]]; then
+            echo this workflow should only be run against long-term release branches
+            exit 1
+          fi
+
+          if ! grep --quiet "^## Unreleased$" CHANGELOG.md; then
+            echo the change log is missing an \"Unreleased\" section
+            exit 1
+          fi
+
+      - name: Set environment variables
+        run: |
+          stable_version=$(./scripts/eachdist.py version --mode stable)
+          unstable_version=$(./scripts/eachdist.py version --mode prerelease)
+
+          if [[ $stable_version =~ ^([0-9]+\.[0-9]+)\.([0-9]+)$ ]]; then
+            stable_major_minor="${BASH_REMATCH[1]}"
+            stable_patch="${BASH_REMATCH[2]}"
+          else
+            echo "unexpected stable_version: $stable_version"
+            exit 1
+          fi
+
+          if [[ $unstable_version =~ ^0\.([0-9]+)b([0-9]+)$ ]]; then
+            unstable_minor="${BASH_REMATCH[1]}"
+            unstable_patch="${BASH_REMATCH[2]}"
+          else
+            echo "unexpected unstable_version: $unstable_version"
+            exit 1
+          fi
+
+          stable_version_prev="$stable_major_minor.$((stable_patch))"
+          unstable_version_prev="0.${unstable_minor}b$((unstable_patch))"
+          stable_version="$stable_major_minor.$((stable_patch + 1))"
+          unstable_version="0.${unstable_minor}b$((unstable_patch + 1))"
+
+          echo "STABLE_VERSION=$stable_version" >> $GITHUB_ENV
+          echo "UNSTABLE_VERSION=$unstable_version" >> $GITHUB_ENV
+          echo "STABLE_VERSION_PREV=$stable_version_prev" >> $GITHUB_ENV
+          echo "UNSTABLE_VERSION_PREV=$unstable_version_prev" >> $GITHUB_ENV
+
+      - name: Update version
+        run: .github/scripts/update-version-patch.sh $STABLE_VERSION $UNSTABLE_VERSION $STABLE_VERSION_PREV $UNSTABLE_VERSION_PREV
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install tox
+        run: pip install tox
+      - name: run tox
+        run: tox -e generate
+
+      - name: Update the change log with the approximate release date
+        run: |
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Version ${STABLE_VERSION}\/${UNSTABLE_VERSION} ($date)/" CHANGELOG.md
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request
+        id: create_pr
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          message="Prepare release ${STABLE_VERSION}/${UNSTABLE_VERSION}"
+          branch="opentelemetrybot/prepare-release-${STABLE_VERSION}-${UNSTABLE_VERSION}"
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          pr_url=$(gh pr create --title "[$GITHUB_REF_NAME] $message" \
+                       --body "$message." \
+                       --head $branch \
+                       --base $GITHUB_REF_NAME)
+          echo "pr_url=$pr_url" >> $GITHUB_OUTPUT
+
+      - name: Add prepare-release label to PR
+        if: steps.create_pr.outputs.pr_url != ''
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr edit ${{ steps.create_pr.outputs.pr_url }}  --add-label "prepare-release"

.github/workflows/prepare-release-branch.yml

@@ -0,0 +1,213 @@
+name: Prepare release branch
+on:
+  workflow_dispatch:
+    inputs:
+      prerelease_version:
+        description: "Pre-release version number? (e.g. 1.9.0rc2)"
+        required: false
+
+jobs:
+  prereqs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Verify prerequisites
+        env:
+          PRERELEASE_VERSION: ${{ github.event.inputs.prerelease_version }}
+        run: |
+          if [[ $GITHUB_REF_NAME != main ]]; then
+            echo this workflow should only be run against main
+            exit 1
+          fi
+
+          if ! grep --quiet "^## Unreleased$" CHANGELOG.md; then
+            echo the change log is missing an \"Unreleased\" section
+            exit 1
+          fi
+
+          if [[ ! -z $PRERELEASE_VERSION ]]; then
+            stable_version=$(./scripts/eachdist.py version --mode stable)
+            stable_version=${stable_version//.dev/}
+            if [[ $PRERELEASE_VERSION != ${stable_version}* ]]; then
+              echo "$PRERELEASE_VERSION is not a prerelease for the version on main ($stable_version)"
+              exit 1
+            fi
+          fi
+
+  create-pull-request-against-release-branch:
+    runs-on: ubuntu-latest
+    needs: prereqs
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create release branch
+        env:
+          PRERELEASE_VERSION: ${{ github.event.inputs.prerelease_version }}
+        run: |
+          if [[ -z $PRERELEASE_VERSION ]]; then
+            stable_version=$(./scripts/eachdist.py version --mode stable)
+            stable_version=${stable_version//.dev/}
+          else
+            stable_version=$PRERELEASE_VERSION
+          fi
+
+          unstable_version=$(./scripts/eachdist.py version --mode prerelease)
+          unstable_version=${unstable_version//.dev/}
+
+          if [[ $stable_version =~ ^([0-9]+)\.([0-9]+)\.0$ ]]; then
+            stable_version_branch_part=$(echo $stable_version | sed -E 's/([0-9]+)\.([0-9]+)\.0/\1.\2.x/')
+            unstable_version_branch_part=$(echo $unstable_version | sed -E 's/0\.([0-9]+)b0/0.\1bx/')
+            release_branch_name="release/v${stable_version_branch_part}-${unstable_version_branch_part}"
+          elif [[ $stable_version =~ ^([0-9]+)\.([0-9]+)\.0 ]]; then
+            # pre-release version, e.g. 1.9.0rc2
+            release_branch_name="release/v$stable_version-$unstable_version"
+          else
+            echo "unexpected version: $stable_version"
+            exit 1
+          fi
+
+          git push origin HEAD:$release_branch_name
+
+          echo "STABLE_VERSION=$stable_version" >> $GITHUB_ENV
+          echo "UNSTABLE_VERSION=$unstable_version" >> $GITHUB_ENV
+          echo "RELEASE_BRANCH_NAME=$release_branch_name" >> $GITHUB_ENV
+
+      - name: Update version
+        run: .github/scripts/update-version.sh $STABLE_VERSION $UNSTABLE_VERSION
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install tox
+        run: pip install tox
+      - name: run tox
+        run: tox -e generate
+
+      - name: Update the change log with the approximate release date
+        run: |
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Version ${STABLE_VERSION}\/${UNSTABLE_VERSION} ($date)/" CHANGELOG.md
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request against the release branch
+        id: create_release_branch_pr
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          message="Prepare release ${STABLE_VERSION}/${UNSTABLE_VERSION}"
+          branch="opentelemetrybot/prepare-release-${STABLE_VERSION}-${UNSTABLE_VERSION}"
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          pr_url=$(gh pr create --title "[$RELEASE_BRANCH_NAME] $message" \
+                       --body "$message." \
+                       --head $branch \
+                       --base $RELEASE_BRANCH_NAME)
+          echo "pr_url=$pr_url" >> $GITHUB_OUTPUT
+
+      - name: Add prepare-release label to PR
+        if: steps.create_release_branch_pr.outputs.pr_url != ''
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr edit ${{ steps.create_release_branch_pr.outputs.pr_url }}  --add-label "prepare-release"
+
+  create-pull-request-against-main:
+    runs-on: ubuntu-latest
+    needs: prereqs
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables
+        env:
+          PRERELEASE_VERSION: ${{ github.event.inputs.prerelease_version }}
+        run: |
+          if [[ -z $PRERELEASE_VERSION ]]; then
+            stable_version=$(./scripts/eachdist.py version --mode stable)
+            stable_version=${stable_version//.dev/}
+          else
+            stable_version=$PRERELEASE_VERSION
+          fi
+
+          unstable_version=$(./scripts/eachdist.py version --mode prerelease)
+          unstable_version=${unstable_version//.dev/}
+
+          if [[ $stable_version =~ ^([0-9]+)\.([0-9]+)\.0$ ]]; then
+            stable_major="${BASH_REMATCH[1]}"
+            stable_minor="${BASH_REMATCH[2]}"
+            stable_next_version="$stable_major.$((stable_minor + 1)).0"
+          elif [[ $stable_version =~ ^([0-9]+)\.([0-9]+)\.0 ]]; then
+            # pre-release version, e.g. 1.9.0rc2
+            stable_major="${BASH_REMATCH[1]}"
+            stable_minor="${BASH_REMATCH[2]}"
+            stable_next_version="$stable_major.$stable_minor.0"
+          else
+            echo "unexpected stable_version: $stable_version"
+            exit 1
+          fi
+
+          if [[ $unstable_version =~ ^0\.([0-9]+)b[0-9]+$ ]]; then
+            unstable_minor="${BASH_REMATCH[1]}"
+          else
+            echo "unexpected unstable_version: $unstable_version"
+            exit 1
+          fi
+
+          unstable_next_version="0.$((unstable_minor + 1))b0"
+
+          echo "STABLE_VERSION=${stable_version}" >> $GITHUB_ENV
+          echo "STABLE_NEXT_VERSION=${stable_next_version}.dev" >> $GITHUB_ENV
+
+          echo "UNSTABLE_VERSION=${unstable_version}" >> $GITHUB_ENV
+          echo "UNSTABLE_NEXT_VERSION=${unstable_next_version}.dev" >> $GITHUB_ENV
+
+      - name: Update version
+        run: .github/scripts/update-version.sh $STABLE_NEXT_VERSION $UNSTABLE_NEXT_VERSION
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install tox
+        run: pip install tox
+      - name: run tox
+        run: tox -e generate
+
+      - name: Update the change log on main
+        run: |
+          # the actual release date on main will be updated at the end of the release workflow
+          date=$(date "+%Y-%m-%d")
+          sed -Ei "s/^## Unreleased$/## Unreleased\n\n## Version ${STABLE_VERSION}\/${UNSTABLE_VERSION} ($date)/" CHANGELOG.md
+
+      - name: Use CLA approved github bot
+        run: .github/scripts/use-cla-approved-github-bot.sh
+
+      - name: Create pull request against main
+        id: create_main_pr
+        env:
+          # not using secrets.GITHUB_TOKEN since pull requests from that token do not run workflows
+          GITHUB_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
+        run: |
+          message="Update version to ${STABLE_NEXT_VERSION}/${UNSTABLE_NEXT_VERSION}"
+          body="Update version to \`${STABLE_NEXT_VERSION}/${UNSTABLE_NEXT_VERSION}\`."
+          branch="opentelemetrybot/update-version-to-${STABLE_NEXT_VERSION}-${UNSTABLE_NEXT_VERSION}"
+
+          git commit -a -m "$message"
+          git push origin HEAD:$branch
+          pr_url=$(gh pr create --title "$message" \
+                       --body "$body" \
+                       --head $branch \
+                       --base main)
+          echo "pr_url=$pr_url" >> $GITHUB_OUTPUT
+
+      - name: Add prepare-release label to PR
+        if: steps.create_main_pr.outputs.pr_url != ''
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr edit ${{ steps.create_main_pr.outputs.pr_url }}  --add-label "prepare-release"

.github/workflows/publish-a-package.yml

@@ -1,31 +0,0 @@
-name: Publish a Package from Tag
-
-on:
-  push:
-    tags:
-      - 'opentelemetry-*==[1-9]*.*'
-
-jobs:
-  publish-a-package:
-    name: Publish package from tag
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: actions/setup-python@v1
-      with:
-        python-version: '3.9'
-    - name: Log tag that triggered publish workflow
-      run:  echo "Attempting to publish package from tag $GITHUB_REF"
-    - name: Build wheel for tag
-      run: ./scripts/build_a_package.sh
-    - name: Install twine
-      run: |
-        pip install twine
-    # We don't need to publish to TestPyPI because we only publish 1 package.
-    # If it fails no other work needs to be reversed.
-    - name: Publish to PyPI
-      env:
-        TWINE_USERNAME: '__token__'
-        TWINE_PASSWORD: ${{ secrets.pypi_password }}
-      run: |
-        twine upload --skip-existing --verbose dist/*

.github/workflows/publish.yml

@@ -1,37 +0,0 @@
-name: Publish
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: actions/setup-python@v1
-      with:
-        python-version: '3.7'
-    - name: Build wheels
-      run: ./scripts/build.sh
-    - name: Install twine
-      run: |
-        pip install twine
-    # The step below publishes to testpypi in order to catch any issues
-    # with the package configuration that would cause a failure to upload
-    # to pypi. One example of such a failure is if a classifier is
-    # rejected by pypi (e.g "3 - Beta"). This would cause a failure during the
-    # middle of the package upload causing the action to fail, and certain packages
-    # might have already been updated, this would be bad.
-    - name: Publish to TestPyPI
-      env:
-        TWINE_USERNAME: '__token__'
-        TWINE_PASSWORD: ${{ secrets.test_pypi_token }}
-      run: |
-        twine upload --repository testpypi --skip-existing --verbose dist/*
-    - name: Publish to PyPI
-      env:
-        TWINE_USERNAME: '__token__'
-        TWINE_PASSWORD: ${{ secrets.pypi_password }}
-      run: |
-        twine upload --skip-existing --verbose dist/*

.github/workflows/release.yml

@@ -0,0 +1,120 @@
+name: Release
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          if [[ $GITHUB_REF_NAME != release/* ]]; then
+            echo this workflow should only be run against release branches
+            exit 1
+          fi
+
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables
+        run: |
+          stable_version=$(./scripts/eachdist.py version --mode stable)
+          unstable_version=$(./scripts/eachdist.py version --mode prerelease)
+
+          if [[ $stable_version =~ ^([0-9]+)\.([0-9]+)\.([0-9]+) ]]; then
+            stable_major="${BASH_REMATCH[1]}"
+            stable_minor="${BASH_REMATCH[2]}"
+            stable_patch="${BASH_REMATCH[3]}"
+          else
+            echo "unexpected stable_version: $stable_version"
+            exit 1
+          fi
+          if [[ $stable_patch != 0 ]]; then
+            if [[ $unstable_version =~ ^0\.([0-9]+)b([0-9]+)$ ]]; then
+              unstable_minor="${BASH_REMATCH[1]}"
+              unstable_patch="${BASH_REMATCH[2]}"
+            else
+              echo "unexpected unstable_version: $unstable_version"
+              exit 1
+            fi
+            if [[ $unstable_patch != 0 ]]; then
+              prior_version_when_patch="$stable_major.$stable_minor.$((stable_patch - 1))/0.${unstable_minor}b$((unstable_patch - 1))"
+            fi
+          fi
+
+          echo "STABLE_VERSION=$stable_version" >> $GITHUB_ENV
+          echo "UNSTABLE_VERSION=$unstable_version" >> $GITHUB_ENV
+          echo "CHANGELOG=CHANGELOG.md" >> $GITHUB_ENV
+          echo "PRIOR_VERSION_WHEN_PATCH=$prior_version_when_patch" >> $GITHUB_ENV
+
+      - run: |
+          if [[ -z $PRIOR_VERSION_WHEN_PATCH ]]; then
+            # not making a patch release
+            if ! grep --quiet "^## Version ${STABLE_VERSION}/${UNSTABLE_VERSION} " CHANGELOG.md; then
+              echo the pull request generated by prepare-release-branch.yml needs to be merged first
+              exit 1
+            fi
+          fi
+
+      # check out main branch to verify there won't be problems with merging the change log
+      # at the end of this workflow
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+
+        # back to the release branch
+      - uses: actions/checkout@v4
+
+        # next few steps publish to pypi
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Build wheels
+        run: ./scripts/build.sh
+
+      - name: Install twine
+        run: |
+          pip install twine
+
+      # The step below publishes to testpypi in order to catch any issues
+      # with the package configuration that would cause a failure to upload
+      # to pypi. One example of such a failure is if a classifier is
+      # rejected by pypi (e.g "3 - Beta"). This would cause a failure during the
+      # middle of the package upload causing the action to fail, and certain packages
+      # might have already been updated, this would be bad.
+
+      - name: Publish to TestPyPI
+        env:
+          TWINE_USERNAME: '__token__'
+          TWINE_PASSWORD: ${{ secrets.test_pypi_token }}
+        run: |
+          twine upload --repository testpypi --skip-existing --verbose dist/*
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: '__token__'
+          TWINE_PASSWORD: ${{ secrets.pypi_password }}
+        run: |
+          twine upload --skip-existing --verbose dist/*
+
+      - name: Generate release notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          echo "VERSION=${STABLE_VERSION}\/${UNSTABLE_VERSION}" >> $GITHUB_ENV
+          ./scripts/generate_release_notes.sh
+
+      - name: Create GitHub release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create --target $GITHUB_REF_NAME \
+                            --title "Version ${STABLE_VERSION}/${UNSTABLE_VERSION}" \
+                            --notes-file /tmp/release-notes.txt \
+                            --discussion-category announcements \
+                            v$UNSTABLE_VERSION
+
+      - uses: actions/checkout@v4
+        with:
+          # the step below is creating a pull request against main
+          ref: main
+

.github/workflows/test.yml

@@ -1,103 +0,0 @@
-name: Contrib Repo Tests
-
-on:
-  push:
-    branches-ignore:
-    - 'release/*'
-  pull_request:
-env:
-  CORE_REPO_SHA: 82a40052d2a49615b745fcbc890c9aabd6f88140
-
-jobs:
-  build:
-    env:
-      # We use these variables to convert between tox and GHA version literals
-      py36: 3.6
-      py37: 3.7
-      py38: 3.8
-      py39: 3.9
-      py310: "3.10"
-      pypy3: pypy3
-      RUN_MATRIX_COMBINATION: ${{ matrix.python-version }}-${{ matrix.package }}-${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
-      matrix:
-        python-version: [ py36, py37, py38, py39, py310, pypy3 ]
-        package: ["instrumentation", "distro", "exporter", "sdkextension", "propagator"]
-        os: [ ubuntu-20.04 ]
-    steps:
-      - name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
-        uses: actions/checkout@v2
-      - name: Set up Python ${{ env[matrix.python-version] }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ env[matrix.python-version] }}
-      - name: Install tox
-        run: pip install -U tox-factor
-      - name: Cache tox environment
-        # Preserves .tox directory between runs for faster installs
-        uses: actions/cache@v2
-        with:
-          path: |
-            .tox
-            ~/.cache/pip
-          key: v4-build-tox-cache-${{ env.RUN_MATRIX_COMBINATION }}-${{ hashFiles('tox.ini', 'gen-requirements.txt', 'dev-requirements.txt') }}
-      - name: run tox
-        run: tox -f ${{ matrix.python-version }}-${{ matrix.package }} -- --benchmark-json=${{ env.RUN_MATRIX_COMBINATION }}-benchmark.json
-      - name: Find and merge benchmarks
-        # TODO: Add at least one benchmark to every package type to remove this (#249)
-        if: matrix.package == 'sdkextension'
-        run: >-
-          jq -s '.[0].benchmarks = ([.[].benchmarks] | add)
-          | if .[0].benchmarks == null then null else .[0] end'
-          **/**/tests/*${{ matrix.package }}*-benchmark.json > output.json
-      - name: Report on benchmark results
-        # TODO: Add at least one benchmark to every package type to remove this (#249)
-        if: matrix.package == 'sdkextension'
-        uses: rhysd/github-action-benchmark@v1
-        with:
-          name: OpenTelemetry Python Benchmarks - Python ${{ env[matrix.python-version ]}} - ${{ matrix.package }}
-          tool: pytest
-          output-file-path: output.json
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          max-items-in-chart: 100
-          # Alert with a commit comment on possible performance regression
-          alert-threshold: 200%
-          fail-on-alert: true
-          # Make a commit on `gh-pages` with benchmarks from previous step
-          auto-push: ${{ github.ref == 'refs/heads/main' }}
-          gh-pages-branch: gh-pages
-          benchmark-data-dir-path: benchmarks
-  misc:
-    strategy:
-      fail-fast: false
-      matrix:
-        tox-environment: [ "docker-tests", "lint", "docs", "generate" ]
-    name: ${{ matrix.tox-environment }}
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
-        uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - name: Install tox
-        run: pip install -U tox
-      - name: Install libsnappy-dev
-        if: ${{ matrix.tox-environment == 'lint' }}
-        run: sudo apt-get install -y libsnappy-dev
-      - name: Cache tox environment
-        # Preserves .tox directory between runs for faster installs
-        uses: actions/cache@v2
-        with:
-          path: |
-            .tox
-            ~/.cache/pip
-          key: v4-misc-tox-cache-${{ matrix.tox-environment }}-${{ hashFiles('tox.ini', 'dev-requirements.txt', 'gen-requirements.txt', 'docs-requirements.txt') }}
-      - name: run tox
-        run: tox -e ${{ matrix.tox-environment }}
-      - name: Ensure generated code is up to date
-        if: matrix.tox-environment == 'generate'
-        run: git diff --exit-code || (echo 'Generated code is out of date, please run "tox -e generate" and commit the changes in this PR.' && exit 1)

.github/workflows/test_2.yml

@@ -0,0 +1,960 @@
+# Do not edit this file.
+# This file is generated automatically by executing tox -e generate-workflows
+
+name: Test 2
+
+on:
+  push:
+    branches-ignore:
+    - 'release/*'
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  # Set the SHA to the branch name if the PR has a label 'prepare-release' or 'backport' otherwise, set it to 'main'
+  # For PRs you can change the inner fallback ('main')
+  # For pushes you change the outer fallback ('main')
+  # The logic below is used during releases and depends on having an equivalent branch name in the core repo.
+  CORE_REPO_SHA: ${{ github.event_name == 'pull_request' && (
+       contains(github.event.pull_request.labels.*.name, 'prepare-release') && github.event.pull_request.head.ref ||
+       contains(github.event.pull_request.labels.*.name, 'backport') && github.event.pull_request.base.ref ||
+       'main'
+    ) || 'main' }}
+  CONTRIB_REPO_SHA: main
+  PIP_EXISTS_ACTION: w
+
+jobs:
+
+  py312-test-instrumentation-aio-pika-1_ubuntu-latest:
+    name: instrumentation-aio-pika-1 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-aio-pika-1 -- -ra
+
+  py312-test-instrumentation-aio-pika-2_ubuntu-latest:
+    name: instrumentation-aio-pika-2 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-aio-pika-2 -- -ra
+
+  py312-test-instrumentation-aio-pika-3_ubuntu-latest:
+    name: instrumentation-aio-pika-3 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-aio-pika-3 -- -ra
+
+  py313-test-instrumentation-aio-pika-0_ubuntu-latest:
+    name: instrumentation-aio-pika-0 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-aio-pika-0 -- -ra
+
+  py313-test-instrumentation-aio-pika-1_ubuntu-latest:
+    name: instrumentation-aio-pika-1 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-aio-pika-1 -- -ra
+
+  py313-test-instrumentation-aio-pika-2_ubuntu-latest:
+    name: instrumentation-aio-pika-2 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-aio-pika-2 -- -ra
+
+  py313-test-instrumentation-aio-pika-3_ubuntu-latest:
+    name: instrumentation-aio-pika-3 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-aio-pika-3 -- -ra
+
+  pypy3-test-instrumentation-aio-pika-0_ubuntu-latest:
+    name: instrumentation-aio-pika-0 pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-aio-pika-0 -- -ra
+
+  pypy3-test-instrumentation-aio-pika-1_ubuntu-latest:
+    name: instrumentation-aio-pika-1 pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-aio-pika-1 -- -ra
+
+  pypy3-test-instrumentation-aio-pika-2_ubuntu-latest:
+    name: instrumentation-aio-pika-2 pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-aio-pika-2 -- -ra
+
+  pypy3-test-instrumentation-aio-pika-3_ubuntu-latest:
+    name: instrumentation-aio-pika-3 pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-aio-pika-3 -- -ra
+
+  py39-test-instrumentation-aiokafka_ubuntu-latest:
+    name: instrumentation-aiokafka 3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py39-test-instrumentation-aiokafka -- -ra
+
+  py310-test-instrumentation-aiokafka_ubuntu-latest:
+    name: instrumentation-aiokafka 3.10 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py310-test-instrumentation-aiokafka -- -ra
+
+  py311-test-instrumentation-aiokafka_ubuntu-latest:
+    name: instrumentation-aiokafka 3.11 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py311-test-instrumentation-aiokafka -- -ra
+
+  py312-test-instrumentation-aiokafka_ubuntu-latest:
+    name: instrumentation-aiokafka 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-aiokafka -- -ra
+
+  py313-test-instrumentation-aiokafka_ubuntu-latest:
+    name: instrumentation-aiokafka 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-aiokafka -- -ra
+
+  pypy3-test-instrumentation-aiokafka_ubuntu-latest:
+    name: instrumentation-aiokafka pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-aiokafka -- -ra
+
+  py39-test-instrumentation-kafka-python_ubuntu-latest:
+    name: instrumentation-kafka-python 3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py39-test-instrumentation-kafka-python -- -ra
+
+  py310-test-instrumentation-kafka-python_ubuntu-latest:
+    name: instrumentation-kafka-python 3.10 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py310-test-instrumentation-kafka-python -- -ra
+
+  py311-test-instrumentation-kafka-python_ubuntu-latest:
+    name: instrumentation-kafka-python 3.11 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py311-test-instrumentation-kafka-python -- -ra
+
+  py39-test-instrumentation-kafka-pythonng_ubuntu-latest:
+    name: instrumentation-kafka-pythonng 3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py39-test-instrumentation-kafka-pythonng -- -ra
+
+  py310-test-instrumentation-kafka-pythonng_ubuntu-latest:
+    name: instrumentation-kafka-pythonng 3.10 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py310-test-instrumentation-kafka-pythonng -- -ra
+
+  py311-test-instrumentation-kafka-pythonng_ubuntu-latest:
+    name: instrumentation-kafka-pythonng 3.11 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py311-test-instrumentation-kafka-pythonng -- -ra
+
+  py312-test-instrumentation-kafka-pythonng_ubuntu-latest:
+    name: instrumentation-kafka-pythonng 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-kafka-pythonng -- -ra
+
+  py313-test-instrumentation-kafka-pythonng_ubuntu-latest:
+    name: instrumentation-kafka-pythonng 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-kafka-pythonng -- -ra
+
+  pypy3-test-instrumentation-kafka-python_ubuntu-latest:
+    name: instrumentation-kafka-python pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-kafka-python -- -ra
+
+  pypy3-test-instrumentation-kafka-pythonng_ubuntu-latest:
+    name: instrumentation-kafka-pythonng pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-kafka-pythonng -- -ra
+
+  py39-test-instrumentation-confluent-kafka_ubuntu-latest:
+    name: instrumentation-confluent-kafka 3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py39-test-instrumentation-confluent-kafka -- -ra
+
+  py310-test-instrumentation-confluent-kafka_ubuntu-latest:
+    name: instrumentation-confluent-kafka 3.10 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py310-test-instrumentation-confluent-kafka -- -ra
+
+  py311-test-instrumentation-confluent-kafka_ubuntu-latest:
+    name: instrumentation-confluent-kafka 3.11 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py311-test-instrumentation-confluent-kafka -- -ra
+
+  py312-test-instrumentation-confluent-kafka_ubuntu-latest:
+    name: instrumentation-confluent-kafka 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-confluent-kafka -- -ra
+
+  py313-test-instrumentation-confluent-kafka_ubuntu-latest:
+    name: instrumentation-confluent-kafka 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-confluent-kafka -- -ra
+
+  py39-test-instrumentation-asyncio_ubuntu-latest:
+    name: instrumentation-asyncio 3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py39-test-instrumentation-asyncio -- -ra
+
+  py310-test-instrumentation-asyncio_ubuntu-latest:
+    name: instrumentation-asyncio 3.10 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py310-test-instrumentation-asyncio -- -ra
+
+  py311-test-instrumentation-asyncio_ubuntu-latest:
+    name: instrumentation-asyncio 3.11 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py311-test-instrumentation-asyncio -- -ra
+
+  py312-test-instrumentation-asyncio_ubuntu-latest:
+    name: instrumentation-asyncio 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-asyncio -- -ra
+
+  py313-test-instrumentation-asyncio_ubuntu-latest:
+    name: instrumentation-asyncio 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-asyncio -- -ra
+
+  py39-test-instrumentation-cassandra_ubuntu-latest:
+    name: instrumentation-cassandra 3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py39-test-instrumentation-cassandra -- -ra
+
+  py310-test-instrumentation-cassandra_ubuntu-latest:
+    name: instrumentation-cassandra 3.10 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py310-test-instrumentation-cassandra -- -ra
+
+  py311-test-instrumentation-cassandra_ubuntu-latest:
+    name: instrumentation-cassandra 3.11 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py311-test-instrumentation-cassandra -- -ra
+
+  py312-test-instrumentation-cassandra_ubuntu-latest:
+    name: instrumentation-cassandra 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-instrumentation-cassandra -- -ra
+
+  py313-test-instrumentation-cassandra_ubuntu-latest:
+    name: instrumentation-cassandra 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-instrumentation-cassandra -- -ra
+
+  pypy3-test-instrumentation-cassandra_ubuntu-latest:
+    name: instrumentation-cassandra pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-instrumentation-cassandra -- -ra
+
+  py39-test-processor-baggage_ubuntu-latest:
+    name: processor-baggage 3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py39-test-processor-baggage -- -ra
+
+  py310-test-processor-baggage_ubuntu-latest:
+    name: processor-baggage 3.10 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py310-test-processor-baggage -- -ra
+
+  py311-test-processor-baggage_ubuntu-latest:
+    name: processor-baggage 3.11 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py311-test-processor-baggage -- -ra
+
+  py312-test-processor-baggage_ubuntu-latest:
+    name: processor-baggage 3.12 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py312-test-processor-baggage -- -ra
+
+  py313-test-processor-baggage_ubuntu-latest:
+    name: processor-baggage 3.13 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e py313-test-processor-baggage -- -ra
+
+  pypy3-test-processor-baggage_ubuntu-latest:
+    name: processor-baggage pypy-3.9 Ubuntu
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python pypy-3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: "pypy-3.9"
+
+      - name: Install tox
+        run: pip install tox-uv
+
+      - name: Run tests
+        run: tox -e pypy3-test-processor-baggage -- -ra

.gitignore

@@ -58,3 +58,6 @@ _build/
 # mypy
 .mypy_cache/
 target
+
+# Benchmark result files
+*-benchmark.json

.isort.cfg

@@ -1,19 +0,0 @@
-[settings]
-include_trailing_comma=True
-force_grid_wrap=0
-use_parentheses=True
-line_length=79
-profile=black
-
-; 3 stands for Vertical Hanging Indent, e.g.
-; from third_party import (
-;     lib1,
-;     lib2,
-;     lib3,
-; )
-; docs: https://github.com/timothycrosley/isort#multi-line-output-modes
-multi_line_output=3
-skip=target
-skip_glob=**/gen/*,.venv*/*,venv*/*,.tox/*
-known_first_party=opentelemetry
-known_third_party=psutil,pytest,redis,redis_opentracing

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.6.9
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.6.0
+    hooks:
+      - id: uv-lock

.pylintrc

@@ -3,15 +3,16 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
-extension-pkg-whitelist=
+extension-pkg-whitelist=cassandra
 
 # Add list of files or directories to be excluded. They should be base names, not
 # paths.
-ignore=CVS,gen,Dockerfile,docker-compose.yml,README.md,requirements.txt
+ignore=CVS,gen,Dockerfile,docker-compose.yml,README.md,requirements.txt,docs,.venv,site-packages,.tox
 
 # Add files or directories matching the regex patterns to be excluded. The
 # regex matches against base names, not paths.
 ignore-patterns=
+ignore-paths=
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
@@ -28,7 +29,7 @@ limit-inference-results=100
 
 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
-load-plugins=
+load-plugins=pylint.extensions.no_self_use
 
 # Pickle collected data for later comparisons.
 persistent=yes
@@ -44,6 +45,9 @@ suggestion-mode=yes
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no
 
+# Run python dependant checks considering the baseline version
+py-version=3.9
+
 
 [MESSAGES CONTROL]
 
@@ -68,7 +72,6 @@ disable=missing-docstring,
       duplicate-code,
       ungrouped-imports, # Leave this up to isort
       wrong-import-order, # Leave this up to isort
-      bad-continuation, # Leave this up to black
       line-too-long, # Leave this up to black
       exec-used,
       super-with-arguments, # temp-pylint-upgrade
@@ -80,6 +83,8 @@ disable=missing-docstring,
       invalid-overridden-method, # temp-pylint-upgrade 
       missing-module-docstring, # temp-pylint-upgrade
       import-error, # needed as a workaround as reported here: https://github.com/open-telemetry/opentelemetry-python-contrib/issues/290
+      cyclic-import,
+      not-context-manager
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -267,13 +272,6 @@ max-line-length=79
 # Maximum number of lines in a module.
 max-module-lines=1000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no
@@ -497,4 +495,4 @@ min-public-methods=2
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception".
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception

.readthedocs.yml

@@ -6,9 +6,10 @@ sphinx:
   configuration: docs/conf.py
 
 build:
-  image: latest
+  os: "ubuntu-24.04"
+  tools:
+    python: "3.11"
 
 python:
-  version: 3.8
   install:
-    - requirements: docs-requirements.txt
+    - requirements: rtd-requirements.txt

CONTRIBUTING.md

@@ -13,7 +13,39 @@ on how to become a [**Member**](https://github.com/open-telemetry/community/blob
 [**Approver**](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver)
 and [**Maintainer**](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).
 
-## Find a Buddy and get Started Quickly!
+Before you can contribute, you will need to sign the [Contributor License Agreement](https://docs.linuxfoundation.org/lfx/easycla/contributors).
+
+Please also read the [OpenTelemetry Contributor Guide](https://github.com/open-telemetry/community/blob/main/guides/contributor/README.md).
+
+## Index
+
+- [Contributing to opentelemetry-python-contrib](#contributing-to-opentelemetry-python-contrib)
+  - [Index](#index)
+  - [Find a Buddy and get Started Quickly](#find-a-buddy-and-get-started-quickly)
+  - [Development](#development)
+    - [Virtual Environment](#virtual-environment)
+    - [Troubleshooting](#troubleshooting)
+    - [Benchmarks](#benchmarks)
+  - [Pull Requests](#pull-requests)
+    - [How to Send Pull Requests](#how-to-send-pull-requests)
+    - [How to Receive Comments](#how-to-receive-comments)
+    - [How to Get PRs Reviewed](#how-to-get-prs-reviewed)
+    - [How to Get PRs Merged](#how-to-get-prs-merged)
+  - [Design Choices](#design-choices)
+    - [Focus on Capabilities, Not Structure Compliance](#focus-on-capabilities-not-structure-compliance)
+  - [Running Tests Locally](#running-tests-locally)
+    - [Testing against a different Core repo branch/commit](#testing-against-a-different-core-repo-branchcommit)
+  - [Style Guide](#style-guide)
+  - [Guideline for instrumentations](#guideline-for-instrumentations)
+    - [Update supported instrumentation package versions](#update-supported-instrumentation-package-versions)
+  - [Guideline for GenAI instrumentations](#guideline-for-genai-instrumentations)
+    - [Get Involved](#get-involved)
+  - [Expectations from contributors](#expectations-from-contributors)
+  - [Updating supported Python versions](#updating-supported-python-versions)
+    - [Bumping the Python baseline](#bumping-the-python-baseline)
+    - [Adding support for a new Python release](#adding-support-for-a-new-python-release)
+
+## Find a Buddy and get Started Quickly
 
 If you are looking for someone to help you find a starting point and be a resource for your first contribution, join our
 Slack and find a buddy!
@@ -27,33 +59,71 @@ context, reviewing PRs, and helping those get merged. Buddies will not be availa
 
 ## Development
 
-To quickly get up and running, you can use the `scripts/eachdist.py` tool that
-ships with this project. First create a virtualenv and activate it.
-Then run `python scripts/eachdist.py develop` to install all required packages
-as well as the project's packages themselves (in `--editable` mode).
-You can then run `scripts/eachdist.py test` to test everything or
-`scripts/eachdist.py lint` to lint everything (fixing anything that is auto-fixable).
+This project uses [tox](https://tox.readthedocs.io) to automate
+some aspects of development, including testing against multiple Python versions.
+To install `tox`, run:
 
-Additionally, this project uses [`tox`](https://tox.readthedocs.io) to automate some aspects
-of development, including testing against multiple Python versions.
+```sh
+pip install tox
+```
 
-You can run:
+You can also run tox with `uv` support. By default [tox.ini](./tox.ini) will automatically create a provisioned tox environment with `tox-uv`, but you can install it at host level:
 
-- `tox` to run all existing tox commands, including unit tests for all packages
+```sh
+pip install tox-uv
+```
+
+You can run `tox` with the following arguments:
+
+* `tox` to run all existing tox commands, including unit tests for all packages
   under multiple Python versions
-- `tox -e py37-test-flask` to e.g. run the Flask tests under a specific
+* `tox -e docs` to regenerate all docs
+* `tox -e py312-test-instrumentation-aiopg` to e.g. run the aiopg instrumentation unit tests under a specific
   Python version
-- `tox -e lint` to run lint checks on all code
+* `tox -e spellcheck` to run a spellcheck on all the code
+* `tox -e lint-some-package` to run lint checks on `some-package`
+* `tox -e generate-workflows` to run creation of new CI workflows if tox environments have been updated
+* `tox -e ruff` to run ruff linter and formatter checks against the entire codebase
+
+`ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:
+
+```console
+pip install pre-commit -c dev-requirements.txt
+```
+
+and run this command inside the git repository:
+
+```console
+pre-commit install
+```
 
 See
 [`tox.ini`](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/tox.ini)
 for more detail on available tox commands.
 
+### Virtual Environment
+
+You can also create a single virtual environment to make it easier to run local tests.
+
+For that, you'll need to install [`uv`](https://docs.astral.sh/uv/getting-started/installation/).
+
+After installing `uv`, you can run the following command:
+
+```sh
+uv sync
+```
+
+This will create a virtual environment in the `.venv` directory and install all the necessary dependencies.
+
+### Troubleshooting
+
+Some packages may require additional system-wide dependencies to be installed. For example, you may need to install `libpq-dev` to run the postgresql client libraries instrumentation tests or `libsnappy-dev` to run the prometheus exporter tests. If you encounter a build error, please check the installation instructions for the package you are trying to run tests for.
+
+For `docs` building, you may need to install `mysql-client` and other required dependencies as necessary. Ensure the Python version used in your local setup matches the version used in the [CI](./.github/workflows/) to maintain compatibility when building the documentation.
+
 ### Benchmarks
 
-Performance progression of benchmarks for packages distributed by OpenTelemetry Python can be viewed as a [graph of throughput vs commit history](https://opentelemetry-python-contrib.readthedocs.io/en/latest/performance/benchmarks.html). From the linked page, you can download a JSON file with the performance results.
-
-Running the `tox` tests also runs the performance tests if any are available. Benchmarking tests are done with `pytest-benchmark` and they output a table with results to the console.
+Some packages have benchmark tests. To run them, run `tox -f benchmark`. Benchmark tests use `pytest-benchmark` and they output a table with results to the console.
 
 To write benchmarks, simply use the [pytest benchmark fixture](https://pytest-benchmark.readthedocs.io/en/latest/usage.html#usage) like the following:
 
@@ -69,10 +139,10 @@ def test_simple_start_span(benchmark):
     benchmark(benchmark_start_as_current_span, "benchmarkedSpan", 42)
 ```
 
-Make sure the test file is under the `tests/performance/benchmarks/` folder of
+Make sure the test file is under the `benchmarks/` folder of
 the package it is benchmarking and further has a path that corresponds to the
 file in the package it is testing. Make sure that the file name begins with
-`test_benchmark_`. (e.g. `propagator/opentelemetry-propagator-aws-xray/tests/performance/benchmarks/trace/propagation/test_benchmark_aws_xray_propagator.py`)
+`test_benchmark_`. (e.g. `propagator/opentelemetry-propagator-aws-xray/benchmarks/trace/propagation/test_benchmark_aws_xray_propagator.py`)
 
 ## Pull Requests
 
@@ -84,30 +154,45 @@ pull requests (PRs).
 To create a new PR, fork the project in GitHub and clone the upstream repo:
 
 ```sh
-$ git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
+git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
+cd opentelemetry-python-contrib
 ```
 
 Add your fork as an origin:
 
 ```sh
-$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
+git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git
 ```
 
-Run tests:
+make sure you have all supported versions of Python installed, install `tox` only for the first time:
 
 ```sh
-# make sure you have all supported versions of Python installed
-$ pip install tox  # only first time.
-$ tox  # execute in the root of the repository
+pip install tox tox-uv
+```
+
+Run tests in the root of the repository (this will run all tox environments and may take some time):
+
+```sh
+tox
 ```
 
 Check out a new branch, make modifications and push the branch to your fork:
 
 ```sh
-$ git checkout -b feature
-# edit files
-$ git commit
-$ git push fork feature
+git checkout -b feature
+```
+
+After you edit the files, stage changes in the current directory:
+
+```sh
+git add .
+```
+
+Then run the following to commit the changes:
+
+```sh
+git commit
+git push fork feature
 ```
 
 Open a pull request against the main `opentelemetry-python-contrib` repo.
@@ -116,11 +201,24 @@ Open a pull request against the main `opentelemetry-python-contrib` repo.
 
 * If the PR is not ready for review, please put `[WIP]` in the title, tag it
   as `work-in-progress`, or mark it as [`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
+* Make sure tests and lint are passing locally before requesting a review.
 * Make sure CLA is signed and CI is clear.
 
+### How to Get PRs Reviewed
+
+The maintainers and approvers of this repo are not experts in every instrumentation there is here.
+In fact each one of us knows enough about them to only review a few. Unfortunately it can be hard
+to find enough experts in every instrumentation to quickly review every instrumentation PR. The
+instrumentation experts are listed in `.github/component_owners.yml` with their corresponding files
+or directories that they own. The owners listed there will be notified when PRs that modify their
+files are opened.
+
+If you are not getting reviews, please contact the respective owners directly.
+
 ### How to Get PRs Merged
 
 A PR is considered to be **ready to merge** when:
+
 * It has received two approvals from [Approvers](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver)
   / [Maintainers](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer)
   (at different companies).
@@ -159,20 +257,32 @@ For a deeper discussion, see: https://github.com/open-telemetry/opentelemetry-sp
 2. Make sure you have `tox` installed. `pip install tox`.
 3. Run `tox` without any arguments to run tests for all the packages. Read more about [tox](https://tox.readthedocs.io/en/latest/).
 
+Some tests can be slow due to pre-steps that do dependencies installs. To help with that, you can run tox a first time, and after that run the tests using previous installed dependencies in toxdir as following:
+
+1. First time run (e.g., opentelemetry-instrumentation-aiopg)
+```console
+tox -e py312-test-instrumentation-aiopg
+```
+2. Run tests again without pre-steps:
+```console
+.tox/py312-test-instrumentation-aiopg/bin/pytest instrumentation/opentelemetry-instrumentation-aiopg
+```
+
 ### Testing against a different Core repo branch/commit
 
 Some of the tox targets install packages from the [OpenTelemetry Python Core Repository](https://github.com/open-telemetry/opentelemetry-python) via pip. The version of the packages installed defaults to the main branch in that repository when tox is run locally. It is possible to install packages tagged with a specific git commit hash by setting an environment variable before running tox as per the following example:
 
+```sh
 CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
+```
 
-The continuation integration overrides that environment variable with as per the configuration [here](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/test.yml#L9).
-
+The continuous integration overrides that environment variable with as per the configuration [here](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/test_0.yml#L14).
 
 ## Style Guide
 
 * docstrings should adhere to the [Google Python Style
   Guide](http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
-  as specified with the [napolean
+  as specified with the [napoleon
   extension](http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#google-vs-numpy)
   extension in [Sphinx](http://www.sphinx-doc.org/en/master/index.html).
 
@@ -181,28 +291,85 @@ The continuation integration overrides that environment variable with as per the
 Below is a checklist of things to be mindful of when implementing a new instrumentation or working on a specific instrumentation. It is one of our goals as a community to keep the implementation specific details of instrumentations as similar across the board as possible for ease of testing and feature parity. It is also good to abstract as much common functionality as possible.
 
 - Follow semantic conventions
-  - The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/opentelemetry-specification/tree/main/semantic_conventions)
-- Extends from [BaseInstrumentor](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L26)
+  - The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs).
+  - To ensure consistency, we encourage contributions that align with [STABLE](https://opentelemetry.io/docs/specs/otel/document-status/#lifecycle-status) semantic conventions if available. This approach helps us avoid potential confusion and reduces the need to support multiple outdated versions of semantic conventions. However, we are still open to considering exceptional cases where changes are well justified.
+  - Contributions related to outdated HTTP semantic conventions (conventions prior to becoming [stable](https://github.com/open-telemetry/semantic-conventions/tree/v1.23.0)) will likely be discouraged, as they increase complexity and the potential for misconceptions.
+- Contains a name that is not already claimed in [Pypi](https://pypi.org/). Contact a maintainer, bring the issue up in the weekly Python SIG or create a ticket in Pypi if a desired name has already been taken.
+- Extends from [BaseInstrumentor](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L35)
 - Supports auto-instrumentation
-  - Add an entry point (ex. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-requests/setup.cfg#L56)
-  - Run `python scripts/setup.py` followed by `python scripts/generate_instrumentation_bootstrap.py` after adding a new instrumentation package.
+  - Add an entry point (ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/pyproject.toml#L44>)
+  - Run `python scripts/generate_instrumentation_bootstrap.py` after adding a new instrumentation package.
 - Functionality that is common amongst other instrumentation and can be abstracted [here](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation)
 - Request/response [hooks](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/408) for http instrumentations
 - `suppress_instrumentation` functionality
-  - ex. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/3ec77360cb20482b08b30312a6bedc8b946e3fa1/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L111
+  - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py#L191>
 - Suppress propagation functionality
   - https://github.com/open-telemetry/opentelemetry-python-contrib/issues/344 for more context
 - `exclude_urls` functionality
-  - ex. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/0fcb60d2ad139f78a52edd85b1cc4e32f2e962d0/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py#L91
-- `url_filter` functonality
-  - ex. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/0fcb60d2ad139f78a52edd85b1cc4e32f2e962d0/instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py#L235
+  - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py#L327>
+- `url_filter` functionality
+  - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-aiohttp-client/src/opentelemetry/instrumentation/aiohttp_client/__init__.py#L268>
 - `is_recording()` optimization on non-sampled spans
-  - ex. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L133
+  - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L234>
 - Appropriate error handling
-  - ex. https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L146
+  - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py#L220>
+- Isolate sync and async test
+  - For synchronous tests, the typical test case class is inherited from `opentelemetry.test.test_base.TestBase`. However, if you want to write asynchronous tests, the test case class should inherit also from `IsolatedAsyncioTestCase`. Adding asynchronous tests to a common test class can lead to tests passing without actually running, which can be misleading.
+  - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/60fb936b7e5371b3e5587074906c49fb873cbd76/instrumentation/opentelemetry-instrumentation-grpc/tests/test_aio_server_interceptor.py#L84>
+- Most of the instrumentations have the same version. If you are going to develop a new instrumentation it would probably have `X.Y.dev` version and depends on `opentelemetry-instrumentation` and `opentelemetry-semantic-conventions` for a [compatible version](https://peps.python.org/pep-0440/#compatible-release). That means that you may need to install the instrumentation dependencies from this repo and the core repo from git.
+- Documentation
+  - When adding a new instrumentation remember to add an entry in `docs/instrumentation/` named `<instrumentation>/<instrumentation>.rst` to have the instrumentation documentation referenced from the index. You can use the entry template available [here](./_template/autodoc_entry.rst)
+- Testing
+  - When adding a new instrumentation remember to update `tox.ini` adding appropriate rules in `envlist`, `command_pre` and `commands` sections
 
+### Update supported instrumentation package versions
+
+- Navigate to the **instrumentation package directory:**
+  - Update **`pyproject.toml`** file by modifying _instruments_ entry in the `[project.optional-dependencies]` section with the new version constraint
+  - Update `_instruments` variable in instrumentation **`package.py`** file with the new version constraint
+- At the **root of the project directory**, run `tox -e generate` to regenerate necessary files
+
+If you're adding support for a new version of the instrumentation package, follow these additional steps:
+
+- At the **instrumentation package directory:** Add new test-requirements.txt file with the respective package version required for testing
+- At the **root of the project directory**: Add a new test environment entry for the package version in [tox.ini](./tox.ini) and run `tox -e generate-workflows` to regenerate new workflows accordingly. In the same [tox.ini](./tox.ini) file, search for `opentelemetry-instrumentation-{package}/test-requirements` and add a new line to point to the new test-requirements.txt you created in the previous step so tox can install the correct requirements.
+
+Example PRs: [#2976](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2976), [#2845](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2845)
+
+## Guideline for GenAI instrumentations
+
+Instrumentations that relate to [Generative AI](https://opentelemetry.io/docs/specs/semconv/gen-ai/) systems will be placed in the [instrumentation-genai](./instrumentation-genai) folder. This section covers contributions related to those instrumentations. Please note that the [guidelines for instrumentations](#guideline-for-instrumentations) and [expectations from contributors](#expectations-from-contributors) still apply.
+
+### Get Involved
+
+* Reviewing PRs: If you would like to be tagged as reviewer in new PRs related to these instrumentations, please submit a PR to add your GitHub handle to [component_owners.yml](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/component_owners.yml) under the corresponding instrumentation folder(s).
+
+* Approving PRs: If you would like to be able to approve PRs related to these instrumentations, you must join [opentelemetry-python-contrib-approvers](https://github.com/orgs/open-telemetry/teams/opentelemetry-python-contrib-approvers) team. Please ask one of the [Python contrib maintainers](https://github.com/orgs/open-telemetry/teams/opentelemetry-python-contrib-maintainers) to be accepted into the team.
+
+* Tracking and Creating Issues: For tracking issues related to Generative AI, please filter or add the label [gen-ai](https://github.com/open-telemetry/opentelemetry-python-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Agen-ai) when creating or searching issues. If you do not see an issue related to an instrumentation you would like to contribute to, please create a new tracking issue so the community is aware of its progress.
 
 ## Expectations from contributors
 
-OpenTelemetry is an open source community, and as such, greatly encourages contributions from anyone interested in the project. With that being said, there is a certain level of expectation from contributors even after a pull request is merged, specifically pertaining to instrumentations. The OpenTelemetry Python community expects contributors to maintain a level of support and interest in the instrumentations they contribute. This is to ensure that the instrumentation does not become stale and still functions the way the original contributor intended. Some instrumentations also pertain to libraries that the current memebers of the community are not so familiar with, so it is necessary to rely on the expertise of the original contributing parties.
+OpenTelemetry is an open source community, and as such, greatly encourages contributions from anyone interested in the project. With that being said, there is a certain level of expectation from contributors even after a pull request is merged, specifically pertaining to instrumentations. The OpenTelemetry Python community expects contributors to maintain a level of support and interest in the instrumentations they contribute. This is to ensure that the instrumentation does not become stale and still functions the way the original contributor intended. Some instrumentations also pertain to libraries that the current members of the community are not so familiar with, so it is necessary to rely on the expertise of the original contributing parties.
 
+## Updating supported Python versions
+
+### Bumping the Python baseline
+
+When updating the minimum supported Python version remember to:
+
+- Remove the version in `pyproject.toml` trove classifiers
+- Remove the version from `tox.ini`
+- Update github workflows accordingly with `tox -e generate-workflows`
+- Search for `sys.version_info` usage and remove code for unsupported versions
+- Bump `py-version` in `.pylintrc` for Python version dependent checks
+
+### Adding support for a new Python release
+
+When adding support for a new Python release remember to:
+
+- Add the version in `tox.ini`
+- Add the version in `pyproject.toml` trove classifiers
+- Update github workflows accordingly with `tox -e generate-workflows`; lint and benchmarks use the latest supported version
+- Update `.pre-commit-config.yaml`
+- Update tox examples in the documentation

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright The OpenTelemetry Authors
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

LICENSE.Apache

@@ -178,7 +178,7 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
+      boilerplate notice, with the fields enclosed by brackets "[]"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
@@ -186,7 +186,8 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2016 Datadog, Inc.
+   Copyright [yyyy] [name of copyright owner]
+
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

README.md

@@ -1,7 +1,7 @@
 ---
 <p align="center">
   <strong>
-    <a href="https://opentelemetry-python-contrib.readthedocs.io/en/latest/getting-started.html">Getting Started<a/>
+    <a href="https://opentelemetry.io/docs/instrumentation/python/getting-started/">Getting Started<a/>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
     <a href="https://opentelemetry-python-contrib.readthedocs.io/">API Documentation<a/>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
@@ -20,8 +20,11 @@
     <img alt="license" src="https://img.shields.io/badge/license-Apache_2.0-green.svg?style=for-the-badge">
   </a>
   <br/>
-  <a href="https://github.com/open-telemetry/opentelemetry-python-contrib/actions?query=workflow%3ATest+branch%3Amaster">
-    <img alt="Build Status" src="https://github.com/open-telemetry/opentelemetry-python-contrib/workflows/Test/badge.svg">
+  <a href="https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/test_0.yml">
+    <img alt="Build Status 0" src="https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/test_0.yml/badge.svg?branch=main">
+  </a>
+  <a href="https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/test_1.yml">
+    <img alt="Build Status 1" src="https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/test_1.yml/badge.svg?branch=main">
   </a>
   <img alt="Beta" src="https://img.shields.io/badge/status-beta-informational?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAACQAAAAAQAAAJAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABigAwAEAAAAAQAAABgAAAAA8A2UOAAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABK5JREFUSA2dVm1sFEUYfmd2b/f2Pkqghn5eEQWKrRgjpkYgpoRCLC0oxV5apAiGUDEpJvwxEQ2raWPU+Kf8INU/RtEedwTCR9tYPloxGNJYTTQUwYqJ1aNpaLH3sXu3t7vjvFevpSqt7eSyM+/czvM8877PzB3APBoLgoDLsNePF56LBwqa07EKlDGg84CcWsI4CEbhNnDpAd951lXE2NkiNknCCTLv4HtzZuvPm1C/IKv4oDNXqNDHragety2XVzjECZsJARuBMyRzJrh1O0gQwLXuxofxsPSj4hG8fMLQo7bl9JJD8XZfC1E5yWFOMtd07dvX5kDwg6+2++Chq8txHGtfPoAp0gOFmhYoNFkHjn2TNUmrwRdna7W1QSkU8hvbGk4uThLrapaiLA2E6QY4u/lS9ItHfvJkxYsTMVtnAJLipYIWtVrcdX+8+b8IVnPl/R81prbuPZ1jpYw+0aEUGSkdFsgyBIaFTXCm6nyaxMtJ4n+TeDhJzGqZtQZcuYDgqDwDbqb0JF9oRpIG1Oea3bC1Y6N3x/WV8Zh83emhCs++hlaghDw+8w5UlYKq2lU7Pl8IkvS9KDqXmKmEwdMppVPKwGSEilmyAwJhRwWcq7wYC6z4wZ1rrEoMWxecdOjZWXeAQClBcYDN3NwVwD9pGwqUSyQgclcmxpNJqCuwLmDh3WtvPqXdlt+6Oz70HPGDNSNBee/EOen+rGbEFqDENBPDbtdCp0ukPANmzO0QQJYUpyS5IJJI3Hqt4maS+EB3199ozm8EDU/6fVNU2dQpdx3ZnKzeFXyaUTiasEV/gZMzJMjr3Z+WvAdQ+hs/zw9savimxUntDSaBdZ2f+Idbm1rlNY8esFffBit9HtK5/MejsrJVxikOXlb1Ukir2X+Rbdkd1KG2Ixfn2Ql4JRmELnYK9mEM8G36fAA3xEQ89fxXihC8q+sAKi9jhHxNqagY2hiaYgRCm0f0QP7H4Fp11LSXiuBY2aYFlh0DeDIVVFUJQn5rCnpiNI2gvLxHnASn9DIVHJJlm5rXvQAGEo4zvKq2w5G1NxENN7jrft1oxMdekETjxdH2Z3x+VTVYsPb+O0C/9/auN6v2hNZw5b2UOmSbG5/rkC3LBA+1PdxFxORjxpQ81GcxKc+ybVjEBvUJvaGJ7p7n5A5KSwe4AzkasA+crmzFtowoIVTiLjANm8GDsrWW35ScI3JY8Urv83tnkF8JR0yLvEt2hO/0qNyy3Jb3YKeHeHeLeOuVLRpNF+pkf85OW7/zJxWdXsbsKBUk2TC0BCPwMq5Q/CPvaJFkNS/1l1qUPe+uH3oD59erYGI/Y4sce6KaXYElAIOLt+0O3t2+/xJDF1XvOlWGC1W1B8VMszbGfOvT5qaRRAIFK3BCO164nZ0uYLH2YjNN8thXS2v2BK9gTfD7jHVxzHr4roOlEvYYz9QIz+Vl/sLDXInsctFsXjqIRnO2ZO387lxmIboLDZCJ59KLFliNIgh9ipt6tLg9SihpRPDO1ia5byw7de1aCQmF5geOQtK509rzfdwxaKOIq+73AvwCC5/5fcV4vo3+3LpMdtWHh0ywsJC/ZGoCb8/9D8F/ifgLLl8S8QWfU8cAAAAASUVORK5CYII=">
 </p>
@@ -30,17 +33,26 @@
   <strong>
     <a href="CONTRIBUTING.md">Contributing<a/>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
-    <a href="https://opentelemetry-python-contrib.readthedocs.io/en/stable/#examples">Examples<a/>
+    <a href="https://opentelemetry-python-contrib.readthedocs.io/en/latest/#instrumentations">Instrumentations<a/>
   </strong>
 </p>
 
 ---
 
-## OpenTelemetry Python Contrib
+# OpenTelemetry Python Contrib
 
 The Python auto-instrumentation libraries for [OpenTelemetry](https://opentelemetry.io/) (per [OTEP 0001](https://github.com/open-telemetry/oteps/blob/main/text/0001-telemetry-without-manual-instrumentation.md))
 
-### Installation
+## Index
+
+* [Installation](#installation)
+* [Releasing](#releasing)
+  * [Releasing a package as `1.0` stable](#releasing-a-package-as-10-stable)
+* [Semantic Convention status of instrumentations](#semantic-convention-status-of-instrumentations)
+* [Contributing](#contributing)
+* [Thanks to all the people who already contributed](#thanks-to-all-the-people-who-already-contributed)
+
+## Installation
 
 This repository includes installable packages for each instrumented library. Libraries that produce telemetry data should only depend on `opentelemetry-api`,
 and defer the choice of the SDK to the application developer. Applications may
@@ -49,6 +61,8 @@ depend on `opentelemetry-sdk` or another package that implements the API.
 **Please note** that these libraries are currently in _beta_, and shouldn't
 generally be used in production environments.
 
+Unless explicitly stated otherwise, any instrumentation here for a particular library is not developed or maintained by the authors of such library.
+
 The
 [`instrumentation/`](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation)
 directory includes OpenTelemetry instrumentation packages, which can be installed
@@ -60,7 +74,7 @@ pip install opentelemetry-instrumentation-{integration}
 
 To install the development versions of these packages instead, clone or fork
 this repo and do an [editable
-install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs):
+install](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):
 
 ```sh
 pip install -e ./instrumentation/opentelemetry-instrumentation-{integration}
@@ -68,7 +82,7 @@ pip install -e ./instrumentation/opentelemetry-instrumentation-{integration}
 
 ## Releasing
 
-Maintainers aim to periodically release new versions of the packages in `opentelemetry-python-contrib`.
+Maintainers release new versions of the packages in `opentelemetry-python-contrib` on a monthly cadence. See [releases](https://github.com/open-telemetry/opentelemetry-python-contrib/releases) for all previous releases.
 
 Contributions that enhance OTel for Python are welcome to be hosted upstream for the benefit of group collaboration. Maintainers will look for things like good documentation, good unit tests, and in general their own confidence when deciding to release a package with the stability guarantees that are implied with a `1.0` release.
 
@@ -77,6 +91,7 @@ To resolve this, members of the community are encouraged to commit to becoming a
 ### Releasing a package as `1.0` stable
 
 To release a package as `1.0` stable, the package:
+
 - SHOULD have a CODEOWNER. To become one, submit an issue and explain why you meet the responsibilities found in [CODEOWNERS](.github/CODEOWNERS).
 - MUST have unit tests that cover all supported versions of the instrumented library.
   - e.g. Instrumentation packages might use different techniques to instrument different major versions of python packages
@@ -84,44 +99,60 @@ To release a package as `1.0` stable, the package:
   - e.g. If an instrumentation package uses flags, a token as context, or parameters that are not typical of the `BaseInstrumentor` class, these are documented
 - After the release of `1.0`, a CODEOWNER may no longer feel like they have the bandwidth to meet the responsibilities of maintaining the package. That's not a problem at all, life happens! However, if that is the case, we ask that the CODEOWNER please raise an issue indicating that they would like to be removed as a CODEOWNER so that they don't get pinged on future PRs. Ultimately, we hope to use that issue to find a new CODEOWNER.
 
+## Semantic Convention status of instrumentations
+
+In our efforts to maintain optimal user experience and prevent breaking changes for transitioning into stable semantic conventions, OpenTelemetry Python is adopting the semantic convention migration plan for several instrumentations. Currently this plan is only being adopted for [HTTP-related instrumentations](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/http-migration.md), but will eventually cover all types. Please refer to the `semconv status` column of the [instrumentation README](instrumentation/README.md) of the current status of instrumentations' semantic conventions. The possible values are `development`, `stable` and `migration` referring to [status](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.31.0/specification/document-status.md#lifecycle-status) of that particular semantic convention. `Migration` refers to an instrumentation that currently supports the migration plan.
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)
 
-We meet weekly on Thursday, and the time of the meeting alternates between 9AM PT and 4PM PT. The meeting is subject to change depending on contributors' availability. Check the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) for specific dates.
-
-Meetings take place via [Zoom video conference](https://zoom.us/j/8287234601?pwd=YjN2MURycXc4cEZlYTRtYjJaM0grZz09). The passcode is _77777_.
+We meet weekly on Thursday at 9AM PT. The meeting is subject to change depending on contributors' availability. Check the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=c_2bf73e3b6b530da4babd444e72b76a6ad893a5c3f43cf40467abc7a9a897f977%40group.calendar.google.com) for specific dates and for the Zoom link.
 
 Meeting notes are available as a public [Google doc](https://docs.google.com/document/d/1CIMGoIOZ-c3-igzbd6_Pnxx1SjAkjwqoYSUWxPY8XIs/edit). For edit access, get in touch on [GitHub Discussions](https://github.com/open-telemetry/opentelemetry-python/discussions).
 
-Approvers ([@open-telemetry/python-approvers](https://github.com/orgs/open-telemetry/teams/python-approvers)):
+### Maintainers
 
 - [Aaron Abbott](https://github.com/aabmass), Google
-- [Alex Boten](https://github.com/codeboten), Lightstep
-- [Nathaniel Ruiz Nowell](https://github.com/NathanielRN), AWS
-- [Srikanth Chekuri](https://github.com/lonewolf3739)
-
-*Find more about the approver role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver).*
-
-Maintainers ([@open-telemetry/python-maintainers](https://github.com/orgs/open-telemetry/teams/python-maintainers)):
-
-- [Diego Hurtado](https://github.com/ocelotl), Lightstep
 - [Leighton Chen](https://github.com/lzchen), Microsoft
+- [Riccardo Magliocchetti](https://github.com/xrmx), Elastic
+- [Shalev Roda](https://github.com/shalevr), Cisco
+
+For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).
+
+### Approvers
+
+- [Emídio Neto](https://github.com/emdneto), PicPay
+- [Jeremy Voss](https://github.com/jeremydvoss), Microsoft
 - [Owais Lone](https://github.com/owais), Splunk
+- [Pablo Collins](https://github.com/pmcollins), Splunk
+- [Sanket Mehta](https://github.com/sanketmehta28), Cisco
+- [Srikanth Chekuri](https://github.com/srikanthccv), signoz.io
+- [Tammy Baylis](https://github.com/tammy-baylis-swi), SolarWinds
 
-*Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).*
+For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).
 
-## Running Tests Locally
+### Emeritus Maintainers
 
-1. Go to your Contrib repo directory. `cd ~/git/opentelemetry-python-contrib`.
-2. Create a virtual env in your Contrib repo directory. `python3 -m venv my_test_venv`.
-3. Activate your virtual env. `source my_test_venv/bin/activate`.
-4. Make sure you have `tox` installed. `pip install tox`.
-5. Run tests for a package. (e.g. `tox -e test-instrumentation-flask`.)
+- [Alex Boten](https://github.com/codeboten)
+- [Diego Hurtado](https://github.com/ocelotl)
+- [Owais Lone](https://github.com/owais)
+- [Yusuke Tsutsumi](https://github.com/toumorokoshi)
 
-### Thanks to all the people who already contributed!
+For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager).
+
+### Emeritus Approvers
+
+- [Ashutosh Goel](https://github.com/ashu658)
+- [Héctor Hernández](https://github.com/hectorhdzg)
+- [Nathaniel Ruiz Nowell](https://github.com/NathanielRN)
+- [Nikolay Sokolik](https://github.com/nikosokolik)
+- [Nikolay Sokolik](https://github.com/oxeye-nikolay)
+
+For more information about the emeritus role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#emeritus-maintainerapprovertriager).
+
+### Thanks to all of our contributors!
 
 <a href="https://github.com/open-telemetry/opentelemetry-python-contrib/graphs/contributors">
-  <img src="https://contributors-img.web.app/image?repo=open-telemetry/opentelemetry-python-contrib" />
+  <img alt="Repo contributors" src="https://contrib.rocks/image?repo=open-telemetry/opentelemetry-python-contrib" />
 </a>
-

RELEASING.md

@@ -0,0 +1,150 @@
+# Release instructions
+
+## Preparing a new major or minor release
+
+* Run the [Prepare release branch workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/prepare-release-branch.yml).
+  * Press the "Run workflow" button, and leave the default branch `main` selected.
+    * If making a pre-release of stable components (e.g. release candidate),
+      enter the pre-release version number, e.g. `1.9.0rc2`.
+      (otherwise the workflow will pick up the version from `main` and just remove the `.dev` suffix).
+  * Review the two pull requests that it creates.
+    (one is targeted to the release branch and one is targeted to `main`).
+    * The builds will fail for the release PR because of validation rules. Follow the [release workflow](https://github.com/open-telemetry/opentelemetry-python/blob/main/RELEASING.md) for the core repo up until this same point.
+    * Close and reopen the PR so that the workflow will take into account the label automation we have in place
+  * Merge the release PR.
+  * Merge the PR to main (this can be done separately from [making the release](#making-the-release))
+
+### Preparing a major or minor release for individual package
+
+> [!NOTE]
+> Per-package release is supported for the following packages only:
+> - opentelemetry-propagator-aws-xray
+> - opentelemetry-resource-detector-azure
+> - opentelemetry-sdk-extension-aws
+> - opentelemetry-instrumentation-openai-v2
+> - opentelemetry-instrumentation-vertexai
+> - opentelemetry-instrumentation-google-genai
+>
+> These libraries are also excluded from the general release.
+
+Package release preparation is handled by the [`[Package] Prepare release`](./.github/workflows/package-prepare-release.yml) workflow that allows
+to pick a specific package to release. It follows the same versioning strategy and process as the general release.
+
+Long-term package release branch follows `package-release/{package-name}/v{major}.{minor}.x` (or `package-release/{package-name}/v{major}.{minor}bx`) naming pattern.
+
+The workflow will create two pull requests, one against the `main` and one against the `package-release/` branch; both should be merged in order to proceed with the release.
+
+## Preparing a new patch release
+
+* Backport pull request(s) to the release branch.
+  * Run the [Backport workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/backport.yml).
+  * Press the "Run workflow" button, then select the release branch from the dropdown list,
+    e.g. `release/v1.9.x`, then enter the pull request number that you want to backport,
+    then click the "Run workflow" button below that.
+  * Add the label `backport` to the generated pull request.
+  * In case label automation doesn't work, just close and reopen the PR so that the workflow will take into account the label automation we have in place.
+  * Review and merge the backport pull request that it generates.
+* Merge a pull request to the release branch updating the `CHANGELOG.md`.
+  * The heading for the unreleased entries should be `## Unreleased`.
+* Run the [Prepare patch release workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/prepare-patch-release.yml).
+  * Press the "Run workflow" button, then select the release branch from the dropdown list,
+    e.g. `release/v1.9.x`, and click the "Run workflow" button below that.
+  * Review and merge the pull request that it creates for updating the version.
+* Note: If you are doing a patch release in `-contrib` repo, you should also do an equivalent patch release in `-core` repo (even if there's no fix to release), otherwise tests in CI will fail.
+
+### Preparing a patch release for individual package
+
+> [!NOTE]
+> Per-package release is supported only for packages included in the corresponding workflow. Libraries that support per-package release are currently
+> excluded from the general patch release.
+
+Per-package patch release preparation is handled by the [`[Package] Prepare patch release`](./.github/workflows/package-prepare-patch-release.yml) workflow that allows
+to pick a specific package to release.
+
+The workflow can only be run against long-term release branch such as `package-release/{package-name}/v{major}.{minor}.x` or `package-release/{package-name}/v{major}.{minor}bx`.
+
+The workflow will create a pull request that should be merged in order to proceed with the release.
+
+## Making the release
+
+* Run the [Release workflow](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml).
+  * Press the "Run workflow" button, then select the release branch from the dropdown list,
+    e.g. `release/v1.9.x`, and click the "Run workflow" button below that.
+  * This workflow will publish the artifacts and publish a GitHub release with release notes based on the change log.
+  * Review and merge the pull request that it creates for updating the change log in main
+    (note that if this is not a patch release then the change log on main may already be up-to-date,
+    in which case no pull request will be created).
+  * Verify that a new [Github release](https://github.com/open-telemetry/opentelemetry-python-contrib/releases) has been created and that the CHANGELOGs look correct.
+
+### Releasing individual package
+
+> [!NOTE]
+> Per-package patch release is supported for the following packages only:
+> - opentelemetry-propagator-aws-xray
+> - opentelemetry-resource-detector-azure
+> - opentelemetry-sdk-extension-aws
+> - opentelemetry-instrumentation-openai-v2
+> - opentelemetry-instrumentation-vertexai
+> - opentelemetry-instrumentation-google-genai
+>
+> These libraries are also excluded from the general patch release.
+
+Per-package release is handled by the [`[Package] Release`](./.github/workflows/package-release.yml) workflow that allows
+to pick a specific package to release.
+
+The workflow can only be run against long-term release branch such as `package-release/{package-name}/v{major}.{minor}.x` or `package-release/{package-name}/v{major}.{minor}bx`.
+
+## After the release
+
+* Check PyPI
+  * This should be handled automatically on release by the [publish action](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/release.yml).
+  * Check the [action logs](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml) to make sure packages have been uploaded to PyPI
+  * Check the release history (e.g. https://pypi.org/project/opentelemetry-instrumentation/#history) on PyPI
+  * If for some reason the action failed, see [Publish failed](#publish-failed) below
+
+## Notes about version numbering for stable components
+
+* The version number for stable components in the `main` branch is always `X.Y.0.dev`,
+  where `X.Y.0` represents the next minor release.
+* When the release branch is created, you can opt to make a "pre-release", e.g. `X.Y.0rc2`.
+* If you ARE NOT making a "pre-release":
+  * A "long-term" release branch will be created, e.g. `release/v1.9.x-0.21bx` (notice the wildcard x's).
+    Later on, after the initial release, you can backport PRs to a "long-term" release branch and make patch releases
+    from it.
+  * The version number for stable components in the release branch will be bumped to remove the `.dev`,
+    e.g. `X.Y.0`.
+  * The version number for stable components in the `main` branch will be bumped to the next version,
+    e.g. `X.{Y+1}.0.dev`.
+* If you ARE making a "pre-release":
+  * A "short-term" release branch will be created, e.g. `release/v1.9.0rc2-0.21b0` (notice the precise version with no
+    wildcard x's). "Short-term" release branches do not support backports or patch releases after the initial release.
+  * The version number for stable components in the `main` branch will not be bumped, e.g. it will remain `X.Y.0.dev`
+    since the next minor release will still be `X.Y.0`.
+
+## Notes about version numbering for unstable components
+
+* The version number for unstable components in the `main` branch is always `0.Yb0.dev`,
+  where `0.Yb0` represents the next minor release.
+  * _Question: Is "b" (beta) redundant on "0." releases, or is this a python thing? I'm wondering if we can change it to `0.Y.0` to match up with the practice in js and go repos._
+* Unstable components do not need "pre-releases", and so whether or not you are making a "pre-release" of stable
+  components:
+  * The version number for unstable components in the release branch will be bumped to remove the `.dev`,
+    e.g. `0.Yb0`.
+  * The version number for unstable components in the `main` branch will be bumped to the next version,
+    e.g. `0.{Y+1}b0.dev`.
+
+## Releasing dev version of new packages to claim namespace
+
+When a contribution introduces a new package, in order to mitigate name-squatting incidents, release the current development version of the new package under the `opentelemetry` user to simply claim the namespace. This should be done shortly after the PR that introduced this package has been merged into `main`.
+
+## Troubleshooting
+
+### Publish failed
+
+If for some reason the action failed, do it manually:
+
+- Switch to the release branch (important so we don't publish packages with "dev" versions)
+- Build distributions with `./scripts/build.sh`
+- Delete distributions we don't want to push (e.g. `testutil`)
+- Push to PyPI as `twine upload --skip-existing --verbose dist/*`
+- Double check PyPI!

_template/README.rst

@@ -11,6 +11,7 @@ This library allows tracing requests made by the <REPLACE ME> library.
 Installation
 ------------
 
+
 ::
 
     pip install opentelemetry-instrumentation-<REPLACE ME>

_template/autodoc_entry.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-<REPLACE ME>/README.rst
+    :end-before: References
+
+.. automodule:: opentelemetry.instrumentation.<REPLACE ME>
+    :members:
+    :undoc-members:
+    :show-inheritance:

_template/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+# opentelemetry-instrumentation plus the name of the library being instrument e.g
+# name = "opentelemetry-instrumentation-sqlalchemy"
+name = "<REPLACE ME>"
+dynamic = ["version"]
+# a description of the instrumentation e.g
+# description = "SQLAlchemy tracing for OpenTelemetry"
+description = "<REPLACE ME>"
+readme = "README.rst"
+license = "Apache-2.0"
+requires-python = ">=3.9"
+authors = [
+  { name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+  "opentelemetry-api ~= 1.12",
+]
+
+[project.entry-points.opentelemetry_instrumentor]
+# REPLACE ME: the entrypoint for the instrumentor e.g
+# sqlalchemy = "opentelemetry.instrumentation.sqlalchemy:SQLAlchemyInstrumentor"
+REPLACE_ME = "opentelemetry.instrumentation.<REPLACE>"
+
+[project.urls]
+# url of the instrumentation e.g
+# Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-sqlalchemy"
+Homepage = "<REPLACE ME>"
+Repository = "https://github.com/open-telemetry/opentelemetry-python-contrib"
+
+[tool.hatch.version]
+# REPLACE ME: the path to the version file e.g
+# "src/opentelemetry/instrumentation/sqlalchemy/version.py"
+path = "src/opentelemetry/instrumentation/<REPLACE ME>/version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/src",
+  "/tests",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/opentelemetry"]

_template/setup.cfg

@@ -1,59 +0,0 @@
-# Copyright The OpenTelemetry Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-[metadata]
-# opentelemetry-instrumentation plus the name of the library being instrument e.g
-# name = opentelemetry-instrumentation-sqlalchemy
-name = "<REPLACE ME>"
-# a description of the instrumentation e.g
-# description = SQLAlchemy tracing for OpenTelemetry
-description = "<REPLACE ME>"
-long_description = file: README.rst
-long_description_content_type = text/x-rst
-author = OpenTelemetry Authors
-author_email = cncf-opentelemetry-contributors@lists.cncf.io
-# url of the instrumentation e.g
-# url = https://github.com/open-telemetry/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-sqlalchemy
-url = "<REPLACE ME>"
-platforms = any
-license = Apache-2.0
-classifiers =
-    Development Status :: 4 - Beta
-    Intended Audience :: Developers
-    License :: OSI Approved :: Apache Software License
-    Programming Language :: Python
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.6
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
-
-[options]
-python_requires = >=3.6
-package_dir=
-    =src
-packages=find_namespace:
-
-install_requires =
-    opentelemetry-api ~= 1.3
-
-[options.extras_require]
-test =
-    # add any test dependencies here
-    "<REPLACE ME>"
-
-[options.packages.find]
-where = src
-

_template/setup.py

@@ -1,42 +0,0 @@
-# Copyright The OpenTelemetry Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-import os
-
-import setuptools
-
-BASE_DIR = os.path.dirname(__file__)
-VERSION_FILENAME = os.path.join(
-    # REPLACE ME: the path to the version file e.g
-    # BASE_DIR, "src", "opentelemetry", "instrumentation", "sqlalchemy", "version.py"
-    BASE_DIR,
-    "src",
-    "opentelemetry",
-    "instrumentation",
-    "<REPLACE ME>",
-    "version.py",
-)
-PACKAGE_INFO = {}
-with open(VERSION_FILENAME, encoding="utf-8") as f:
-    exec(f.read(), PACKAGE_INFO)
-
-setuptools.setup(
-    version=PACKAGE_INFO["__version__"],
-    entry_points={
-        "opentelemetry_instrumentor": [
-            # REPLACE ME: the entrypoint for the instrumentor e.g
-            # "sqlalchemy = opentelemetry.instrumentation.sqlalchemy:SQLAlchemyInstrumentor"
-            "<REPLACE ME> = opentelemetry.instrumentation.<REPLACE>"
-        ]
-    },
-)

_template/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.26b1"
+__version__ = "0.57b0.dev"

dev-requirements.txt

@@ -1,15 +1,18 @@
-pylint<2.10
-flake8~=3.7
-isort~=5.6
-black>=21.10b0
-httpretty~=1.0
-mypy==0.790
-sphinx
-sphinx-rtd-theme~=0.4
-sphinx-autodoc-typehints
-pytest!=5.2.3
-pytest-cov>=2.8
-readme-renderer~=24.0
-grpcio-tools==1.29.0
-mypy-protobuf>=1.23
-protobuf>=3.13.0
+pylint==3.0.2
+httpretty==1.1.4
+pyright==v1.1.396
+sphinx==7.1.2
+sphinx-rtd-theme==2.0.0rc4
+sphinx-autodoc-typehints==1.25.2
+pytest==7.4.4
+pytest-cov==4.1.0
+readme-renderer==42.0
+bleach==4.1.0 # transient dependency for readme-renderer
+markupsafe>=2.0.1
+codespell==2.1.0
+requests==2.32.3
+ruamel.yaml==0.17.21
+flaky==3.7.0
+pre-commit==3.7.0; python_version >= '3.9'
+pre-commit==3.5.0; python_version < '3.9'
+ruff==0.6.9

docs-requirements.txt

@@ -1,39 +1,49 @@
-sphinx
-sphinx-rtd-theme~=0.4
-sphinx-autodoc-typehints
-
-# Need to install the api/sdk in the venv for autodoc. Modifying sys.path
-# doesn't work for pkg_resources.
--e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-api&subdirectory=opentelemetry-api"
--e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-semantic-conventions&subdirectory=opentelemetry-semantic-conventions"
--e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-sdk&subdirectory=opentelemetry-sdk"
--e "git+https://github.com/open-telemetry/opentelemetry-python-contrib.git#egg=opentelemetry-util-http&subdirectory=util/opentelemetry-util-http"
-./opentelemetry-instrumentation
+sphinx==7.1.2
+sphinx-rtd-theme==2.0.0rc4
+sphinx-autodoc-typehints==1.25.2
 
 # Required by opentelemetry-instrumentation
 fastapi>=0.65.2
-psutil~=5.7.0
 pymemcache~=1.3
 
 # Required by conf
 django>=2.2
 
 # Required by instrumentation and exporter packages
+aio_pika~=7.2.0
 aiohttp~=3.0
+aiokafka~=0.11.0
 aiopg>=0.13.0,<1.3.0
 asyncpg>=0.12.0
+asyncclick~=8.0
 boto~=2.0
 botocore~=1.0
+boto3~=1.0
+cassandra-driver~=3.25
 celery>=4.0
-flask~=1.0
+confluent-kafka>= 1.8.2,<= 2.4.0
+elasticsearch>=6.0,<9.0
+flask~=2.0
 falcon~=2.0
 grpcio~=1.27
+httpx>=0.18.0
+kafka-python>=2.0,<3.0
 mysql-connector-python~=8.0
-pymongo~=3.1
-PyMySQL~=0.9.3
+mysqlclient~=2.1.1
+openai >= 1.26.0
+psutil>=5
+psycopg~=3.1.17
+pika>=0.12.0
+pymongo~=4.6.3
+PyMySQL~=1.1.1
+pymssql~=2.3.2
 pyramid>=1.7
 redis>=2.6
+remoulade>=0.50
 sqlalchemy>=1.0
-tornado>=6.0
-ddtrace>=0.34.0
-httpx~=0.18.0
+tornado>=5.1.1
+tortoise-orm>=0.17.0
+
+# indirect dependency pins
+markupsafe==2.0.1
+itsdangerous==2.0.1

docs/conf.py

@@ -40,6 +40,13 @@ instr_dirs = [
     if isdir(join(instr, f))
 ]
 
+instr_genai = "../instrumentation-genai"
+instr_genai_dirs = [
+    os.path.abspath("/".join(["../instrumentation-genai", f, "src"]))
+    for f in listdir(instr_genai)
+    if isdir(join(instr_genai, f))
+]
+
 prop = "../propagator"
 prop_dirs = [
     os.path.abspath("/".join([prop, f, "src"]))
@@ -54,7 +61,20 @@ sdk_ext_dirs = [
     if isdir(join(sdk_ext, f))
 ]
 
-sys.path[:0] = exp_dirs + instr_dirs + sdk_ext_dirs + prop_dirs
+resource = "../resource"
+resource_dirs = [
+    os.path.abspath("/".join(["../resource", f, "src"]))
+    for f in listdir(resource)
+    if isdir(join(resource, f))
+]
+sys.path[:0] = (
+    exp_dirs
+    + instr_dirs
+    + instr_genai_dirs
+    + sdk_ext_dirs
+    + prop_dirs
+    + resource_dirs
+)
 
 # -- Project information -----------------------------------------------------
 
@@ -102,6 +122,7 @@ intersphinx_mapping = {
         "https://opentelemetry-python.readthedocs.io/en/latest/",
         None,
     ),
+    "redis": ("https://redis.readthedocs.io/en/latest/", None),
 }
 
 # http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky
@@ -126,25 +147,14 @@ def getlistcfg(strval):
     ]
 
 
-if "class_references" in mcfg:
-    class_references = getlistcfg(mcfg["class_references"])
-    for class_reference in class_references:
-        nitpick_ignore.append(
-            (
-                "py:class",
-                class_reference,
-            )
-        )
+ignore_categories = ["py-class", "py-func", "py-exc", "py-obj", "any"]
+
+for category in ignore_categories:
+    if category in mcfg:
+        items = getlistcfg(mcfg[category])
+        for item in items:
+            nitpick_ignore.append((category.replace("-", ":"), item))
 
-if "anys" in mcfg:
-    anys = getlistcfg(mcfg["anys"])
-    for _any in anys:
-        nitpick_ignore.append(
-            (
-                "any",
-                _any,
-            )
-        )
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -183,13 +193,11 @@ scm_raw_web = "https://raw.githubusercontent.com/" + REPO + branch
 scm_web = "https://github.com/" + REPO + "blob/" + branch
 
 # Store variables in the epilogue so they are globally available.
-rst_epilog = """
-.. |SCM_WEB| replace:: {s}
-.. |SCM_RAW_WEB| replace:: {sr}
-.. |SCM_BRANCH| replace:: {b}
-""".format(
-    s=scm_web, sr=scm_raw_web, b=branch
-)
+rst_epilog = f"""
+.. |SCM_WEB| replace:: {scm_web}
+.. |SCM_RAW_WEB| replace:: {scm_raw_web}
+.. |SCM_BRANCH| replace:: {branch}
+"""
 
 # used to have links to repo files
 extlinks = {

docs/exporter/datadog/datadog.rst

@@ -1,7 +0,0 @@
-OpenTelemetry Datadog Exporter
-==============================
-
-.. automodule:: opentelemetry.exporter.datadog
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/index.rst

@@ -22,9 +22,9 @@ installed separately via pip:
 
     pip install opentelemetry-exporter-{exporter}
     pip install opentelemetry-instrumentation-{instrumentation}
-    pip install opentelemetry-sdk-extension-{sdkextension}
+    pip install opentelemetry-sdk-extension-{sdk-extension}
 
-A complete list of packages can be found at the 
+A complete list of packages can be found at the
 `Contrib repo instrumentation <https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation>`_
 and `Contrib repo exporter <https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/exporter>`_ directories.
 
@@ -33,7 +33,7 @@ Extensions
 
 Visit `OpenTelemetry Registry <https://opentelemetry.io/registry/?s=python>`_ to
 find a lot of related projects like exporters, instrumentation libraries, tracer
-implementations, etc.
+implementations, resource, etc.
 
 Installing Cutting Edge Packages
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -50,17 +50,11 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
     cd opentelemetry-python-contrib
     pip install -e ./instrumentation/opentelemetry-instrumentation-flask
     pip install -e ./instrumentation/opentelemetry-instrumentation-botocore
+    pip install -e ./instrumentation-genai/opentelemetry-instrumentation-openai-v2
     pip install -e ./sdk-extension/opentelemetry-sdk-extension-aws
+    pip install -e ./resource/opentelemetry-resource-detector-containerid
 
 
-.. toctree::
-    :maxdepth: 2
-    :caption: OpenTelemetry Exporters
-    :name: exporters
-    :glob:
-
-    exporter/**
-
 .. toctree::
     :maxdepth: 2
     :caption: OpenTelemetry Instrumentations
@@ -69,6 +63,14 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
 
     instrumentation/**
 
+.. toctree::
+    :maxdepth: 2
+    :caption: OpenTelemetry Generative AI Instrumentations
+    :name: Generative AI Instrumentations
+    :glob:
+
+    instrumentation-genai/**
+
 .. toctree::
     :maxdepth: 2
     :caption: OpenTelemetry Propagators
@@ -93,6 +95,14 @@ install <https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs>
 
     sdk-extension/**
 
+.. toctree::
+    :maxdepth: 2
+    :caption: OpenTelemetry Resource Detectors
+    :name: Resource Detectors
+    :glob:
+
+    resource/**
+
 Indices and tables
 ------------------
 

docs/instrumentation-genai/openai.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Python - OpenAI Instrumentation
+=============================================
+
+.. automodule:: opentelemetry.instrumentation.openai_v2
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/aio_pika/aio_pika.rst

@@ -0,0 +1,7 @@
+OpenTelemetry aio pika Instrumentation
+============================================
+
+.. automodule:: opentelemetry.instrumentation.aio_pika
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/aiohttp_server/aiohttp_server.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-aiohttp-server/README.rst
+    :end-before: References
+
+.. automodule:: opentelemetry.instrumentation.aiohttp_server
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/aiokafka/aiokafka.rst

@@ -0,0 +1,10 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-aiokafka/README.rst
+    :end-before: References
+
+API
+---
+
+.. automodule:: opentelemetry.instrumentation.aiokafka
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/asyncclick/asyncclick.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-asyncclick/README.rst
+    :end-before: References
+
+.. automodule:: opentelemetry.instrumentation.asyncclick
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/asyncio/asyncio.rst

@@ -0,0 +1,7 @@
+OpenTelemetry asyncio Instrumentation
+==============================================
+
+.. automodule:: opentelemetry.instrumentation.asyncio
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/aws_lambda/aws_lambda.rst

@@ -0,0 +1,8 @@
+OpenTelemetry AWS lambda Instrumentation
+==========================================
+
+
+.. automodule:: opentelemetry.instrumentation.aws_lambda
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/instrumentation/boto3sqs/boto3sqs.rst

@@ -0,0 +1,6 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-boto3sqs/README.rst
+
+.. automodule:: opentelemetry.instrumentation.boto3sqs
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/cassandra/cassandra.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Cassandra Instrumentation
+=======================================
+
+.. automodule:: opentelemetry.instrumentation.cassandra
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/click/click.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-click/README.rst
+    :end-before: References
+
+.. automodule:: opentelemetry.instrumentation.click
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/confluent_kafka/confluent_kafka.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-confluent-kafka/README.rst
+
+.. automodule:: opentelemetry.instrumentation.confluent_kafka
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:

docs/instrumentation/elasticsearch/elasticsearch.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-elasticsearch/README.rst
+
+
+.. automodule:: opentelemetry.instrumentation.elasticsearch
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/kafka_python/kafka_python.rst

@@ -0,0 +1,10 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-kafka-python/README.rst
+    :end-before: References
+
+API
+---
+
+.. automodule:: opentelemetry.instrumentation.kafka
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/mysqlclient/mysqlclient.rst

@@ -0,0 +1,7 @@
+OpenTelemetry mysqlclient Instrumentation
+=========================================
+
+.. automodule:: opentelemetry.instrumentation.mysqlclient
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/pika/pika.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Pika Instrumentation
+=====================================
+
+.. automodule:: opentelemetry.instrumentation.pika
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/psycopg/psycopg.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Psycopg Instrumentation
+=====================================
+
+.. automodule:: opentelemetry.instrumentation.psycopg
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/psycopg2/psycopg2.rst

@@ -1,5 +1,5 @@
-OpenTelemetry Psycopg Instrumentation
-=====================================
+OpenTelemetry Psycopg2 Instrumentation
+======================================
 
 .. automodule:: opentelemetry.instrumentation.psycopg2
     :members:

docs/instrumentation/pymssql/pymssql.rst

@@ -0,0 +1,7 @@
+OpenTelemetry pymssql Instrumentation
+=====================================
+
+.. automodule:: opentelemetry.instrumentation.pymssql
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/redis/redis.rst

@@ -1,7 +1,10 @@
-OpenTelemetry Redis Instrumentation
-===================================
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-redis/README.rst
+    :end-before: References
+
+Usage
+-----
 
 .. automodule:: opentelemetry.instrumentation.redis
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/instrumentation/remoulade/remoulade.rst

@@ -0,0 +1,7 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-remoulade/README.rst
+
+
+.. automodule:: opentelemetry.instrumentation.remoulade
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/system_metrics/system_metrics.rst

@@ -0,0 +1,7 @@
+OpenTelemetry system metrics Instrumentation
+============================================
+
+.. automodule:: opentelemetry.instrumentation.system_metrics
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/threading/threading.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Threading Instrumentation
+=======================================
+
+.. automodule:: opentelemetry.instrumentation.threading
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/tortoiseorm/tortoiseorm.rst

@@ -0,0 +1,6 @@
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-tortoiseorm/README.rst
+
+.. automodule:: opentelemetry.instrumentation.tortoiseorm
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/instrumentation/urllib/urllib3.rst

@@ -0,0 +1,7 @@
+OpenTelemetry urllib Instrumentation
+============================================
+
+.. automodule:: opentelemetry.instrumentation.urllib
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/nitpick-exceptions.ini

@@ -1,5 +1,5 @@
 [default]
-class_references=
+py-class=
     ; TODO: Understand why sphinx is not able to find this local class
     opentelemetry.propagators.textmap.CarrierT
     opentelemetry.propagators.textmap.Setter
@@ -9,9 +9,11 @@ class_references=
     opentelemetry.propagators.textmap.DefaultGetter
     ; API
     opentelemetry.propagators.textmap.Getter
-    ; - DatadogFormat
     ; - AWSXRayPropagator
     opentelemetry.sdk.trace.id_generator.IdGenerator
+    opentelemetry.instrumentation.confluent_kafka.ProxiedProducer
+    opentelemetry.instrumentation.confluent_kafka.ProxiedConsumer
+    opentelemetry.instrumentation.instrumentor.BaseInstrumentor
     ; - AwsXRayIdGenerator
     TextMapPropagator
     CarrierT
@@ -22,11 +24,29 @@ class_references=
     httpx.Client
     httpx.AsyncClient
     httpx.BaseTransport
+    openai.BaseTransport
     httpx.AsyncBaseTransport
     httpx.SyncByteStream
     httpx.AsyncByteStream
+    httpx.Response
+    httpx.URL
+    httpx.Headers
+    aiohttp.web_request.Request
+    yarl.URL
+    cimpl.Producer
+    cimpl.Consumer
+    func
+    Message
+    TopicPartition
+    callable
+    Consumer
+    confluent_kafka.Message
+    psycopg.Connection
+    psycopg.AsyncConnection
+    ObjectProxy
+    fastapi.applications.FastAPI
 
-anys=
+any=
     ; API
     opentelemetry.propagators.textmap.TextMapPropagator.fields
     ; - AWSXRayPropagator
@@ -36,7 +56,6 @@ anys=
     ; - AwsXRayIdGenerator
     ; SDK
     SpanProcessor
-    ; - DatadogExportSpanProcessor
     TracerProvider
     ; - AwsXRayIdGenerator
     ; Instrumentation
@@ -44,3 +63,23 @@ anys=
     ; - instrumentation.*
     Setter
     httpx
+    instrument
+    __iter__
+    list.__iter__
+    __getitem__
+    list.__getitem__
+    SQS.ReceiveMessage
+
+py-obj=
+    opentelemetry.propagators.textmap.CarrierT
+    opentelemetry.instrumentation.dbapi.ConnectionT
+    opentelemetry.instrumentation.dbapi.CursorT
+
+py-func=
+    poll
+    flush
+    Message.error
+
+py-exc=
+    KafkaException
+    KafkaError

docs/resource/container/container.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Python - Resource Detector for Containers
+=======================================================
+
+.. automodule:: opentelemetry.resource.detector.containerid
+    :members:
+    :undoc-members:
+    :show-inheritance:

eachdist.ini

@@ -16,7 +16,7 @@ sortfirst=
     ext/*
 
 [stable]
-version=1.7.1
+version=1.36.0.dev
 
 packages=
     opentelemetry-sdk
@@ -34,13 +34,26 @@ packages=
     opentelemetry-api
 
 [prerelease]
-version=0.26b1
+version=0.57b0.dev
 
 packages=
     all
     opentelemetry-semantic-conventions
     opentelemetry-test-utils
     opentelemetry-instrumentation
+    opentelemetry-contrib-instrumentations
+    opentelemetry-distro
+    opentelemetry-resource-detector-containerid
+
+[exclude_release]
+packages=
+    opentelemetry-resource-detector-azure
+    opentelemetry-sdk-extension-aws
+    opentelemetry-propagator-aws-xray
+    opentelemetry-instrumentation-google-genai
+    opentelemetry-instrumentation-vertexai
+    opentelemetry-instrumentation-openai-v2
+    opentelemetry-instrumentation-test
 
 [lintroots]
 extraroots=examples/*,scripts/

exporter/opentelemetry-exporter-datadog/README.rst

@@ -1,29 +0,0 @@
-OpenTelemetry Datadog Exporter
-==============================
-
-|pypi|
-
-.. |pypi| image:: https://badge.fury.io/py/opentelemetry-exporter-datadog.svg
-   :target: https://pypi.org/project/opentelemetry-exporter-datadog/
-
-This library allows to export tracing data to `Datadog
-<https://www.datadoghq.com/>`_. OpenTelemetry span event and links are not
-supported.
-
-Installation
-------------
-
-::
-
-    pip install opentelemetry-exporter-datadog
-
-
-.. _Datadog: https://www.datadoghq.com/
-.. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/
-
-
-References
-----------
-
-* `Datadog <https://www.datadoghq.com/>`_
-* `OpenTelemetry Project <https://opentelemetry.io/>`_

exporter/opentelemetry-exporter-datadog/setup.cfg

@@ -1,52 +0,0 @@
-# Copyright The OpenTelemetry Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-[metadata]
-name = opentelemetry-exporter-datadog
-description = Datadog Span Exporter for OpenTelemetry
-long_description = file: README.rst
-long_description_content_type = text/x-rst
-author = OpenTelemetry Authors
-author_email = cncf-opentelemetry-contributors@lists.cncf.io
-url = https://github.com/open-telemetry/opentelemetry-python-contrib/exporter/opentelemetry-exporter-datadog
-platforms = any
-license = Apache-2.0
-classifiers =
-    Development Status :: 4 - Beta
-    Intended Audience :: Developers
-    License :: OSI Approved :: Apache Software License
-    Programming Language :: Python
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.6
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Programming Language :: Python :: 3.10
-
-[options]
-python_requires = >=3.6
-package_dir=
-    =src
-packages=find_namespace:
-install_requires =
-    ddtrace>=0.34.0,<0.47.0
-    opentelemetry-api ~= 1.3
-    opentelemetry-sdk ~= 1.3
-    opentelemetry-semantic-conventions == 0.26b1
-
-[options.packages.find]
-where = src
-
-[options.extras_require]
-test =

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/__init__.py

@@ -1,77 +0,0 @@
-# Copyright The OpenTelemetry Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""
-The **OpenTelemetry Datadog Exporter** provides a span exporter from
-`OpenTelemetry`_ traces to `Datadog`_ by using the Datadog Agent.
-
-Installation
-------------
-
-::
-
-    pip install opentelemetry-exporter-datadog
-
-
-Usage
------
-
-The Datadog exporter provides a span processor that must be added along with the
-exporter. In addition, a formatter is provided to handle propagation of trace
-context between OpenTelemetry-instrumented and Datadog-instrumented services in
-a distributed trace.
-
-.. code:: python
-
-    from opentelemetry.propagate import set_global_textmap
-    from opentelemetry import trace
-    from opentelemetry.exporter.datadog import DatadogExportSpanProcessor, DatadogSpanExporter
-    from opentelemetry.exporter.datadog.propagator import DatadogFormat
-    from opentelemetry.sdk.trace import TracerProvider
-
-    trace.set_tracer_provider(TracerProvider())
-    tracer = trace.get_tracer(__name__)
-
-    exporter = DatadogSpanExporter(
-        agent_url="http://agent:8126", service="my-helloworld-service"
-    )
-
-    span_processor = DatadogExportSpanProcessor(exporter)
-    trace.get_tracer_provider().add_span_processor(span_processor)
-
-    # Optional: use Datadog format for propagation in distributed traces
-    set_global_textmap(DatadogFormat())
-
-    with tracer.start_as_current_span("foo"):
-        print("Hello world!")
-
-
-Examples
---------
-
-The `docs/examples/datadog_exporter`_ includes examples for using the Datadog
-exporter with OpenTelemetry instrumented applications.
-
-API
----
-.. _Datadog: https://www.datadoghq.com/
-.. _OpenTelemetry: https://github.com/open-telemetry/opentelemetry-python/
-.. _docs/examples/datadog_exporter: https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples/datadog_exporter
-"""
-# pylint: disable=import-error
-
-from .exporter import DatadogSpanExporter
-from .spanprocessor import DatadogExportSpanProcessor
-
-__all__ = ["DatadogExportSpanProcessor", "DatadogSpanExporter"]

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/constants.py

@@ -1,16 +0,0 @@
-DD_ORIGIN = "dd_origin"
-AUTO_REJECT = 0
-AUTO_KEEP = 1
-USER_KEEP = 2
-SAMPLE_RATE_METRIC_KEY = "_sample_rate"
-SAMPLING_PRIORITY_KEY = "_sampling_priority_v1"
-ENV_KEY = "env"
-VERSION_KEY = "version"
-SERVICE_NAME_TAG = "service.name"
-EVENT_NAME_EXCEPTION = "exception"
-EXCEPTION_TYPE_ATTR_KEY = "exception.type"
-EXCEPTION_MSG_ATTR_KEY = "exception.message"
-EXCEPTION_STACK_ATTR_KEY = "exception.stacktrace"
-DD_ERROR_TYPE_TAG_KEY = "error.type"
-DD_ERROR_MSG_TAG_KEY = "error.msg"
-DD_ERROR_STACK_TAG_KEY = "error.stack"

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/exporter.py

@@ -1,346 +0,0 @@
-# Copyright The OpenTelemetry Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import logging
-import os
-from urllib.parse import urlparse
-
-from ddtrace.ext import SpanTypes as DatadogSpanTypes
-from ddtrace.internal.writer import AgentWriter
-from ddtrace.span import Span as DatadogSpan
-
-import opentelemetry.trace as trace_api
-from opentelemetry.exporter.datadog.constants import (
-    DD_ERROR_MSG_TAG_KEY,
-    DD_ERROR_STACK_TAG_KEY,
-    DD_ERROR_TYPE_TAG_KEY,
-    DD_ORIGIN,
-    ENV_KEY,
-    EVENT_NAME_EXCEPTION,
-    EXCEPTION_MSG_ATTR_KEY,
-    EXCEPTION_STACK_ATTR_KEY,
-    EXCEPTION_TYPE_ATTR_KEY,
-    SAMPLE_RATE_METRIC_KEY,
-    SERVICE_NAME_TAG,
-    VERSION_KEY,
-)
-from opentelemetry.sdk.trace import sampling
-from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
-from opentelemetry.semconv.trace import SpanAttributes
-
-logger = logging.getLogger(__name__)
-
-
-DEFAULT_AGENT_URL = "http://localhost:8126"
-_INSTRUMENTATION_SPAN_TYPES = {
-    "opentelemetry.instrumentation.aiohttp-client": DatadogSpanTypes.HTTP,
-    "opentelemetry.instrumentation.asgi": DatadogSpanTypes.WEB,
-    "opentelemetry.instrumentation.dbapi": DatadogSpanTypes.SQL,
-    "opentelemetry.instrumentation.django": DatadogSpanTypes.WEB,
-    "opentelemetry.instrumentation.flask": DatadogSpanTypes.WEB,
-    "opentelemetry.instrumentation.grpc": DatadogSpanTypes.GRPC,
-    "opentelemetry.instrumentation.jinja2": DatadogSpanTypes.TEMPLATE,
-    "opentelemetry.instrumentation.mysql": DatadogSpanTypes.SQL,
-    "opentelemetry.instrumentation.psycopg2": DatadogSpanTypes.SQL,
-    "opentelemetry.instrumentation.pymemcache": DatadogSpanTypes.CACHE,
-    "opentelemetry.instrumentation.pymongo": DatadogSpanTypes.MONGODB,
-    "opentelemetry.instrumentation.pymysql": DatadogSpanTypes.SQL,
-    "opentelemetry.instrumentation.redis": DatadogSpanTypes.REDIS,
-    "opentelemetry.instrumentation.requests": DatadogSpanTypes.HTTP,
-    "opentelemetry.instrumentation.sqlalchemy": DatadogSpanTypes.SQL,
-    "opentelemetry.instrumentation.wsgi": DatadogSpanTypes.WEB,
-}
-
-
-class DatadogSpanExporter(SpanExporter):
-    """Datadog span exporter for OpenTelemetry.
-
-    Args:
-        agent_url: The url of the Datadog Agent or use ``DD_TRACE_AGENT_URL`` environment variable
-        service: The service name to be used for the application or use ``DD_SERVICE`` environment variable
-        env: Set the application’s environment or use ``DD_ENV`` environment variable
-        version: Set the application’s version or use ``DD_VERSION`` environment variable
-        tags: A list (formatted as a comma-separated string) of default tags to be added to every span or use ``DD_TAGS`` environment variable
-    """
-
-    def __init__(
-        self, agent_url=None, service=None, env=None, version=None, tags=None
-    ):
-        self.agent_url = (
-            agent_url
-            if agent_url
-            else os.environ.get("DD_TRACE_AGENT_URL", DEFAULT_AGENT_URL)
-        )
-        self.service = service or os.environ.get("DD_SERVICE")
-        self.env = env or os.environ.get("DD_ENV")
-        self.version = version or os.environ.get("DD_VERSION")
-        self.tags = _parse_tags_str(tags or os.environ.get("DD_TAGS"))
-        self._agent_writer = None
-
-    @property
-    def agent_writer(self):
-        if self._agent_writer is None:
-            url_parsed = urlparse(self.agent_url)
-            if url_parsed.scheme in ("http", "https"):
-                self._agent_writer = AgentWriter(
-                    hostname=url_parsed.hostname,
-                    port=url_parsed.port,
-                    https=url_parsed.scheme == "https",
-                )
-            elif url_parsed.scheme == "unix":
-                self._agent_writer = AgentWriter(uds_path=url_parsed.path)
-            else:
-                raise ValueError(
-                    f"Unknown scheme `{url_parsed.scheme}` for agent URL"
-                )
-        return self._agent_writer
-
-    def export(self, spans):
-        datadog_spans = self._translate_to_datadog(spans)
-
-        self.agent_writer.write(spans=datadog_spans)
-
-        return SpanExportResult.SUCCESS
-
-    def shutdown(self):
-        if self.agent_writer.started:
-            self.agent_writer.stop()
-            self.agent_writer.join(self.agent_writer.exit_timeout)
-
-    # pylint: disable=too-many-locals
-    def _translate_to_datadog(self, spans):
-        datadog_spans = []
-
-        for span in spans:
-            trace_id, parent_id, span_id = _get_trace_ids(span)
-
-            # datadog Span is initialized with a reference to the tracer which is
-            # used to record the span when it is finished. We can skip ignore this
-            # because we are not calling the finish method and explictly set the
-            # duration.
-            tracer = None
-
-            # extract resource attributes to be used as tags as well as potential service name
-            [
-                resource_tags,
-                resource_service_name,
-            ] = _extract_tags_from_resource(span.resource, self.service)
-
-            datadog_span = DatadogSpan(
-                tracer,
-                _get_span_name(span),
-                service=resource_service_name,
-                resource=_get_resource(span),
-                span_type=_get_span_type(span),
-                trace_id=trace_id,
-                span_id=span_id,
-                parent_id=parent_id,
-            )
-            datadog_span.start_ns = span.start_time
-            datadog_span.duration_ns = span.end_time - span.start_time
-
-            if not span.status.is_ok:
-                datadog_span.error = 1
-                # loop over events and look for exception events, extract info.
-                # https://github.com/open-telemetry/opentelemetry-python/blob/71e3a7a192c0fc8a7503fac967ada36a74b79e58/opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py#L810-L819
-                if span.events:
-                    _extract_tags_from_exception_events(
-                        span.events, datadog_span
-                    )
-
-            # combine resource attributes and span attributes, don't modify existing span attributes
-            combined_span_tags = {}
-            combined_span_tags.update(resource_tags)
-            combined_span_tags.update(span.attributes)
-
-            datadog_span.set_tags(combined_span_tags)
-
-            # add configured env tag
-            if self.env is not None:
-                datadog_span.set_tag(ENV_KEY, self.env)
-
-            # add configured application version tag to only root span
-            if self.version is not None and parent_id == 0:
-                datadog_span.set_tag(VERSION_KEY, self.version)
-
-            # add configured global tags
-            datadog_span.set_tags(self.tags)
-
-            # add origin to root span
-            origin = _get_origin(span)
-            if origin and parent_id == 0:
-                datadog_span.set_tag(DD_ORIGIN, origin)
-
-            sampling_rate = _get_sampling_rate(span)
-            if sampling_rate is not None:
-                datadog_span.set_metric(SAMPLE_RATE_METRIC_KEY, sampling_rate)
-
-            # span events and span links are not supported except for extracting exception event context
-
-            datadog_spans.append(datadog_span)
-
-        return datadog_spans
-
-
-def _get_trace_ids(span):
-    """Extract tracer ids from span"""
-    ctx = span.get_span_context()
-    trace_id = ctx.trace_id
-    span_id = ctx.span_id
-
-    if isinstance(span.parent, trace_api.Span):
-        parent_id = span.parent.get_span_context().span_id
-    elif isinstance(span.parent, trace_api.SpanContext):
-        parent_id = span.parent.span_id
-    else:
-        parent_id = 0
-
-    trace_id = _convert_trace_id_uint64(trace_id)
-
-    return trace_id, parent_id, span_id
-
-
-def _convert_trace_id_uint64(otel_id):
-    """Convert 128-bit int used for trace_id to 64-bit unsigned int"""
-    return otel_id & 0xFFFFFFFFFFFFFFFF
-
-
-def _get_span_name(span):
-    """Get span name by using instrumentation and kind while backing off to
-    span.name
-    """
-    instrumentation_name = (
-        span.instrumentation_info.name if span.instrumentation_info else None
-    )
-    span_kind_name = span.kind.name if span.kind else None
-    name = (
-        f"{instrumentation_name}.{span_kind_name}"
-        if instrumentation_name and span_kind_name
-        else span.name
-    )
-    return name
-
-
-def _get_resource(span):
-    """Get resource name for span"""
-    if SpanAttributes.HTTP_METHOD in span.attributes:
-        route = span.attributes.get(SpanAttributes.HTTP_ROUTE)
-        return (
-            span.attributes[SpanAttributes.HTTP_METHOD] + " " + route
-            if route
-            else span.attributes[SpanAttributes.HTTP_METHOD]
-        )
-
-    return span.name
-
-
-def _get_span_type(span):
-    """Get Datadog span type"""
-    instrumentation_name = (
-        span.instrumentation_info.name if span.instrumentation_info else None
-    )
-    span_type = _INSTRUMENTATION_SPAN_TYPES.get(instrumentation_name)
-    return span_type
-
-
-def _get_exc_info(span):
-    """Parse span status description for exception type and value"""
-    exc_type, exc_val = span.status.description.split(":", 1)
-    return exc_type, exc_val.strip()
-
-
-def _get_origin(span):
-    ctx = span.get_span_context()
-    origin = ctx.trace_state.get(DD_ORIGIN)
-    return origin
-
-
-def _get_sampling_rate(span):
-    ctx = span.get_span_context()
-    tracer_provider = trace_api.get_tracer_provider()
-    if not hasattr(tracer_provider, "sampler"):
-        return None
-    sampler = tracer_provider.sampler
-    return (
-        sampler.rate
-        if ctx.trace_flags.sampled
-        and isinstance(sampler, sampling.TraceIdRatioBased)
-        else None
-    )
-
-
-def _parse_tags_str(tags_str):
-    """Parse a string of tags typically provided via environment variables.
-
-    The expected string is of the form::
-        "key1:value1,key2:value2"
-
-    :param tags_str: A string of the above form to parse tags from.
-    :return: A dict containing the tags that were parsed.
-    """
-    parsed_tags = {}
-    if not tags_str:
-        return parsed_tags
-
-    for tag in tags_str.split(","):
-        try:
-            key, value = tag.split(":", 1)
-
-            # Validate the tag
-            if key == "" or value == "" or value.endswith(":"):
-                raise ValueError
-        except ValueError:
-            logger.error(
-                "Malformed tag in tag pair '%s' from tag string '%s'.",
-                tag,
-                tags_str,
-            )
-        else:
-            parsed_tags[key] = value
-
-    return parsed_tags
-
-
-def _extract_tags_from_resource(resource, fallback_service_name):
-    """Parse tags from resource.attributes, except service.name which
-    has special significance within datadog"""
-    tags = {}
-    if not (resource and getattr(resource, "attributes", None)):
-        return [tags, fallback_service_name]
-
-    service_name = None
-    for attribute_key, attribute_value in resource.attributes.items():
-        if attribute_key == SERVICE_NAME_TAG:
-            service_name = attribute_value
-        else:
-            tags[attribute_key] = attribute_value
-
-    if service_name is None or service_name == "unknown_service":
-        service_name = fallback_service_name
-
-    return [tags, service_name]
-
-
-def _extract_tags_from_exception_events(events, datadog_span):
-    """Parse error tags from exception events, error.msg error.type
-    and error.stack have special significance within datadog"""
-    for event in events:
-        if event.name is not None and event.name == EVENT_NAME_EXCEPTION:
-            for key, value in event.attributes.items():
-                if key == EXCEPTION_TYPE_ATTR_KEY:
-                    datadog_span.set_tag(DD_ERROR_TYPE_TAG_KEY, value)
-                elif key == EXCEPTION_MSG_ATTR_KEY:
-                    datadog_span.set_tag(DD_ERROR_MSG_TAG_KEY, value)
-                elif key == EXCEPTION_STACK_ATTR_KEY:
-                    datadog_span.set_tag(DD_ERROR_STACK_TAG_KEY, value)

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/propagator.py

@@ -1,148 +0,0 @@
-# Copyright The OpenTelemetry Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import typing
-
-from opentelemetry import trace
-from opentelemetry.context import Context
-from opentelemetry.exporter.datadog import constants
-from opentelemetry.propagators.textmap import (
-    CarrierT,
-    Getter,
-    Setter,
-    TextMapPropagator,
-    default_getter,
-    default_setter,
-)
-from opentelemetry.trace import get_current_span, set_span_in_context
-
-
-class DatadogFormat(TextMapPropagator):
-    """Propagator for the Datadog HTTP header format."""
-
-    TRACE_ID_KEY = "x-datadog-trace-id"
-    PARENT_ID_KEY = "x-datadog-parent-id"
-    SAMPLING_PRIORITY_KEY = "x-datadog-sampling-priority"
-    ORIGIN_KEY = "x-datadog-origin"
-
-    def extract(
-        self,
-        carrier: CarrierT,
-        context: typing.Optional[Context] = None,
-        getter: Getter = default_getter,
-    ) -> Context:
-        if context is None:
-            context = Context()
-
-        trace_id = extract_first_element(
-            getter.get(carrier, self.TRACE_ID_KEY)
-        )
-
-        span_id = extract_first_element(
-            getter.get(carrier, self.PARENT_ID_KEY)
-        )
-
-        sampled = extract_first_element(
-            getter.get(carrier, self.SAMPLING_PRIORITY_KEY)
-        )
-
-        origin = extract_first_element(getter.get(carrier, self.ORIGIN_KEY))
-
-        trace_flags = trace.TraceFlags()
-        if sampled and int(sampled) in (
-            constants.AUTO_KEEP,
-            constants.USER_KEEP,
-        ):
-            trace_flags = trace.TraceFlags(trace.TraceFlags.SAMPLED)
-
-        if trace_id is None or span_id is None:
-            return context
-
-        trace_state = []
-        if origin is not None:
-            trace_state.append((constants.DD_ORIGIN, origin))
-        span_context = trace.SpanContext(
-            trace_id=int(trace_id),
-            span_id=int(span_id),
-            is_remote=True,
-            trace_flags=trace_flags,
-            trace_state=trace.TraceState(trace_state),
-        )
-
-        return set_span_in_context(
-            trace.NonRecordingSpan(span_context), context
-        )
-
-    def inject(
-        self,
-        carrier: CarrierT,
-        context: typing.Optional[Context] = None,
-        setter: Setter = default_setter,
-    ) -> None:
-        span = get_current_span(context)
-        span_context = span.get_span_context()
-        if span_context == trace.INVALID_SPAN_CONTEXT:
-            return
-        sampled = (trace.TraceFlags.SAMPLED & span.context.trace_flags) != 0
-        setter.set(
-            carrier,
-            self.TRACE_ID_KEY,
-            format_trace_id(span.context.trace_id),
-        )
-        setter.set(
-            carrier, self.PARENT_ID_KEY, format_span_id(span.context.span_id)
-        )
-        setter.set(
-            carrier,
-            self.SAMPLING_PRIORITY_KEY,
-            str(constants.AUTO_KEEP if sampled else constants.AUTO_REJECT),
-        )
-        if constants.DD_ORIGIN in span.context.trace_state:
-            setter.set(
-                carrier,
-                self.ORIGIN_KEY,
-                span.context.trace_state[constants.DD_ORIGIN],
-            )
-
-    @property
-    def fields(self):
-        """Returns a set with the fields set in `inject`.
-
-        See
-        `opentelemetry.propagators.textmap.TextMapPropagator.fields`
-        """
-        return {
-            self.TRACE_ID_KEY,
-            self.PARENT_ID_KEY,
-            self.SAMPLING_PRIORITY_KEY,
-            self.ORIGIN_KEY,
-        }
-
-
-def format_trace_id(trace_id: int) -> str:
-    """Format the trace id for Datadog."""
-    return str(trace_id & 0xFFFFFFFFFFFFFFFF)
-
-
-def format_span_id(span_id: int) -> str:
-    """Format the span id for Datadog."""
-    return str(span_id)
-
-
-def extract_first_element(
-    items: typing.Iterable[CarrierT],
-) -> typing.Optional[CarrierT]:
-    if items is None:
-        return None
-    return next(iter(items), None)

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/spanprocessor.py

@@ -1,226 +0,0 @@
-# Copyright The OpenTelemetry Authors
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import collections
-import logging
-import threading
-import typing
-
-from opentelemetry.context import Context, attach, detach, set_value
-from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
-from opentelemetry.sdk.trace import Span, SpanProcessor
-from opentelemetry.sdk.trace.export import SpanExporter
-from opentelemetry.trace import INVALID_TRACE_ID
-from opentelemetry.util._time import _time_ns
-
-logger = logging.getLogger(__name__)
-
-
-class DatadogExportSpanProcessor(SpanProcessor):
-    """Datadog exporter span processor
-
-    DatadogExportSpanProcessor is an implementation of `SpanProcessor` that
-    batches all opened spans into a list per trace. When all spans for a trace
-    are ended, the trace is queues up for export. This is required for exporting
-    to the Datadog Agent which expects to received list of spans for each trace.
-    """
-
-    _FLUSH_TOKEN = INVALID_TRACE_ID
-
-    def __init__(
-        self,
-        span_exporter: SpanExporter,
-        schedule_delay_millis: float = 5000,
-        max_trace_size: int = 4096,
-    ):
-        if max_trace_size <= 0:
-            raise ValueError("max_queue_size must be a positive integer.")
-
-        if schedule_delay_millis <= 0:
-            raise ValueError("schedule_delay_millis must be positive.")
-
-        self.span_exporter = span_exporter
-
-        # queue trace_ids for traces with recently ended spans for worker thread to check
-        # for exporting
-        self.check_traces_queue = (
-            collections.deque()
-        )  # type: typing.Deque[int]
-
-        self.traces_lock = threading.Lock()
-        # dictionary of trace_ids to a list of spans where the first span is the
-        # first opened span for the trace
-        self.traces = collections.defaultdict(list)
-        # counter to keep track of the number of spans and ended spans for a
-        # trace_id
-        self.traces_spans_count = collections.Counter()
-        self.traces_spans_ended_count = collections.Counter()
-
-        self.worker_thread = threading.Thread(target=self.worker, daemon=True)
-
-        # threading conditions used for flushing and shutdown
-        self.condition = threading.Condition(threading.Lock())
-        self.flush_condition = threading.Condition(threading.Lock())
-
-        # flag to indicate that there is a flush operation on progress
-        self._flushing = False
-
-        self.max_trace_size = max_trace_size
-        self._spans_dropped = False
-        self.schedule_delay_millis = schedule_delay_millis
-        self.done = False
-        self.worker_thread.start()
-
-    def on_start(
-        self, span: Span, parent_context: typing.Optional[Context] = None
-    ) -> None:
-        ctx = span.get_span_context()
-        trace_id = ctx.trace_id
-
-        with self.traces_lock:
-            # check upper bound on number of spans for trace before adding new
-            # span
-            if self.traces_spans_count[trace_id] == self.max_trace_size:
-                logger.warning("Max spans for trace, spans will be dropped.")
-                self._spans_dropped = True
-                return
-
-            # add span to end of list for a trace and update the counter
-            self.traces[trace_id].append(span)
-            self.traces_spans_count[trace_id] += 1
-
-    def on_end(self, span: Span) -> None:
-        if self.done:
-            logger.warning("Already shutdown, dropping span.")
-            return
-
-        ctx = span.get_span_context()
-        trace_id = ctx.trace_id
-
-        with self.traces_lock:
-            self.traces_spans_ended_count[trace_id] += 1
-            if self.is_trace_exportable(trace_id):
-                self.check_traces_queue.appendleft(trace_id)
-
-    def worker(self):
-        timeout = self.schedule_delay_millis / 1e3
-        while not self.done:
-            if not self._flushing:
-                with self.condition:
-                    self.condition.wait(timeout)
-                    if not self.check_traces_queue:
-                        # spurious notification, let's wait again, reset timeout
-                        timeout = self.schedule_delay_millis / 1e3
-                        continue
-                    if self.done:
-                        # missing spans will be sent when calling flush
-                        break
-
-            # substract the duration of this export call to the next timeout
-            start = _time_ns()
-            self.export()
-            end = _time_ns()
-            duration = (end - start) / 1e9
-            timeout = self.schedule_delay_millis / 1e3 - duration
-
-        # be sure that all spans are sent
-        self._drain_queue()
-
-    def is_trace_exportable(self, trace_id):
-        return (
-            self.traces_spans_count[trace_id]
-            - self.traces_spans_ended_count[trace_id]
-            <= 0
-        )
-
-    def export(self) -> None:
-        """Exports traces with finished spans."""
-        notify_flush = False
-        export_trace_ids = []
-
-        while self.check_traces_queue:
-            trace_id = self.check_traces_queue.pop()
-            if trace_id is self._FLUSH_TOKEN:
-                notify_flush = True
-            else:
-                with self.traces_lock:
-                    # check whether trace is exportable again in case that new
-                    # spans were started since we last concluded trace was
-                    # exportable
-                    if self.is_trace_exportable(trace_id):
-                        export_trace_ids.append(trace_id)
-                        del self.traces_spans_count[trace_id]
-                        del self.traces_spans_ended_count[trace_id]
-
-        if len(export_trace_ids) > 0:
-            token = attach(set_value(_SUPPRESS_INSTRUMENTATION_KEY, True))
-
-            for trace_id in export_trace_ids:
-                with self.traces_lock:
-                    try:
-                        # Ignore type b/c the Optional[None]+slicing is too "clever"
-                        # for mypy
-                        self.span_exporter.export(self.traces[trace_id])  # type: ignore
-                    # pylint: disable=broad-except
-                    except Exception:
-                        logger.exception(
-                            "Exception while exporting Span batch."
-                        )
-                    finally:
-                        del self.traces[trace_id]
-
-            detach(token)
-
-        if notify_flush:
-            with self.flush_condition:
-                self.flush_condition.notify()
-
-    def _drain_queue(self):
-        """Export all elements until queue is empty.
-
-        Can only be called from the worker thread context because it invokes
-        `export` that is not thread safe.
-        """
-        while self.check_traces_queue:
-            self.export()
-
-    def force_flush(self, timeout_millis: int = 30000) -> bool:
-        if self.done:
-            logger.warning("Already shutdown, ignoring call to force_flush().")
-            return True
-
-        self._flushing = True
-        self.check_traces_queue.appendleft(self._FLUSH_TOKEN)
-
-        # wake up worker thread
-        with self.condition:
-            self.condition.notify_all()
-
-        # wait for token to be processed
-        with self.flush_condition:
-            ret = self.flush_condition.wait(timeout_millis / 1e3)
-
-        self._flushing = False
-
-        if not ret:
-            logger.warning("Timeout was exceeded in force_flush().")
-        return ret
-
-    def shutdown(self) -> None:
-        # signal the worker thread to finish and then wait for it
-        self.done = True
-        with self.condition:
-            self.condition.notify_all()
-        self.worker_thread.join()
-        self.span_exporter.shutdown()