Merge branch 'main' into sqlalchemy-connect

Author: srikanthccv

.github/workflows/test.yml

@@ -102,10 +102,10 @@ jobs:
     steps:
       - name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
         uses: actions/checkout@v2
-      - name: Set up Python 3.9
+      - name: Set up Python 3.10
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: "3.10"
       - name: Install tox
         run: pip install tox==3.27.1
       - name: Install libsnappy-dev

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `opentelemetry-instrumentation-celery` Record exceptions as events on the span.
+  ([#1573](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1573))
 - Add metric instrumentation for urllib
   ([#1553](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1553))
 - `opentelemetry/sdk/extension/aws` Implement [`aws.ecs.*`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md) and [`aws.logs.*`](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/cloud_provider/aws/logs/) resource attributes in the `AwsEcsResourceDetector` detector when the ECS Metadata v4 is available
@@ -19,6 +21,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1613](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1613))
 - Fix aiohttp bug with unset `trace_configs`
   ([#1592](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1592))
+- Fix aiohttp bug with unset `trace_configs`
+  ([#1592](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1592))
+- `opentelemetry-instrumentation-django` Allow explicit `excluded_urls` configuration through `instrument()`
+  ([#1618](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1618))
 
 ### Fixed
 

README.md

@@ -95,15 +95,15 @@ Meeting notes are available as a public [Google doc](https://docs.google.com/doc
 Approvers ([@open-telemetry/python-approvers](https://github.com/orgs/open-telemetry/teams/python-approvers)):
 
 - [Aaron Abbott](https://github.com/aabmass), Google
-- [Nathaniel Ruiz Nowell](https://github.com/NathanielRN), AWS
-- [Owais Lone](https://github.com/owais), Splunk
 - [Sanket Mehta](https://github.com/sanketmehta28), Cisco
-- [Ashutosh Goel](https://github.com/ashu658), Cisco
+- [Shalev Roda](https://github.com/shalevr), Cisco
 
 Emeritus Approvers:
 
 - [Hector Hernandez](https://github.com/hectorhdzg), Microsoft
 - [Yusuke Tsutsumi](https://github.com/toumorokoshi), Google
+- [Nathaniel Ruiz Nowell](https://github.com/NathanielRN), AWS
+- [Ashutosh Goel](https://github.com/ashu658), Cisco
 
 *Find more about the approver role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver).*
 
@@ -116,6 +116,7 @@ Maintainers ([@open-telemetry/python-maintainers](https://github.com/orgs/open-t
 Emeritus Maintainers:
 
 - [Alex Boten](https://github.com/codeboten), Lightstep
+- [Owais Lone](https://github.com/owais), Splunk
 
 *Find more about the maintainer role in [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).*
 

exporter/opentelemetry-exporter-prometheus-remote-write/example/sampleapp.py

@@ -46,7 +46,7 @@
 
 # Callback to gather cpu usage
 def get_cpu_usage_callback(observer):
-    for (number, percent) in enumerate(psutil.cpu_percent(percpu=True)):
+    for number, percent in enumerate(psutil.cpu_percent(percpu=True)):
         labels = {"cpu_number": str(number)}
         yield Observation(percent, labels)
 

exporter/opentelemetry-exporter-prometheus-remote-write/src/opentelemetry/exporter/prometheus_remote_write/__init__.py

@@ -300,7 +300,6 @@ def _sanitize_string(string: str, type_: str) -> str:
         return sanitized
 
     def _parse_histogram_data_point(self, data_point, name):
-
         sample_attr_pairs = []
 
         base_attrs = list(data_point.attributes.items())
@@ -341,7 +340,6 @@ def handle_bucket(value, bound=None, name_override=None):
         return sample_attr_pairs
 
     def _parse_data_point(self, data_point, name=None):
-
         attrs = tuple(data_point.attributes.items()) + (
             ("__name__", self._sanitize_string(name, "name")),
         )

exporter/opentelemetry-exporter-prometheus-remote-write/src/opentelemetry/exporter/prometheus_remote_write/gen/remote_pb2.py

@@ -56,7 +56,6 @@ def test_regex_invalid(prom_rw):
 
 
 def test_parse_data_point(prom_rw):
-
     attrs = {"Foo": "Bar", "Baz": 42}
     timestamp = 1641946016139533244
     value = 242.42

exporter/opentelemetry-exporter-prometheus-remote-write/src/opentelemetry/exporter/prometheus_remote_write/gen/types_pb2.py

@@ -127,7 +127,6 @@ def get_traced_cursor_proxy(cursor, db_api_integration, *args, **kwargs):
 
     # pylint: disable=abstract-method
     class AsyncCursorTracerProxy(AsyncProxyObject):
-
         # pylint: disable=unused-argument
         def __init__(self, cursor, *args, **kwargs):
             super().__init__(cursor)

exporter/opentelemetry-exporter-prometheus-remote-write/tests/test_prometheus_remote_write_exporter.py

@@ -334,7 +334,8 @@ def collect_request_attributes(scope):
 
 def collect_custom_request_headers_attributes(scope):
     """returns custom HTTP request headers to be added into SERVER span as span attributes
-    Refer specification https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers"""
+    Refer specification https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers
+    """
 
     sanitize = SanitizeValue(
         get_custom_headers(
@@ -359,7 +360,8 @@ def collect_custom_request_headers_attributes(scope):
 
 def collect_custom_response_headers_attributes(message):
     """returns custom HTTP response headers to be added into SERVER span as span attributes
-    Refer specification https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers"""
+    Refer specification https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers
+    """
 
     sanitize = SanitizeValue(
         get_custom_headers(

instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/aiopg_integration.py

@@ -131,7 +131,6 @@ def _uninstrument(self, **__):
             unwrap(asyncpg.Connection, method)
 
     async def _do_execute(self, func, instance, args, kwargs):
-
         exception = None
         params = getattr(instance, "_params", {})
         name = args[0] if args[0] else params.get("database", "postgresql")

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

@@ -81,10 +81,7 @@ def custom_event_context_extractor(lambda_event):
 from opentelemetry.instrumentation.aws_lambda.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.instrumentation.utils import unwrap
-from opentelemetry.metrics import (
-    MeterProvider,
-    get_meter_provider,
-)
+from opentelemetry.metrics import MeterProvider, get_meter_provider
 from opentelemetry.propagate import get_global_textmap
 from opentelemetry.propagators.aws.aws_xray_propagator import (
     TRACE_HEADER_KEY,
@@ -282,7 +279,7 @@ def _instrument(
     disable_aws_context_propagation: bool = False,
     meter_provider: MeterProvider = None,
 ):
-    def _instrumented_lambda_handler_call(
+    def _instrumented_lambda_handler_call(  # noqa pylint: disable=too-many-branches
         call_wrapped, instance, args, kwargs
     ):
         orig_handler_name = ".".join(
@@ -366,23 +363,21 @@ def _instrumented_lambda_handler_call(
                 # NOTE: `force_flush` before function quit in case of Lambda freeze.
                 _tracer_provider.force_flush(flush_timeout)
             except Exception:  # pylint: disable=broad-except
-                logger.exception(
-                    f"TracerProvider failed to flush traces"
-                )
+                logger.exception("TracerProvider failed to flush traces")
         else:
-            logger.warning("TracerProvider was missing `force_flush` method. This is necessary in case of a Lambda freeze and would exist in the OTel SDK implementation.")
+            logger.warning(
+                "TracerProvider was missing `force_flush` method. This is necessary in case of a Lambda freeze and would exist in the OTel SDK implementation."
+            )
 
         _meter_provider = meter_provider or get_meter_provider()
         if hasattr(_meter_provider, "force_flush"):
-            rem = flush_timeout - (time.time()-now)*1000
+            rem = flush_timeout - (time.time() - now) * 1000
             if rem > 0:
                 try:
                     # NOTE: `force_flush` before function quit in case of Lambda freeze.
                     _meter_provider.force_flush(rem)
                 except Exception:  # pylint: disable=broad-except
-                    logger.exception(
-                        f"MeterProvider failed to flush metrics"
-                    )
+                    logger.exception("MeterProvider failed to flush metrics")
         else:
             logger.warning(
                 "MeterProvider was missing `force_flush` method. This is necessary in case of a Lambda freeze and would exist in the OTel SDK implementation."

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

@@ -302,7 +302,6 @@ def custom_event_context_extractor(lambda_event):
             test_env_patch.stop()
 
     def test_lambda_no_error_with_invalid_flush_timeout(self):
-
         test_env_patch = mock.patch.dict(
             "os.environ",
             {

instrumentation/opentelemetry-instrumentation-aws-lambda/src/opentelemetry/instrumentation/aws_lambda/__init__.py

@@ -119,7 +119,6 @@ def _common_request(  # pylint: disable=too-many-locals
         args,
         kwargs,
     ):
-
         endpoint_name = getattr(instance, "host").split(".")[0]
 
         with self._tracer.start_as_current_span(
@@ -166,7 +165,6 @@ def _common_request(  # pylint: disable=too-many-locals
             return result
 
     def _patched_query_request(self, original_func, instance, args, kwargs):
-
         return self._common_request(
             ("operation_name", "params", "path", "verb"),
             ["operation_name", "params", "path"],

instrumentation/opentelemetry-instrumentation-aws-lambda/tests/test_aws_lambda_instrumentation_manual.py

@@ -187,7 +187,6 @@ def test_s3_put(self):
 
     @mock_lambda_deprecated
     def test_unpatch(self):
-
         lamb = boto.awslambda.connect_to_region("us-east-2")
 
         BotoInstrumentor().uninstrument()

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

@@ -250,6 +250,7 @@ def _trace_failure(*args, **kwargs):
 
         if ex is not None:
             status_kwargs["description"] = str(ex)
+            span.record_exception(ex)
         span.set_status(Status(**status_kwargs))
 
     @staticmethod

instrumentation/opentelemetry-instrumentation-boto/tests/test_boto_instrumentation.py

@@ -120,7 +120,6 @@ def instrument_consumer(consumer: Consumer, tracer_provider=None)
 
 
 class AutoInstrumentedProducer(Producer):
-
     # This method is deliberately implemented in order to allow wrapt to wrap this function
     def produce(
         self, topic, value=None, *args, **kwargs

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

@@ -73,7 +73,6 @@ def _enrich_span(
     offset: Optional[int] = None,
     operation: Optional[MessagingOperationValues] = None,
 ):
-
     if not span.is_recording():
         return
 

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

@@ -471,7 +471,6 @@ def get_traced_cursor_proxy(cursor, db_api_integration, *args, **kwargs):
 
     # pylint: disable=abstract-method
     class TracedCursorProxy(wrapt.ObjectProxy):
-
         # pylint: disable=unused-argument
         def __init__(self, cursor, *args, **kwargs):
             wrapt.ObjectProxy.__init__(self, cursor)

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

@@ -236,7 +236,6 @@ def test_executemany(self):
         )
 
     def test_executemany_comment(self):
-
         connect_module = mock.MagicMock()
         connect_module.__version__ = mock.MagicMock()
         connect_module.__libpq_version__ = 123
@@ -262,7 +261,6 @@ def test_executemany_comment(self):
         )
 
     def test_executemany_flask_integration_comment(self):
-
         connect_module = mock.MagicMock()
         connect_module.__version__ = mock.MagicMock()
         connect_module.__libpq_version__ = 123

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

@@ -255,9 +255,11 @@ def response_hook(span, request, response):
 from opentelemetry.metrics import get_meter
 from opentelemetry.semconv.metrics import MetricInstruments
 from opentelemetry.trace import get_tracer
+from opentelemetry.util.http import get_excluded_urls, parse_excluded_urls
 
 DJANGO_2_0 = django_version >= (2, 0)
 
+_excluded_urls_from_env = get_excluded_urls("DJANGO")
 _logger = getLogger(__name__)
 
 
@@ -286,14 +288,14 @@ def instrumentation_dependencies(self) -> Collection[str]:
         return _instruments
 
     def _instrument(self, **kwargs):
-
         # FIXME this is probably a pattern that will show up in the rest of the
         # ext. Find a better way of implementing this.
         if environ.get(OTEL_PYTHON_DJANGO_INSTRUMENT) == "False":
             return
 
         tracer_provider = kwargs.get("tracer_provider")
         meter_provider = kwargs.get("meter_provider")
+        _excluded_urls = kwargs.get("excluded_urls")
         tracer = get_tracer(
             __name__,
             __version__,
@@ -302,6 +304,11 @@ def _instrument(self, **kwargs):
         meter = get_meter(__name__, __version__, meter_provider=meter_provider)
         _DjangoMiddleware._tracer = tracer
         _DjangoMiddleware._meter = meter
+        _DjangoMiddleware._excluded_urls = (
+            _excluded_urls_from_env
+            if _excluded_urls is None
+            else parse_excluded_urls(_excluded_urls)
+        )
         _DjangoMiddleware._otel_request_hook = kwargs.pop("request_hook", None)
         _DjangoMiddleware._otel_response_hook = kwargs.pop(
             "response_hook", None

instrumentation/opentelemetry-instrumentation-dbapi/tests/test_dbapi_integration.py

@@ -91,6 +91,7 @@
 _django_instrumentor = DjangoInstrumentor()
 
 
+# pylint: disable=too-many-public-methods
 class TestMiddleware(WsgiTestBase):
     @classmethod
     def setUpClass(cls):
@@ -285,6 +286,18 @@ def test_exclude_lists(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 1)
 
+    def test_exclude_lists_through_instrument(self):
+        _django_instrumentor.uninstrument()
+        _django_instrumentor.instrument(excluded_urls="excluded_explicit")
+        client = Client()
+        client.get("/excluded_explicit")
+        span_list = self.memory_exporter.get_finished_spans()
+        self.assertEqual(len(span_list), 0)
+
+        client.get("/excluded_arg/123")
+        span_list = self.memory_exporter.get_finished_spans()
+        self.assertEqual(len(span_list), 1)
+
     def test_span_name(self):
         # test no query_string
         Client().get("/span_name/1234/")

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

@@ -201,7 +201,6 @@ def wrapper(wrapped, _, args, kwargs):
             op_name,
             kind=SpanKind.CLIENT,
         ) as span:
-
             if callable(request_hook):
                 request_hook(span, method, url, kwargs)
 

instrumentation/opentelemetry-instrumentation-django/tests/test_middleware.py

@@ -323,7 +323,6 @@ def test_request_hook(self, request_mock):
         request_hook_kwargs_attribute = "request_hook.kwargs"
 
         def request_hook(span, method, url, kwargs):
-
             attributes = {
                 request_hook_method_attribute: method,
                 request_hook_url_attribute: url,

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

@@ -456,7 +456,6 @@ def _teardown_request(exc):
 
 
 class _InstrumentedFlask(flask.Flask):
-
     _excluded_urls = None
     _tracer_provider = None
     _request_hook = None

instrumentation/opentelemetry-instrumentation-elasticsearch/tests/test_elasticsearch.py

@@ -36,7 +36,6 @@ def tearDown(self):
             FlaskInstrumentor().uninstrument()
 
     def test_sqlcommenter_enabled_default(self):
-
         self.app = flask.Flask(__name__)
         self.app.route("/sqlcommenter")(self._sqlcommenter_endpoint)
         client = Client(self.app, Response)

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

@@ -221,7 +221,6 @@ def _set_remote_context(self, servicer_context):
     def _start_span(
         self, handler_call_details, context, set_status_on_exception=False
     ):
-
         # standard attributes
         attributes = {
             SpanAttributes.RPC_SYSTEM: "grpc",
@@ -283,7 +282,6 @@ def intercept_service(self, continuation, handler_call_details):
 
         def telemetry_wrapper(behavior, request_streaming, response_streaming):
             def telemetry_interceptor(request_or_iterator, context):
-
                 # handle streaming responses specially
                 if response_streaming:
                     return self._intercept_server_stream(
@@ -327,7 +325,6 @@ def telemetry_interceptor(request_or_iterator, context):
     def _intercept_server_stream(
         self, behavior, handler_call_details, request_or_iterator, context
     ):
-
         with self._set_remote_context(context):
             with self._start_span(
                 handler_call_details, context, set_status_on_exception=False