Reduce boilerplate sprawl for genai instrumentations

aabmass · aabmass · commit a8e22f5dbeaf · 2026-03-11T03:06:47.000Z
diff --git a/.github/workflows/misc_0.yml b/.github/workflows/misc_0.yml
@@ -194,3 +194,22 @@ jobs:
 
       - name: Run tests
         run: tox -e typecheck
+
+  check-genai-readme:
+    name: check-genai-readme
+    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 check-genai-readme
diff --git a/.github/workflows/package-release.yml b/.github/workflows/package-release.yml
@@ -4,6 +4,9 @@ on:
     inputs:
       package:
         type: choice
+        # NOTE: This list is static. The workflow validates the selection
+        # against the dynamically generated list of independent packages
+        # from scripts/discover_genai_packages.py
         options:
         - opentelemetry-opamp-client
         - opentelemetry-propagator-aws-xray
@@ -36,6 +39,22 @@ jobs:
 
       - uses: actions/checkout@v4
 
+      - name: Setup Python for discovery
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Validate package selection
+        id: validate
+        run: |
+          independent_packages=$(python ./scripts/discover_genai_packages.py --independent-json)
+          if [[ $(echo "$independent_packages" | jq 'index("${{ inputs.package }}")') == "null" ]]; then
+            echo "Error: ${{ inputs.package }} is not configured for independent release or does not exist."
+            echo "Check the [tool.opentelemetry.instrumentation] section in its pyproject.toml"
+            exit 1
+          fi
+          echo "Package ${{ inputs.package }} is valid for independent release."
+
       - name: Set environment variables
         run: |
           version=$(./scripts/eachdist.py version --package ${{ inputs.package }})
diff --git a/RELEASING.md b/RELEASING.md
@@ -22,18 +22,17 @@
 > - opentelemetry-propagator-aws-xray
 > - opentelemetry-resource-detector-azure
 > - opentelemetry-sdk-extension-aws
-> - opentelemetry-instrumentation-openai-v2
-> - opentelemetry-instrumentation-openai-agents-v2
-> - opentelemetry-instrumentation-vertexai
-> - opentelemetry-instrumentation-anthropic
-> - opentelemetry-instrumentation-claude-agent-sdk
-> - opentelemetry-instrumentation-google-genai
-> - opentelemetry-instrumentation-langchain
-> - opentelemetry-instrumentation-weaviate
-> - opentelemetry-util-genai
+> - All packages under `instrumentation-genai/` configured for independent release (see below).
 >
 > These libraries are also excluded from the general release.
 
+To configure an `instrumentation-genai/` package for individual release, add the following to its `pyproject.toml`:
+
+```toml
+[tool.opentelemetry.instrumentation]
+independent_release = true
+```
+
 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.
 
@@ -87,21 +86,7 @@ The workflow will create a pull request that should be merged in order to procee
 ### Releasing individual package
 
 > [!NOTE]
-> Per-package patch release is supported for the following packages only:
-> - opentelemetry-opamp-client
-> - opentelemetry-propagator-aws-xray
-> - opentelemetry-resource-detector-azure
-> - opentelemetry-sdk-extension-aws
-> - opentelemetry-instrumentation-openai-v2
-> - opentelemetry-instrumentation-openai-agents-v2
-> - opentelemetry-instrumentation-vertexai
-> - opentelemetry-instrumentation-anthropic
-> - opentelemetry-instrumentation-claude-agent-sdk
-> - opentelemetry-instrumentation-google-genai
-> - opentelemetry-instrumentation-langchain
-> - opentelemetry-instrumentation-weaviate
-> - opentelemetry-util-genai
-> - opentelemetry-exporter-credential-provider-gcp
+> Per-package release is supported for the packages listed in the `[Package] Release` workflow, including GenAI packages configured for independent release.
 >
 > These libraries are also excluded from the general patch release.
 
diff --git a/instrumentation-genai/README.md b/instrumentation-genai/README.md
@@ -1,11 +1,17 @@
+# GenAI Instrumentations
 
