Merge branch 'main' into google_genai_attribute_improvements

Author: michaelsafyan

.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

CHANGELOG.md

@@ -25,6 +25,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-dbapi`, `opentelemetry-instrumentation-django`,
   `opentelemetry-instrumentation-sqlalchemy`: Fix sqlcomment for non string query and composable object.
   ([#3113](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3113))
+- `opentelemetry-instrumentation-grpc` Fix error when using gprc versions <= 1.50.0 with unix sockets.
+  ([[#3393](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3393)])
 
 ## Version 1.31.0/0.52b0 (2025-03-12)
 

instrumentation-genai/README.md

@@ -0,0 +1,6 @@
+
+| Instrumentation | Supported Packages | Metrics support | Semconv status |
+| --------------- | ------------------ | --------------- | -------------- |
+| [opentelemetry-instrumentation-google-genai](./opentelemetry-instrumentation-google-genai) | google-genai >= 1.0.0 | 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

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/package.py

@@ -0,0 +1,15 @@
+# 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.
+
+_instruments = ("google-genai >= 1.0.0",)

instrumentation-genai/opentelemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/package.py

@@ -14,3 +14,5 @@
 
 
 _instruments = ("openai >= 1.26.0",)
+
+_supports_metrics = True

instrumentation/opentelemetry-instrumentation-botocore/README.rst

@@ -8,6 +8,44 @@ OpenTelemetry Botocore Tracing
 
 This library allows tracing requests made by the Botocore library.
 
+Extensions
+----------
+
+The instrumentation supports creating extensions for AWS services for enriching what is collected. We have extensions
+for the following AWS services:
+
+- Bedrock Runtime
+- DynamoDB
+- Lambda
+- SNS
+- SQS
+
+Bedrock Runtime
+***************
+
+This extension implements the GenAI semantic conventions for the following API calls:
+
+- Converse
+- ConverseStream
+- InvokeModel
+- InvokeModelWithResponseStream
+
+For the Converse and ConverseStream APIs tracing, events and metrics are implemented.
+
+For the InvokeModel and InvokeModelWithResponseStream APIs tracing, events and metrics implemented only for a subset of
+the available models, namely:
+
+- Amazon Titan models
+- Amazon Nova models
+- Anthropic Claude
+
+Tool calls with InvokeModel and InvokeModelWithResponseStream APIs are supported with:
+
+- Amazon Nova models
+- Anthropic Claude 3+
+
+If you don't have an application using Bedrock APIs yet, try our `zero-code examples <examples/bedrock-runtime/zero-code>`_.
+
 Installation
 ------------
 

instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py

@@ -78,40 +78,6 @@ def response_hook(span, service_name, operation_name, result):
     )
     ec2 = session.create_client("ec2", region_name="us-west-2")
     ec2.describe_instances()
-
-Extensions
-----------
-
-The instrumentation supports creating extensions for AWS services for enriching what is collected. We have extensions
-for the following AWS services:
-
-- Bedrock Runtime
-- DynamoDB
-- Lambda
-- SNS
-- SQS
-
-Bedrock Runtime
-***************
-
-This extension implements the GenAI semantic conventions for the following API calls:
-
-- Converse
-- ConverseStream
-- InvokeModel
-- InvokeModelWithResponseStream
-
-For the Converse and ConverseStream APIs tracing, events and metrics are implemented.
-
-For the InvokeModel and InvokeModelWithResponseStream APIs tracing, events and metrics implemented only for a subset of
-the available models, namely:
-- Amazon Titan models
-- Amazon Nova models
-- Anthropic Claude
-
-Tool calls with InvokeModel and InvokeModelWithResponseStream APIs are supported with:
-- Amazon Nova models
-- Anthropic Claude 3+
 """
 
 import logging

instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/_server.py

@@ -239,7 +239,7 @@ def _start_span(
         # * ipv4:127.0.0.1:57284
         # * ipv4:10.2.1.1:57284,127.0.0.1:57284
         #
-        if context.peer() != "unix:":
+        if not context.peer().startswith("unix:"):
             try:
                 ip, port = (
                     context.peer()

instrumentation/opentelemetry-instrumentation-httpx/README.rst

@@ -27,17 +27,22 @@ When using the instrumentor, all clients will automatically trace requests.
 
 .. code-block:: python
 
-     import httpx
-     from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
+    import httpx
+    import asyncio
+    from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
+
+    url = "https://example.com"
+    HTTPXClientInstrumentor().instrument()
+
+    with httpx.Client() as client:
+        response = client.get(url)
 
-     url = "https://some.url/get"
-     HTTPXClientInstrumentor().instrument()
+    async def get(url):
+        async with httpx.AsyncClient() as client:
+            response = await client.get(url)
 
-     with httpx.Client() as client:
-          response = client.get(url)
+    asyncio.run(get(url))
 
-     async with httpx.AsyncClient() as client:
-          response = await client.get(url)
 
 Instrumenting single clients
 ****************************
@@ -49,18 +54,21 @@ use the `instrument_client` method.
 .. code-block:: python
 
     import httpx
+    import asyncio
     from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
 
-    url = "https://some.url/get"
+    url = "https://example.com"
 
-    with httpx.Client(transport=telemetry_transport) as client:
+    with httpx.Client() as client:
         HTTPXClientInstrumentor.instrument_client(client)
         response = client.get(url)
 
-    async with httpx.AsyncClient(transport=telemetry_transport) as client:
-        HTTPXClientInstrumentor.instrument_client(client)
-        response = await client.get(url)
+    async def get(url):
+        async with httpx.AsyncClient() as client:
+            HTTPXClientInstrumentor.instrument_client(client)
+            response = await client.get(url)
 
+    asyncio.run(get(url))
 
 Uninstrument
 ************
@@ -91,12 +99,13 @@ If you don't want to use the instrumentor class, you can use the transport class
 .. code-block:: python
 
     import httpx
+    import asyncio
     from opentelemetry.instrumentation.httpx import (
         AsyncOpenTelemetryTransport,
         SyncOpenTelemetryTransport,
     )
 
-    url = "https://some.url/get"
+    url = "https://example.com"
     transport = httpx.HTTPTransport()
     telemetry_transport = SyncOpenTelemetryTransport(transport)
 
@@ -106,8 +115,11 @@ If you don't want to use the instrumentor class, you can use the transport class
     transport = httpx.AsyncHTTPTransport()
     telemetry_transport = AsyncOpenTelemetryTransport(transport)
 
-    async with httpx.AsyncClient(transport=telemetry_transport) as client:
-        response = await client.get(url)
+    async def get(url):
+        async with httpx.AsyncClient(transport=telemetry_transport) as client:
+            response = await client.get(url)
+
+    asyncio.run(get(url))
 
 
 Request and response hooks
@@ -158,6 +170,7 @@ Or if you are using the transport classes directly:
 
 .. code-block:: python
 
+    import httpx
     from opentelemetry.instrumentation.httpx import SyncOpenTelemetryTransport, AsyncOpenTelemetryTransport
 
     def request_hook(span, request):

instrumentation/opentelemetry-instrumentation-httpx/src/opentelemetry/instrumentation/httpx/__init__.py

@@ -23,17 +23,21 @@
 
 .. code-block:: python
 
-     import httpx
-     from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
+    import httpx
+    import asyncio
+    from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
 
-     url = "https://some.url/get"
-     HTTPXClientInstrumentor().instrument()
+    url = "https://example.com"
+    HTTPXClientInstrumentor().instrument()
 
-     with httpx.Client() as client:
-          response = client.get(url)
+    with httpx.Client() as client:
+        response = client.get(url)
 
-     async with httpx.AsyncClient() as client:
-          response = await client.get(url)
+    async def get(url):
+        async with httpx.AsyncClient() as client:
+            response = await client.get(url)
+
+    asyncio.run(get(url))
 
 Instrumenting single clients
 ****************************
@@ -45,18 +49,21 @@
 .. code-block:: python
 
     import httpx
+    import asyncio
     from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
 
-    url = "https://some.url/get"
+    url = "https://example.com"
 
-    with httpx.Client(transport=telemetry_transport) as client:
+    with httpx.Client() as client:
         HTTPXClientInstrumentor.instrument_client(client)
         response = client.get(url)
 
-    async with httpx.AsyncClient(transport=telemetry_transport) as client:
-        HTTPXClientInstrumentor.instrument_client(client)
-        response = await client.get(url)
+    async def get(url):
+        async with httpx.AsyncClient() as client:
+            HTTPXClientInstrumentor.instrument_client(client)
+            response = await client.get(url)
 
+    asyncio.run(get(url))
 
 Uninstrument
 ************
@@ -65,17 +72,17 @@
 
 .. code-block:: python
 
-     import httpx
-     from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
+    import httpx
+    from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
 
-     HTTPXClientInstrumentor().instrument()
-     client = httpx.Client()
+    HTTPXClientInstrumentor().instrument()
+    client = httpx.Client()
 
-     # Uninstrument a specific client
-     HTTPXClientInstrumentor.uninstrument_client(client)
+    # Uninstrument a specific client
+    HTTPXClientInstrumentor.uninstrument_client(client)
 
-     # Uninstrument all clients
-     HTTPXClientInstrumentor().uninstrument()
+    # Uninstrument all clients
+    HTTPXClientInstrumentor().uninstrument()
 
 
 Using transports directly
@@ -87,12 +94,13 @@
 .. code-block:: python
 
     import httpx
+    import asyncio
     from opentelemetry.instrumentation.httpx import (
         AsyncOpenTelemetryTransport,
         SyncOpenTelemetryTransport,
     )
 
-    url = "https://some.url/get"
+    url = "https://example.com"
     transport = httpx.HTTPTransport()
     telemetry_transport = SyncOpenTelemetryTransport(transport)
 
@@ -102,9 +110,11 @@
     transport = httpx.AsyncHTTPTransport()
     telemetry_transport = AsyncOpenTelemetryTransport(transport)
 
-    async with httpx.AsyncClient(transport=telemetry_transport) as client:
-        response = await client.get(url)
+    async def get(url):
+        async with httpx.AsyncClient(transport=telemetry_transport) as client:
+            response = await client.get(url)
 
+    asyncio.run(get(url))
 
 Request and response hooks
 ***************************
@@ -154,6 +164,7 @@ async def async_response_hook(span, request, response):
 
 .. code-block:: python
 
+    import httpx
     from opentelemetry.instrumentation.httpx import SyncOpenTelemetryTransport, AsyncOpenTelemetryTransport
 
     def request_hook(span, request):