Merge branch 'open-telemetry:main' into google_genai_attribute_improvements

Author: michaelsafyan

CHANGELOG.md

@@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Fixed
+
+- `opentelemetry-instrumentation` Fix client address is set to server address in new semconv
+  ([#3354](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3354))
+
 ## Version 1.31.0/0.52b0 (2025-03-12)
 
 ### Added
@@ -36,7 +41,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Loosen `opentelemetry-instrumentation-starlette[instruments]` specifier
   ([#3304](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3304))
 
-
 ### Fixed
 
 - `opentelemetry-instrumentation-redis` Add missing entry in doc string for `def _instrument`
@@ -112,7 +116,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Breaking changes
 
 - `opentelemetry-exporter-prometheus-remote-write` updated protobuf required version from 4.21 to 5.26 and regenerated protobufs
- ([#3219](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3219))
+  ([#3219](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3219))
 - `opentelemetry-instrumentation-sqlalchemy` including sqlcomment in `db.statement` span attribute value is now opt-in
   ([#3112](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3112))
 - `opentelemetry-instrumentation-dbapi` including sqlcomment in `db.statement` span attribute value is now opt-in

instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py

@@ -52,7 +52,10 @@
 from opentelemetry.semconv.attributes.network_attributes import (
     NETWORK_PROTOCOL_VERSION,
 )
-from opentelemetry.semconv.attributes.server_attributes import SERVER_PORT
+from opentelemetry.semconv.attributes.server_attributes import (
+    SERVER_ADDRESS,
+    SERVER_PORT,
+)
 from opentelemetry.semconv.attributes.url_attributes import (
     URL_PATH,
     URL_QUERY,
@@ -401,6 +404,7 @@ def validate_outputs(
                 "attributes": {
                     HTTP_REQUEST_METHOD: "GET",
                     URL_SCHEME: "http",
+                    SERVER_ADDRESS: "127.0.0.1",
                     SERVER_PORT: 80,
                     NETWORK_PROTOCOL_VERSION: "1.0",
                     URL_PATH: "/",
@@ -436,6 +440,7 @@ def validate_outputs(
                 "attributes": {
                     HTTP_REQUEST_METHOD: "GET",
                     URL_SCHEME: "http",
+                    SERVER_ADDRESS: "127.0.0.1",
                     SERVER_PORT: 80,
                     NETWORK_PROTOCOL_VERSION: "1.0",
                     URL_PATH: "/",
@@ -706,7 +711,7 @@ async def test_behavior_with_scope_server_as_none_new_semconv(self):
         def update_expected_server(expected):
             expected[3]["attributes"].update(
                 {
-                    CLIENT_ADDRESS: "0.0.0.0",
+                    SERVER_ADDRESS: "0.0.0.0",
                     SERVER_PORT: 80,
                 }
             )
@@ -733,7 +738,7 @@ def update_expected_server(expected):
                     SpanAttributes.HTTP_HOST: "0.0.0.0",
                     SpanAttributes.NET_HOST_PORT: 80,
                     SpanAttributes.HTTP_URL: "http://0.0.0.0/",
-                    CLIENT_ADDRESS: "0.0.0.0",
+                    SERVER_ADDRESS: "0.0.0.0",
                     SERVER_PORT: 80,
                 }
             )
@@ -948,7 +953,7 @@ async def test_websocket(self):
                     SpanAttributes.HTTP_HOST: self.scope["server"][0],
                     SpanAttributes.HTTP_FLAVOR: self.scope["http_version"],
                     SpanAttributes.HTTP_TARGET: self.scope["path"],
-                    SpanAttributes.HTTP_URL: f'{self.scope["scheme"]}://{self.scope["server"][0]}{self.scope["path"]}',
+                    SpanAttributes.HTTP_URL: f"{self.scope['scheme']}://{self.scope['server'][0]}{self.scope['path']}",
                     SpanAttributes.NET_PEER_IP: self.scope["client"][0],
                     SpanAttributes.NET_PEER_PORT: self.scope["client"][1],
                     SpanAttributes.HTTP_STATUS_CODE: 200,
@@ -1018,6 +1023,7 @@ async def test_websocket_new_semconv(self):
                 "kind": trace_api.SpanKind.SERVER,
                 "attributes": {
                     URL_SCHEME: self.scope["scheme"],
+                    SERVER_ADDRESS: self.scope["server"][0],
                     SERVER_PORT: self.scope["server"][1],
                     NETWORK_PROTOCOL_VERSION: self.scope["http_version"],
                     URL_PATH: self.scope["path"],
@@ -1096,12 +1102,13 @@ async def test_websocket_both_semconv(self):
                     SpanAttributes.HTTP_HOST: self.scope["server"][0],
                     SpanAttributes.HTTP_FLAVOR: self.scope["http_version"],
                     SpanAttributes.HTTP_TARGET: self.scope["path"],
-                    SpanAttributes.HTTP_URL: f'{self.scope["scheme"]}://{self.scope["server"][0]}{self.scope["path"]}',
+                    SpanAttributes.HTTP_URL: f"{self.scope['scheme']}://{self.scope['server'][0]}{self.scope['path']}",
                     SpanAttributes.NET_PEER_IP: self.scope["client"][0],
                     SpanAttributes.NET_PEER_PORT: self.scope["client"][1],
                     SpanAttributes.HTTP_STATUS_CODE: 200,
                     SpanAttributes.HTTP_METHOD: self.scope["method"],
                     URL_SCHEME: self.scope["scheme"],
+                    SERVER_ADDRESS: self.scope["server"][0],
                     SERVER_PORT: self.scope["server"][1],
                     NETWORK_PROTOCOL_VERSION: self.scope["http_version"],
                     URL_PATH: self.scope["path"],
@@ -1661,6 +1668,7 @@ def test_request_attributes_new_semconv(self):
                 HTTP_REQUEST_METHOD: "GET",
                 URL_PATH: "/",
                 URL_QUERY: "foo=bar",
+                SERVER_ADDRESS: "127.0.0.1",
                 SERVER_PORT: 80,
                 URL_SCHEME: "http",
                 NETWORK_PROTOCOL_VERSION: "1.0",
@@ -1696,6 +1704,7 @@ def test_request_attributes_both_semconv(self):
                 HTTP_REQUEST_METHOD: "GET",
                 URL_PATH: "/",
                 URL_QUERY: "foo=bar",
+                SERVER_ADDRESS: "127.0.0.1",
                 SERVER_PORT: 80,
                 URL_SCHEME: "http",
                 NETWORK_PROTOCOL_VERSION: "1.0",

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

@@ -28,7 +28,7 @@
 .. code:: python
 
     from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
-    import botocore
+    import botocore.session
 
 
     # Instrument Botocore
@@ -39,7 +39,7 @@
     session.set_credentials(
         access_key="access-key", secret_key="secret-key"
     )
-    ec2 = self.session.create_client("ec2", region_name="us-west-2")
+    ec2 = session.create_client("ec2", region_name="us-west-2")
     ec2.describe_instances()
 
 API
@@ -58,13 +58,15 @@
 .. code: python
 
     from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
-    import botocore
+    import botocore.session
 
     def request_hook(span, service_name, operation_name, api_params):
         # request hook logic
+        pass
 
     def response_hook(span, service_name, operation_name, result):
         # response hook logic
+        pass
 
     # Instrument Botocore with hooks
     BotocoreInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
@@ -74,7 +76,7 @@ def response_hook(span, service_name, operation_name, result):
     session.set_credentials(
         access_key="access-key", secret_key="secret-key"
     )
-    ec2 = self.session.create_client("ec2", region_name="us-west-2")
+    ec2 = session.create_client("ec2", region_name="us-west-2")
     ec2.describe_instances()
 
 Extensions

instrumentation/opentelemetry-instrumentation-confluent-kafka/src/opentelemetry/instrumentation/confluent_kafka/__init__.py

@@ -34,6 +34,9 @@
     # report a span of type consumer with the default settings
     consumer = Consumer(conf2)
 
+    def msg_process(msg):
+        print(msg)
+
     def basic_consume_loop(consumer, topics):
         try:
             consumer.subscribe(topics)
@@ -44,7 +47,7 @@ def basic_consume_loop(consumer, topics):
                 if msg.error():
                     if msg.error().code() == KafkaError._PARTITION_EOF:
                         # End of partition event
-                        sys.stderr.write(f"{msg.topic() [{msg.partition()}] reached end at offset {msg.offset()}}")
+                        sys.stderr.write(f"{msg.topic()} [{msg.partition()}] reached end at offset {msg.offset()}")
                     elif msg.error():
                         raise KafkaException(msg.error())
                 else:
@@ -53,7 +56,7 @@ def basic_consume_loop(consumer, topics):
             # Close down consumer to commit final offsets.
             consumer.close()
 
-    basic_consume_loop(consumer, "my-topic")
+    basic_consume_loop(consumer, ["my-topic"])
 
 The _instrument method accepts the following keyword args:
   tracer_provider (TracerProvider) - an optional tracer provider
@@ -72,14 +75,16 @@ def instrument_consumer(consumer: Consumer, tracer_provider=None)
 .. code:: python
 
     from opentelemetry.instrumentation.confluent_kafka import ConfluentKafkaInstrumentor
+    from opentelemetry.trace import get_tracer_provider
 
     from confluent_kafka import Producer, Consumer
 
     inst = ConfluentKafkaInstrumentor()
+    tracer_provider = get_tracer_provider()
 
-    p = confluent_kafka.Producer({'bootstrap.servers': 'localhost:29092'})
-    c = confluent_kafka.Consumer({
-        'bootstrap.servers': 'localhost:29092',
+    p = Producer({'bootstrap.servers': 'localhost:9092'})
+    c = Consumer({
+        'bootstrap.servers': 'localhost:9092',
         'group.id': 'mygroup',
         'auto.offset.reset': 'earliest'
     })

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

@@ -32,15 +32,15 @@
 
     from opentelemetry.instrumentation.elasticsearch import ElasticsearchInstrumentor
     import elasticsearch
-
+    from datetime import datetime
 
     # instrument elasticsearch
     ElasticsearchInstrumentor().instrument()
 
     # Using elasticsearch as normal now will automatically generate spans
     es = elasticsearch.Elasticsearch()
-    es.index(index='my-index', doc_type='my-type', id=1, body={'my': 'data', 'timestamp': datetime.now()})
-    es.get(index='my-index', doc_type='my-type', id=1)
+    es.index(index='my-index', doc_type='_doc', id=1, body={'my': 'data', 'timestamp': datetime.now()})
+    es.get(index='my-index', doc_type='_doc', id=1)
 
 Elasticsearch instrumentation prefixes operation names with the string "Elasticsearch". This
 can be changed to a different string by either setting the OTEL_PYTHON_ELASTICSEARCH_NAME_PREFIX
@@ -49,6 +49,8 @@
 
 .. code-block:: python
 
+    from opentelemetry.instrumentation.elasticsearch import ElasticsearchInstrumentor
+
     ElasticsearchInstrumentor("my-custom-prefix").instrument()
 
 The instrument() method accepts the following keyword args:
@@ -67,6 +69,7 @@ def response_hook(span: Span, response: dict)
 
     from opentelemetry.instrumentation.elasticsearch import ElasticsearchInstrumentor
     import elasticsearch
+    from datetime import datetime
 
     def request_hook(span, method, url, kwargs):
         if span and span.is_recording():
@@ -82,8 +85,8 @@ def response_hook(span, response):
     # Using elasticsearch as normal now will automatically generate spans,
     # including user custom attributes added from the hooks
     es = elasticsearch.Elasticsearch()
-    es.index(index='my-index', doc_type='my-type', id=1, body={'my': 'data', 'timestamp': datetime.now()})
-    es.get(index='my-index', doc_type='my-type', id=1)
+    es.index(index='my-index', doc_type='_doc', id=1, body={'my': 'data', 'timestamp': datetime.now()})
+    es.get(index='my-index', doc_type='_doc', id=1)
 
 API
 ---

instrumentation/opentelemetry-instrumentation-falcon/README.rst

@@ -47,21 +47,41 @@ will extract path_info and content_type attributes from every traced request and
 
 Falcon Request object reference: https://falcon.readthedocs.io/en/stable/api/request_and_response.html#id1
 
+Usage
+-----
+
+.. code-block:: python
+
+    import falcon
+    from opentelemetry.instrumentation.falcon import FalconInstrumentor
+
+    FalconInstrumentor().instrument()
+
+    app = falcon.App()
+
+    class HelloWorldResource(object):
+        def on_get(self, req, resp):
+            resp.text = 'Hello World'
+
+    app.add_route('/hello', HelloWorldResource())
+
 
 Request/Response hooks
 **********************
 The instrumentation supports specifying request and response hooks. These are functions that get called back by the instrumentation right after a Span is created for a request
 and right before the span is finished while processing a response. The hooks can be configured as follows:
 
-::
+.. code-block:: python
+
+    from opentelemetry.instrumentation.falcon import FalconInstrumentor
 
     def request_hook(span, req):
         pass
 
     def response_hook(span, req, resp):
         pass
 
-    FalconInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
+    FalconInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
 
 References
 ----------

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

@@ -58,16 +58,16 @@
 
 .. code-block:: python
 
-    from falcon import API
+    import falcon
     from opentelemetry.instrumentation.falcon import FalconInstrumentor
 
     FalconInstrumentor().instrument()
 
-    app = falcon.API()
+    app = falcon.App()
 
     class HelloWorldResource(object):
         def on_get(self, req, resp):
-            resp.body = 'Hello World'
+            resp.text = 'Hello World'
 
     app.add_route('/hello', HelloWorldResource())
 
@@ -78,15 +78,17 @@ def on_get(self, req, resp):
 right after a span is created for a request and right before the span is finished for the response.
 The hooks can be configured as follows:
 
-::
+.. code-block:: python
+
+    from opentelemetry.instrumentation.falcon import FalconInstrumentor
 
     def request_hook(span, req):
         pass
 
     def response_hook(span, req, resp):
         pass
 
-    FalconInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
+    FalconInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
 
 Capture HTTP request and response headers
 *****************************************

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

@@ -64,6 +64,10 @@ async def foobar():
 
 .. code-block:: python
 
+    from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
+    from opentelemetry.trace import Span
+    from typing import Any
+
     def server_request_hook(span: Span, scope: dict[str, Any]):
         if span and span.is_recording():
             span.set_attribute("custom_user_attribute_from_request_hook", "some-value")
@@ -76,7 +80,7 @@ def client_response_hook(span: Span, scope: dict[str, Any], message: dict[str, A
         if span and span.is_recording():
             span.set_attribute("custom_user_attribute_from_response_hook", "some-value")
 
-   FastAPIInstrumentor().instrument(server_request_hook=server_request_hook, client_request_hook=client_request_hook, client_response_hook=client_response_hook)
+    FastAPIInstrumentor().instrument(server_request_hook=server_request_hook, client_request_hook=client_request_hook, client_response_hook=client_response_hook)
 
 Capture HTTP request and response headers
 *****************************************

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

@@ -133,6 +133,12 @@ def hello():
 
 .. code-block:: python
 
+    from opentelemetry.trace import Span
+    from wsgiref.types import WSGIEnvironment
+    from typing import List
+
+    from opentelemetry.instrumentation.flask import FlaskInstrumentor
+
     def request_hook(span: Span, environ: WSGIEnvironment):
         if span and span.is_recording():
             span.set_attribute("custom_user_attribute_from_request_hook", "some-value")