-| Instrumentation | Supported Packages | Metrics support | Semconv status |
-| --------------- | ------------------ | --------------- | -------------- |
-| [opentelemetry-instrumentation-anthropic](./opentelemetry-instrumentation-anthropic) | anthropic >= 0.16.0 | No | development
-| [opentelemetry-instrumentation-claude-agent-sdk](./opentelemetry-instrumentation-claude-agent-sdk) | claude-agent-sdk >= 0.1.14 | No | development
-| [opentelemetry-instrumentation-google-genai](./opentelemetry-instrumentation-google-genai) | google-genai >= 1.32.0 | No | development
-| [opentelemetry-instrumentation-langchain](./opentelemetry-instrumentation-langchain) | langchain >= 0.3.21 | No | development
-| [opentelemetry-instrumentation-openai-agents-v2](./opentelemetry-instrumentation-openai-agents-v2) | openai-agents >= 0.3.3 | No | development
-| [opentelemetry-instrumentation-openai-v2](./opentelemetry-instrumentation-openai-v2) | openai >= 1.26.0 | Yes | development
-| [opentelemetry-instrumentation-vertexai](./opentelemetry-instrumentation-vertexai) | google-cloud-aiplatform >= 1.64 | No | development
-| [opentelemetry-instrumentation-weaviate](./opentelemetry-instrumentation-weaviate) | weaviate-client >= 3.0.0,<5.0.0 | No | development
+This directory contains OpenTelemetry instrumentations for Generative AI (GenAI) libraries and frameworks.
+
+<!-- BEGIN GENERATED TABLE -->
+| Package | Instrumented Library | Semantic Attributes | Status |
+|---|---|---|---|
+
+| [opentelemetry-instrumentation-anthropic](./opentelemetry-instrumentation-anthropic) | Anthropic SDK | Yes | Development |
+| [opentelemetry-instrumentation-claude-agent-sdk](./opentelemetry-instrumentation-claude-agent-sdk) | Claude Agent SDK | Yes | Development |
+| [opentelemetry-instrumentation-google-genai](./opentelemetry-instrumentation-google-genai) | Google GenAI | No | Development |
+| [opentelemetry-instrumentation-langchain](./opentelemetry-instrumentation-langchain) | Langchain | Yes | Development |
+| [opentelemetry-instrumentation-openai-agents-v2](./opentelemetry-instrumentation-openai-agents-v2) | OpenAI Agents v2 | Yes | Development |
+| [opentelemetry-instrumentation-openai-v2](./opentelemetry-instrumentation-openai-v2) | OpenAI v2 | Yes | Stable |
+| [opentelemetry-instrumentation-vertexai](./opentelemetry-instrumentation-vertexai) | Vertex AI | Yes | Beta |
+| [opentelemetry-instrumentation-weaviate](./opentelemetry-instrumentation-weaviate) | Weaviate | Yes | Development |
+<!-- END GENERATED TABLE -->
diff --git a/instrumentation-genai/opentelemetry-instrumentation-anthropic/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-anthropic/pyproject.toml
@@ -57,6 +57,13 @@ include = [
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "Anthropic SDK"
+readme_sia = "Yes"
+readme_status = "Development"
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 
diff --git a/instrumentation-genai/opentelemetry-instrumentation-claude-agent-sdk/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-claude-agent-sdk/pyproject.toml
@@ -55,5 +55,12 @@ include = [
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "Claude Agent SDK"
+readme_sia = "Yes"
+readme_status = "Development"
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
diff --git a/instrumentation-genai/opentelemetry-instrumentation-google-genai/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-google-genai/pyproject.toml
@@ -64,6 +64,13 @@ include = ["/src", "/tests"]
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "Google GenAI"
+readme_sia = "No"
+readme_status = "Development"
+
 [tool.pyright]
 include = ["src"]
 exclude = ["**/__pycache__"]
diff --git a/instrumentation-genai/opentelemetry-instrumentation-langchain/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-langchain/pyproject.toml
@@ -50,6 +50,13 @@ include = [
   "/tests",
 ]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "Langchain"
+readme_sia = "Yes"
+readme_status = "Development"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]
 
diff --git a/instrumentation-genai/opentelemetry-instrumentation-openai-agents-v2/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-openai-agents-v2/pyproject.toml
@@ -52,5 +52,12 @@ include = [
   "/src",
 ]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "OpenAI Agents v2"
+readme_sia = "Yes"
+readme_status = "Development"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]
diff --git a/instrumentation-genai/opentelemetry-instrumentation-openai-v2/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-openai-v2/pyproject.toml
@@ -53,5 +53,12 @@ include = [
   "/tests",
 ]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "OpenAI v2"
+readme_sia = "Yes"
+readme_status = "Stable"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]
diff --git a/instrumentation-genai/opentelemetry-instrumentation-vertexai/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-vertexai/pyproject.toml
@@ -48,5 +48,12 @@ path = "src/opentelemetry/instrumentation/vertexai/version.py"
 [tool.hatch.build.targets.sdist]
 include = ["/src", "/tests"]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "Vertex AI"
