Merge branch 'master' into http

Author: alrex

Diff for: .github/pull_request_template.md

@@ -21,6 +21,8 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 
 # Checklist:
 
+See [contributing.md](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/master/CONTRIBUTING.md) for styleguide, changelog guidelines, and more.
+
 - [ ] Followed the style guidelines of this project
 - [ ] Changelogs have been updated
 - [ ] Unit tests have been added

Diff for: .github/workflows/test.yml

@@ -22,7 +22,7 @@ jobs:
       fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
       matrix:
         python-version: [ py35, py36, py37, py38, pypy3 ]
-        package: ["instrumentation", "exporter"]
+        package: ["instrumentation", "exporter", "sdkextension"]
         os: [ ubuntu-latest ]
         include:
           # py35-instrumentation segfaults on 18.04 so we instead run on 20.04

Diff for: CONTRIBUTING.md

@@ -104,12 +104,13 @@ A PR is considered to be **ready to merge** when:
   reasonable time to review.
 * Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
 * Urgent fix can take exception as long as it has been actively communicated.
+* A changelog entry is added to the corresponding changelog for the code base, if there is any impact on behavior. e.g. doc entries are not required, but small bug entries are.
 
 Any Approver / Maintainer can merge the PR once it is **ready to merge**.
 
 ## Design Choices
 
