Merge branch 'main' into fix-flask-multithread-context-bug

open-telemetry · Feb 22, 2023 · efe9b8d · efe9b8d
2 parents 933a15c + 3bcc043
commit efe9b8d
Show file tree

Hide file tree

Showing 11 changed files with 81 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,13 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Add connection attributes to sqlalchemy connect span
+  ([#1608](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1608))
+
+### Fixed
+
+- Fix Flask instrumentation to only close the span if it was created by the same thread.
+  ([#1654](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1654))
+
 ## Version 1.16.0/0.37b0 (2023-02-17)
 
 ### Added
 
 - Support `aio_pika` 9.x (([#1670](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1670])
 - `opentelemetry-instrumentation-redis` Add `sanitize_query` config option to allow query sanitization.  ([#1572](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1572))
-- `opentelemetry-instrumentation-elasticsearch` Add optional db.statement query sanitization. 
+- `opentelemetry-instrumentation-elasticsearch` Add optional db.statement query sanitization.
   ([#1598](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1598))
 - `opentelemetry-instrumentation-celery` Record exceptions as events on the span.
   ([#1573](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1573))
@@ -32,8 +42,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Fix Flask instrumentation to only close the span if it was created by the same thread.
-  ([#1654](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1654))
 - Fix TortoiseORM instrumentation `AttributeError: type object 'Config' has no attribute 'title'`
   ([#1575](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1575))
 - Fix SQLAlchemy uninstrumentation

diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -24,6 +24,7 @@ aiopg>=0.13.0,<1.3.0
 asyncpg>=0.12.0
 boto~=2.0
 botocore~=1.0
+boto3~=1.0
 celery>=4.0
 confluent-kafka>= 1.8.2,< 2.0.0
 elasticsearch>=2.0,<9.0

diff --git a/docs/conf.py b/docs/conf.py
@@ -126,7 +126,7 @@ def getlistcfg(strval):
     ]
 
 
-ignore_categories = ["py-class", "py-func", "py-exc", "any"]
+ignore_categories = ["py-class", "py-func", "py-exc", "py-obj", "any"]
 
 for category in ignore_categories:
     if category in mcfg:

diff --git a/docs/instrumentation/boto3sqs/boto3sqs.rst b/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:
diff --git a/docs/nitpick-exceptions.ini b/docs/nitpick-exceptions.ini
@@ -13,6 +13,7 @@ py-class=
     opentelemetry.sdk.trace.id_generator.IdGenerator
     opentelemetry.instrumentation.confluent_kafka.ProxiedProducer
     opentelemetry.instrumentation.confluent_kafka.ProxiedConsumer
+    opentelemetry.instrumentation.instrumentor.BaseInstrumentor
     ; - AwsXRayIdGenerator
     TextMapPropagator
     CarrierT
@@ -54,7 +55,16 @@ any=
     ; - instrumentation.*
     Setter
     httpx
-;
+    instrument
+    __iter__
+    list.__iter__
+    __getitem__
+    list.__getitem__
+    SQS.ReceiveMessage
+
+py-obj=
+    opentelemetry.propagators.textmap.CarrierT
+
 py-func=
     poll
     flush

diff --git a/...telemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py b/...telemetry-instrumentation-boto3sqs/src/opentelemetry/instrumentation/boto3sqs/__init__.py
@@ -16,17 +16,17 @@
 
 .. _boto3sqs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html
 
-
 Usage
 -----
 
-.. code:: python
+.. code-block:: python
 
     import boto3
     from opentelemetry.instrumentation.boto3sqs import Boto3SQSInstrumentor
 
-
     Boto3SQSInstrumentor().instrument()
+
+---
 """
 import logging
 from typing import Any, Collection, Dict, Generator, List, Mapping, Optional

diff --git a/instrumentation/opentelemetry-instrumentation-elasticsearch/tests/test_elasticsearch.py b/instrumentation/opentelemetry-instrumentation-elasticsearch/tests/test_elasticsearch.py
@@ -463,6 +463,26 @@ def response_hook(span, response):
             spans[0].attributes[response_attribute_name],
         )
 
+    def test_no_op_tracer_provider(self, request_mock):
+        ElasticsearchInstrumentor().uninstrument()
+        ElasticsearchInstrumentor().instrument(
+            tracer_provider=trace.NoOpTracerProvider()
+        )
+        response_payload = '{"found": false, "timed_out": true, "took": 7}'
+        request_mock.return_value = (
+            1,
+            {},
+            response_payload,
+        )
+        es = Elasticsearch()
+        res = es.get(index="test-index", doc_type="_doc", id=1)
+        self.assertEqual(
+            res.get("found"), json.loads(response_payload).get("found")
+        )
+
+        spans_list = self.get_finished_spans()
+        self.assertEqual(len(spans_list), 0)
+
     def test_body_sanitization(self, _):
         self.assertEqual(
             sanitize_body(sanitization_queries.interval_query),

diff --git a/...lemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/engine.py b/...lemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/engine.py
@@ -91,7 +91,13 @@ def _wrap_connect(tracer_provider=None):
     def _wrap_connect_internal(func, module, args, kwargs):
         with tracer.start_as_current_span(
             "connect", kind=trace.SpanKind.CLIENT
-        ):
+        ) as span:
+            if span.is_recording():
+                attrs, _ = _get_attributes_from_url(module.url)
+                span.set_attributes(attrs)
+                span.set_attribute(
+                    SpanAttributes.DB_SYSTEM, _normalize_vendor(module.name)
+                )
             return func(*args, **kwargs)
 
     return _wrap_connect_internal

diff --git a/instrumentation/opentelemetry-instrumentation-sqlalchemy/tests/test_sqlalchemy.py b/instrumentation/opentelemetry-instrumentation-sqlalchemy/tests/test_sqlalchemy.py
@@ -22,6 +22,7 @@
 from opentelemetry.instrumentation.sqlalchemy import SQLAlchemyInstrumentor
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider, export
+from opentelemetry.semconv.trace import SpanAttributes
 from opentelemetry.test.test_base import TestBase
 
 
@@ -128,11 +129,12 @@ async def run():
     def test_not_recording(self):
         mock_tracer = mock.Mock()
         mock_span = mock.Mock()
+        mock_context = mock.Mock()
         mock_span.is_recording.return_value = False
-        mock_span.__enter__ = mock.Mock(return_value=(mock.Mock(), None))
-        mock_span.__exit__ = mock.Mock(return_value=None)
-        mock_tracer.start_span.return_value = mock_span
-        mock_tracer.start_as_current_span.return_value = mock_span
+        mock_context.__enter__ = mock.Mock(return_value=mock_span)
+        mock_context.__exit__ = mock.Mock(return_value=None)
+        mock_tracer.start_span.return_value = mock_context
+        mock_tracer.start_as_current_span.return_value = mock_context
         with mock.patch("opentelemetry.trace.get_tracer") as tracer:
             tracer.return_value = mock_tracer
             engine = create_engine("sqlite:///:memory:")
@@ -159,6 +161,12 @@ def test_create_engine_wrapper(self):
         self.assertEqual(len(spans), 2)
         # first span - the connection to the db
         self.assertEqual(spans[0].name, "connect")
+        self.assertEqual(
+            spans[0].attributes[SpanAttributes.DB_NAME], ":memory:"
+        )
+        self.assertEqual(
+            spans[0].attributes[SpanAttributes.DB_SYSTEM], "sqlite"
+        )
         self.assertEqual(spans[0].kind, trace.SpanKind.CLIENT)
         # second span - the query
         self.assertEqual(spans[1].name, "SELECT :memory:")
@@ -217,6 +225,12 @@ async def run():
             self.assertEqual(len(spans), 2)
             # first span - the connection to the db
             self.assertEqual(spans[0].name, "connect")
+            self.assertEqual(
+                spans[0].attributes[SpanAttributes.DB_NAME], ":memory:"
+            )
+            self.assertEqual(
+                spans[0].attributes[SpanAttributes.DB_SYSTEM], "sqlite"
+            )
             self.assertEqual(spans[0].kind, trace.SpanKind.CLIENT)
             # second span - the query
             self.assertEqual(spans[1].name, "SELECT :memory:")

diff --git a/tests/opentelemetry-docker-tests/tests/sqlalchemy_tests/test_mssql.py b/tests/opentelemetry-docker-tests/tests/sqlalchemy_tests/test_mssql.py
@@ -71,6 +71,7 @@ def test_engine_execute_errors(self):
         spans = self.memory_exporter.get_finished_spans()
         # one span for the connection and one for the query
         self.assertEqual(len(spans), 2)
+        self.check_meta(spans[0])
         span = spans[1]
         # span fields
         self.assertEqual(span.name, "SELECT opentelemetry-tests")
@@ -99,6 +100,7 @@ def test_orm_insert(self):
         spans = self.memory_exporter.get_finished_spans()
         # connect, identity insert on before the insert, insert, and identity insert off after the insert
         self.assertEqual(len(spans), 4)
+        self.check_meta(spans[0])
         span = spans[2]
         self._check_span(span, "INSERT")
         self.assertIn(

diff --git a/tests/opentelemetry-docker-tests/tests/sqlalchemy_tests/test_mysql.py b/tests/opentelemetry-docker-tests/tests/sqlalchemy_tests/test_mysql.py
@@ -70,6 +70,7 @@ def test_engine_execute_errors(self):
         spans = self.memory_exporter.get_finished_spans()
         # one span for the connection and one for the query
         self.assertEqual(len(spans), 2)
+        self.check_meta(spans[0])
         span = spans[1]
         # span fields
         self.assertEqual(span.name, "SELECT opentelemetry-tests")