+readme_sia = "Yes"
+readme_status = "Beta"
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/opentelemetry"]
diff --git a/instrumentation-genai/opentelemetry-instrumentation-weaviate/pyproject.toml b/instrumentation-genai/opentelemetry-instrumentation-weaviate/pyproject.toml
@@ -36,6 +36,13 @@ instruments = [
   "weaviate-client >= 3.0",
 ]
 
+[tool.opentelemetry.instrumentation]
+independent_release = true
+include_in_bootstrap = false
+readme_library = "Weaviate"
+readme_sia = "Yes"
+readme_status = "Development"
+
 [project.urls]
 Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation-genai/opentelemetry-instrumentation-weaviate"
 Repository = "https://github.com/open-telemetry/opentelemetry-python-contrib"
diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py
@@ -16,14 +16,6 @@
 # RUN `python scripts/generate_instrumentation_bootstrap.py` TO REGENERATE.
 
 libraries = [
-    {
-        "library": "openai >= 1.26.0",
-        "instrumentation": "opentelemetry-instrumentation-openai-v2",
-    },
-    {
-        "library": "google-cloud-aiplatform >= 1.64",
-        "instrumentation": "opentelemetry-instrumentation-vertexai>=2.0b0",
-    },
     {
         "library": "aio_pika >= 7.2.0, < 10.0.0",
         "instrumentation": "opentelemetry-instrumentation-aio-pika==0.62b0.dev",
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,6 +4,8 @@ name = "opentelemetry-python-contrib"
 version = "0.0.0" # This is not used.
 requires-python = ">=3.9"
 dependencies = [
+  # When adding or removing instrumentation-genai packages, ensure their
+  # pyproject.toml metadata is correct for discover_genai_packages.py.
   "opentelemetry-api",
   "opentelemetry-sdk",
   "opentelemetry-semantic-conventions",
@@ -201,11 +203,7 @@ include = [
   "instrumentation/opentelemetry-instrumentation-aiokafka",
   "instrumentation/opentelemetry-instrumentation-asyncclick",
   "instrumentation/opentelemetry-instrumentation-threading",
-  "instrumentation-genai/opentelemetry-instrumentation-anthropic",
-  "instrumentation-genai/opentelemetry-instrumentation-claude-agent-sdk",
-  "instrumentation-genai/opentelemetry-instrumentation-vertexai",
-  "instrumentation-genai/opentelemetry-instrumentation-langchain",
-  "instrumentation-genai/opentelemetry-instrumentation-weaviate",
+  "instrumentation-genai/*/src",
   "util/opentelemetry-util-genai",
   "exporter/opentelemetry-exporter-credential-provider-gcp",
   "instrumentation/opentelemetry-instrumentation-aiohttp-client",
@@ -217,16 +215,8 @@ exclude = [
   "instrumentation/opentelemetry-instrumentation-aiokafka/tests/**/*.py",
   "instrumentation/opentelemetry-instrumentation-asyncclick/tests/**/*.py",
   "instrumentation/opentelemetry-instrumentation-threading/tests/**",
-  "instrumentation-genai/opentelemetry-instrumentation-anthropic/tests/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-anthropic/examples/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-claude-agent-sdk/tests/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-claude-agent-sdk/examples/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-vertexai/tests/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-langchain/tests/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-langchain/examples/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-weaviate/tests/**/*.py",
-  "instrumentation-genai/opentelemetry-instrumentation-weaviate/examples/**/*.py",
+  "instrumentation-genai/*/tests/**",
+  "instrumentation-genai/*/examples/**",
   "util/opentelemetry-util-genai/tests/**/*.py",
   "instrumentation/opentelemetry-instrumentation-aiohttp-client/tests/**/*.py",
   "opamp/opentelemetry-opamp-client/tests/**/*.py",
@@ -238,4 +228,6 @@ dev = [
     "tox",
     "tox-uv>=1",
     "pre-commit",
+    "tomli",
+    "astor",
 ]
diff --git a/scripts/discover_genai_packages.py b/scripts/discover_genai_packages.py
diff --git a/scripts/generate_instrumentation_bootstrap.py b/scripts/generate_instrumentation_bootstrap.py
diff --git a/scripts/generate_instrumentation_readme.py b/scripts/generate_instrumentation_readme.py
diff --git a/scripts/update_genai_readme.py b/scripts/update_genai_readme.py
diff --git a/tox.ini b/tox.ini
diff --git a/uv.lock b/uv.lock