-As with other OpenTelemetry clients, opentelemetry-python follows the 
+As with other OpenTelemetry clients, opentelemetry-python follows the
 [opentelemetry-specification](https://github.com/open-telemetry/opentelemetry-specification).
 
 It's especially valuable to read through the [library guidelines](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/library-guidelines.md).
@@ -122,7 +123,7 @@ use cases are clear, but the method to satisfy those uses cases are not.
 As such, contributions should provide functionality and behavior that
 conforms to the specification, but the interface and structure is flexible.
 
-It is preferable to have contributions follow the idioms of the language 
+It is preferable to have contributions follow the idioms of the language
 rather than conform to specific API names or argument patterns in the spec.
 
 For a deeper discussion, see: https://github.com/open-telemetry/opentelemetry-specification/issues/165

Diff for: dev-requirements.txt

@@ -8,3 +8,7 @@ sphinx-rtd-theme~=0.4
 sphinx-autodoc-typehints~=1.10.2
 pytest!=5.2.3
 pytest-cov>=2.8
+readme-renderer~=24.0
+grpcio-tools==1.29.0
+mypy-protobuf>=1.23
+protobuf>=3.13.0

Diff for: instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/wrappers.py

@@ -23,9 +23,6 @@
 
     from opentelemetry import trace
     from opentelemetry.instrumentation.aiopg import trace_integration
-    from opentelemetry.trace import TracerProvider
-
-    trace.set_tracer_provider(TracerProvider())
 
     trace_integration(aiopg.connection, "_connect", "postgresql", "sql")
 

Diff for: instrumentation/opentelemetry-instrumentation-aiopg/tests/test_aiopg_integration.py

@@ -199,7 +199,11 @@ def test_span_succeeded(self):
             "user": "user",
         }
         db_integration = AiopgIntegration(
-            self.tracer, "testcomponent", "testtype", connection_attributes
+            self.tracer,
+            "testcomponent",
+            "testtype",
+            connection_attributes,
+            capture_parameters=True,
         )
         mock_connection = async_call(
             db_integration.wrapped_connection(

Diff for: instrumentation/opentelemetry-instrumentation-boto/src/opentelemetry/instrumentation/boto/__init__.py

@@ -26,15 +26,12 @@
 
 .. code:: python
 
-    from opentelemetry import trace
     from opentelemetry.instrumentation.boto import BotoInstrumentor
-    from opentelemetry.sdk.trace import TracerProvider
     import boto
 
-    trace.set_tracer_provider(TracerProvider())
 
     # Instrument Boto
-    BotoInstrumentor().instrument(tracer_provider=trace.get_tracer_provider())
+    BotoInstrumentor().instrument()
 
     # This will create a span with Boto-specific attributes
     ec2 = boto.ec2.connect_to_region("us-west-2")

Diff for: instrumentation/opentelemetry-instrumentation-botocore/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
 ## Unreleased
+- Add propagator injection for botocore calls
+  ([#181](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/181))
+- Make botocore instrumentation check if instrumentation has been suppressed
+  ([#182](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/182))
 
 ## Version 0.13b0
 

Diff for: instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py

@@ -27,17 +27,12 @@
 
 .. code:: python
 
-    from opentelemetry import trace
     from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
-    from opentelemetry.sdk.trace import TracerProvider
     import botocore
 
-    trace.set_tracer_provider(TracerProvider())
 
     # Instrument Botocore
-    BotocoreInstrumentor().instrument(
-        tracer_provider=trace.get_tracer_provider()
-    )
+    BotocoreInstrumentor().instrument()
 
     # This will create a span with Botocore-specific attributes
     session = botocore.session.get_session()
@@ -56,6 +51,8 @@
 from botocore.client import BaseClient
 from wrapt import ObjectProxy, wrap_function_wrapper
 
+from opentelemetry import context as context_api
+from opentelemetry import propagators
 from opentelemetry.instrumentation.botocore.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
 from opentelemetry.sdk.trace import Resource
@@ -64,6 +61,14 @@
 logger = logging.getLogger(__name__)
 
 
+# pylint: disable=unused-argument
+def _patched_endpoint_prepare_request(wrapped, instance, args, kwargs):
+    request = args[0]
+    headers = request.headers
+    propagators.inject(type(headers).__setitem__, headers)
+    return wrapped(*args, **kwargs)
+
+
 class BotocoreInstrumentor(BaseInstrumentor):
     """A instrumentor for Botocore
 
@@ -85,10 +90,18 @@ def _instrument(self, **kwargs):
             self._patched_api_call,
         )
 
+        wrap_function_wrapper(
+            "botocore.endpoint",
+            "Endpoint.prepare_request",
+            _patched_endpoint_prepare_request,
+        )
+
     def _uninstrument(self, **kwargs):
         unwrap(BaseClient, "_make_api_call")
 
     def _patched_api_call(self, original_func, instance, args, kwargs):
+        if context_api.get_value("suppress_instrumentation"):
+            return original_func(*args, **kwargs)
 
         endpoint_name = deep_getattr(instance, "_endpoint._endpoint_prefix")
 

Diff for: instrumentation/opentelemetry-instrumentation-botocore/tests/test_botocore_instrumentation.py

@@ -23,10 +23,14 @@
     mock_lambda,
     mock_s3,
     mock_sqs,
+    mock_xray,
 )
 
+from opentelemetry import propagators
+from opentelemetry.context import attach, detach, set_value
 from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
 from opentelemetry.sdk.resources import Resource
+from opentelemetry.test.mock_textmap import MockTextMapPropagator
 from opentelemetry.test.test_base import TestBase
 
 
@@ -275,3 +279,69 @@ def test_kms_client(self):
 
         # checking for protection on sts against security leak
         self.assertTrue("params" not in span.attributes.keys())
+
+    @mock_ec2
+    def test_propagator_injects_into_request(self):
+        headers = {}
+        previous_propagator = propagators.get_global_textmap()
+
+        def check_headers(**kwargs):
+            nonlocal headers
+            headers = kwargs["request"].headers
+
+        try:
+            propagators.set_global_textmap(MockTextMapPropagator())
+
+            ec2 = self.session.create_client("ec2", region_name="us-west-2")
+            ec2.meta.events.register_first(
+                "before-send.ec2.DescribeInstances", check_headers
+            )
+            ec2.describe_instances()
+
+            spans = self.memory_exporter.get_finished_spans()
+            assert spans
+            span = spans[0]
+            self.assertEqual(len(spans), 1)
+            self.assertEqual(span.attributes["aws.agent"], "botocore")
+            self.assertEqual(span.attributes["aws.region"], "us-west-2")
+            self.assertEqual(
+                span.attributes["aws.operation"], "DescribeInstances"
+            )
+            assert_span_http_status_code(span, 200)
+            self.assertEqual(
+                span.resource,
+                Resource(
+                    attributes={
+                        "endpoint": "ec2",
+                        "operation": "describeinstances",
+                    }
+                ),
+            )
+            self.assertEqual(span.name, "ec2.command")
+
+            self.assertIn(MockTextMapPropagator.TRACE_ID_KEY, headers)
+            self.assertEqual(
+                str(span.get_span_context().trace_id),
+                headers[MockTextMapPropagator.TRACE_ID_KEY],
+            )
+            self.assertIn(MockTextMapPropagator.SPAN_ID_KEY, headers)
+            self.assertEqual(
+                str(span.get_span_context().span_id),
+                headers[MockTextMapPropagator.SPAN_ID_KEY],
+            )
+
+        finally:
+            propagators.set_global_textmap(previous_propagator)
+
+    @mock_xray
+    def test_suppress_instrumentation_xray_client(self):
+        xray_client = self.session.create_client(
+            "xray", region_name="us-east-1"
+        )
+        token = attach(set_value("suppress_instrumentation", True))
+        xray_client.put_trace_segments(TraceSegmentDocuments=["str1"])
+        xray_client.put_trace_segments(TraceSegmentDocuments=["str2"])
+        detach(token)
+
+        spans = self.memory_exporter.get_finished_spans()
+        self.assertEqual(0, len(spans))

Diff for: instrumentation/opentelemetry-instrumentation-celery/src/opentelemetry/instrumentation/celery/__init__.py

@@ -30,19 +30,13 @@
 
 .. code:: python
 
-    from opentelemetry import trace
-    from opentelemetry.sdk.trace import TracerProvider
-    from opentelemetry.sdk.trace.export import BatchExportSpanProcessor
     from opentelemetry.instrumentation.celery import CeleryInstrumentor
 
     from celery import Celery
     from celery.signals import worker_process_init
 
     @worker_process_init.connect(weak=False)
     def init_celery_tracing(*args, **kwargs):
-        trace.set_tracer_provider(TracerProvider())
-        span_processor = BatchExportSpanProcessor(ConsoleSpanExporter())
-        trace.get_tracer_provider().add_span_processor(span_processor)
         CeleryInstrumentor().instrument()
 
     app = Celery("tasks", broker="amqp://localhost")

Diff for: instrumentation/opentelemetry-instrumentation-dbapi/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+Stop capturing query parameters by default
+  ([#156](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/156))
+
 ## Version 0.13b0
 
 Released 2020-09-17

Diff for: instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py

@@ -25,11 +25,8 @@
     import mysql.connector
     import pyodbc
 
-    from opentelemetry import trace
     from opentelemetry.instrumentation.dbapi import trace_integration
-    from opentelemetry.trace import TracerProvider
 
-    trace.set_tracer_provider(TracerProvider())
 
     # Ex: mysql.connector
     trace_integration(mysql.connector, "connect", "mysql", "sql")
@@ -62,6 +59,7 @@ def trace_integration(
     database_type: str = "",
     connection_attributes: typing.Dict = None,
     tracer_provider: typing.Optional[TracerProvider] = None,
+    capture_parameters: bool = False,
 ):
     """Integrate with DB API library.
         https://www.python.org/dev/peps/pep-0249/
@@ -76,6 +74,7 @@ def trace_integration(
                 user in Connection object.
             tracer_provider: The :class:`opentelemetry.trace.TracerProvider` to
                 use. If ommited the current configured one is used.
+            capture_parameters: Configure if db.statement.parameters should be captured.
     """
     wrap_connect(
         __name__,
@@ -86,6 +85,7 @@ def trace_integration(
         connection_attributes,
         version=__version__,
         tracer_provider=tracer_provider,
+        capture_parameters=capture_parameters,
     )
 
 
@@ -98,6 +98,7 @@ def wrap_connect(
     connection_attributes: typing.Dict = None,
     version: str = "",
     tracer_provider: typing.Optional[TracerProvider] = None,
+    capture_parameters: bool = False,
 ):
     """Integrate with DB API library.
         https://www.python.org/dev/peps/pep-0249/
@@ -111,6 +112,8 @@ def wrap_connect(
             database_type: The Database type. For any SQL database, "sql".
             connection_attributes: Attribute names for database, port, host and
                 user in Connection object.
+            capture_parameters: Configure if db.statement.parameters should be captured.
+
     """
 
     # pylint: disable=unused-argument
@@ -127,6 +130,7 @@ def wrap_connect_(
             connection_attributes=connection_attributes,
             version=version,
             tracer_provider=tracer_provider,
+            capture_parameters=capture_parameters,
         )
         return db_integration.wrapped_connection(wrapped, args, kwargs)
 
@@ -159,6 +163,7 @@ def instrument_connection(
     connection_attributes: typing.Dict = None,
     version: str = "",
     tracer_provider: typing.Optional[TracerProvider] = None,
+    capture_parameters=False,
 ):
     """Enable instrumentation in a database connection.
 
@@ -170,7 +175,7 @@ def instrument_connection(
         database_type: The Database type. For any SQL database, "sql".
         connection_attributes: Attribute names for database, port, host and
             user in a connection object.
-
+        capture_parameters: Configure if db.statement.parameters should be captured.
     Returns:
         An instrumented connection.
     """
@@ -181,6 +186,7 @@ def instrument_connection(
         connection_attributes=connection_attributes,
         version=version,
         tracer_provider=tracer_provider,
+        capture_parameters=capture_parameters,
     )
     db_integration.get_connection_attributes(connection)
     return get_traced_connection_proxy(connection, db_integration)
@@ -211,6 +217,7 @@ def __init__(
         connection_attributes=None,
         version: str = "",
         tracer_provider: typing.Optional[TracerProvider] = None,
+        capture_parameters: bool = False,
     ):
         self.connection_attributes = connection_attributes
         if self.connection_attributes is None:
@@ -223,6 +230,7 @@ def __init__(
         self._name = name
         self._version = version
         self._tracer_provider = tracer_provider
+        self.capture_parameters = capture_parameters
         self.database_component = database_component
         self.database_type = database_type
         self.connection_props = {}
@@ -327,7 +335,7 @@ def _populate_span(
         ) in self._db_api_integration.span_attributes.items():
             span.set_attribute(attribute_key, attribute_value)
 
-        if len(args) > 1:
+        if self._db_api_integration.capture_parameters and len(args) > 1:
             span.set_attribute("db.statement.parameters", str(args[1]))
 
     def traced_execution(