Merge remote-tracking branch 'upstream/master' into tracer_provider_force_flush

Author: mariojonke

.flake8

@@ -18,3 +18,4 @@ exclude =
   ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/
   ext/opentelemetry-ext-jaeger/build/*
   docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/grpc/gen/
+  docs/examples/opentelemetry-example-app/build/*

.isort.cfg

@@ -15,4 +15,4 @@ multi_line_output=3
 skip=target
 skip_glob=**/gen/*,.venv*/*,venv*/*
 known_first_party=opentelemetry,opentelemetry_example_app
-known_third_party=psutil,pytest
+known_third_party=psutil,pytest,redis,redis_opentracing

.travis.yml

@@ -5,12 +5,12 @@ language: python
 cache: pip
 
 python:
+  - 'pypy3'
+  - '3.8'
   - '3.4'
   - '3.5'
   - '3.6'
   - '3.7'
-  - '3.8'
-  - 'pypy3'
 
 #matrix:
 #  allow_failures:

dev-requirements.txt

@@ -1,4 +1,4 @@
-pylint~=2.3
+pylint==2.4.4
 flake8~=3.7
 isort~=4.3
 black>=19.3b0,==19.*

docs/examples/basic_tracer/tests/test_tracer.py

@@ -25,6 +25,6 @@ def test_basic_tracer(self):
             (sys.executable, test_script)
         ).decode()
 
-        self.assertIn('name="foo"', output)
-        self.assertIn('name="bar"', output)
-        self.assertIn('name="baz"', output)
+        self.assertIn('"name": "foo"', output)
+        self.assertIn('"name": "bar"', output)
+        self.assertIn('"name": "baz"', output)

docs/examples/http/client.py

@@ -28,15 +28,18 @@
 
 # The preferred tracer implementation must be set, as the opentelemetry-api
 # defines the interface with a no-op implementation.
+# It must be done before instrumenting any library.
 trace.set_tracer_provider(TracerProvider())
-tracer_provider = trace.get_tracer_provider()
 
+# Enable instrumentation in the requests library.
+http_requests.RequestsInstrumentor().instrument()
+
+# Configure a console span exporter.
 exporter = ConsoleSpanExporter()
 span_processor = BatchExportSpanProcessor(exporter)
-tracer_provider.add_span_processor(span_processor)
+trace.get_tracer_provider().add_span_processor(span_processor)
 
 # Integrations are the glue that binds the OpenTelemetry API and the
 # frameworks and libraries that are used together, automatically creating
 # Spans and propagating context as appropriate.
-http_requests.enable(tracer_provider)
 response = requests.get(url="http://127.0.0.1:5000/")

docs/examples/http/server.py

@@ -30,20 +30,23 @@
 
 # The preferred tracer implementation must be set, as the opentelemetry-api
 # defines the interface with a no-op implementation.
+# It must be done before instrumenting any library.
 trace.set_tracer_provider(TracerProvider())
-tracer = trace.get_tracer(__name__)
-
-exporter = ConsoleSpanExporter()
-span_processor = BatchExportSpanProcessor(exporter)
-trace.get_tracer_provider().add_span_processor(span_processor)
 
 # Integrations are the glue that binds the OpenTelemetry API and the
 # frameworks and libraries that are used together, automatically creating
 # Spans and propagating context as appropriate.
-http_requests.enable(trace.get_tracer_provider())
+http_requests.RequestsInstrumentor().instrument()
 app = flask.Flask(__name__)
 app.wsgi_app = OpenTelemetryMiddleware(app.wsgi_app)
 
+# Configure a console span exporter.
+exporter = ConsoleSpanExporter()
+span_processor = BatchExportSpanProcessor(exporter)
+trace.get_tracer_provider().add_span_processor(span_processor)
+
+tracer = trace.get_tracer(__name__)
+
 
 @app.route("/")
 def hello():

docs/examples/http/tests/test_http.py

@@ -32,7 +32,7 @@ def test_http(self):
         output = subprocess.check_output(
             (sys.executable, test_script)
         ).decode()
-        self.assertIn('name="/"', output)
+        self.assertIn('"name": "/"', output)
 
     @classmethod
     def teardown_class(cls):

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/flask_example.py

@@ -28,14 +28,20 @@
     SimpleExportSpanProcessor,
 )
 
+# The preferred tracer implementation must be set, as the opentelemetry-api
+# defines the interface with a no-op implementation.
+# It must be done before instrumenting any library
 trace.set_tracer_provider(TracerProvider())
+
+opentelemetry.ext.http_requests.RequestsInstrumentor().instrument()
+FlaskInstrumentor().instrument()
+
 trace.get_tracer_provider().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())
 )
 
-FlaskInstrumentor().instrument()
+
 app = flask.Flask(__name__)
-opentelemetry.ext.http_requests.enable(trace.get_tracer_provider())
 
 
 @app.route("/")

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/grpc/hello_world_client.py

@@ -64,7 +64,6 @@
 trace.get_tracer_provider().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())
 )
-tracer = trace.get_tracer(__name__)
 
 
 def run():
@@ -73,7 +72,7 @@ def run():
     # of the code.
     with grpc.insecure_channel("localhost:50051") as channel:
 
-        channel = intercept_channel(channel, client_interceptor(tracer))
+        channel = intercept_channel(channel, client_interceptor())
 
         stub = helloworld_pb2_grpc.GreeterStub(channel)
 

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/grpc/hello_world_server.py

@@ -64,7 +64,6 @@
 trace.get_tracer_provider().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())
 )
-tracer = trace.get_tracer(__name__)
 
 
 class Greeter(helloworld_pb2_grpc.GreeterServicer):
@@ -75,7 +74,7 @@ def SayHello(self, request, context):
 def serve():
 
     server = grpc.server(futures.ThreadPoolExecutor())
-    server = intercept_server(server, server_interceptor(tracer))
+    server = intercept_server(server, server_interceptor())
 
     helloworld_pb2_grpc.add_GreeterServicer_to_server(Greeter(), server)
     server.add_insecure_port("[::]:50051")

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/grpc/route_guide_client.py

@@ -67,7 +67,6 @@
 trace.get_tracer_provider().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())
 )
-tracer = trace.get_tracer(__name__)
 
 
 def make_route_note(message, latitude, longitude):
@@ -154,7 +153,7 @@ def run():
     # used in circumstances in which the with statement does not fit the needs
     # of the code.
     with grpc.insecure_channel("localhost:50051") as channel:
-        channel = intercept_channel(channel, client_interceptor(tracer))
+        channel = intercept_channel(channel, client_interceptor())
 
         stub = route_guide_pb2_grpc.RouteGuideStub(channel)
 

docs/examples/opentelemetry-example-app/src/opentelemetry_example_app/grpc/route_guide_server.py

@@ -69,7 +69,6 @@
 trace.get_tracer_provider().add_span_processor(
     SimpleExportSpanProcessor(ConsoleSpanExporter())
 )
-tracer = trace.get_tracer(__name__)
 
 
 def get_feature(feature_db, point):
@@ -164,7 +163,7 @@ def RouteChat(self, request_iterator, context):
 
 def serve():
     server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
-    server = intercept_server(server, server_interceptor(tracer))
+    server = intercept_server(server, server_interceptor())
 
     route_guide_pb2_grpc.add_RouteGuideServicer_to_server(
         RouteGuideServicer(), server

docs/ext/pymysql/pymysql.rst

@@ -0,0 +1,7 @@
+OpenTelemetry PyMySQL Integration
+=================================
+
+.. automodule:: opentelemetry.ext.pymysql
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/ext/redis/redis.rst

@@ -0,0 +1,7 @@
+OpenTelemetry Redis Instrumentation
+===================================
+
+.. automodule:: opentelemetry.ext.redis
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/ext/sqlalchemy/sqlalchemy.rst

@@ -0,0 +1,7 @@
+OpenTelemetry SQLAlchemy Instrumentation
+========================================
+
+.. automodule:: opentelemetry.ext.sqlalchemy
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/getting-started.rst

@@ -202,7 +202,7 @@ And let's write a small Flask application that sends an HTTP request, activating
     )
 
     app = flask.Flask(__name__)
-    opentelemetry.ext.http_requests.enable(trace.get_tracer_provider())
+    opentelemetry.ext.http_requests.RequestsInstrumentor().instrument()
 
     @app.route("/")
     def hello():

eachdist.ini

@@ -6,6 +6,7 @@ sortfirst=
     opentelemetry-sdk
     opentelemetry-auto-instrumentation
     ext/opentelemetry-ext-wsgi
+    ext/opentelemetry-ext-dbapi
     ext/*
 
 [lintroots]

ext/opentelemetry-ext-dbapi/setup.cfg

@@ -19,7 +19,7 @@ long_description = file: README.rst
 long_description_content_type = text/x-rst
 author = OpenTelemetry Authors
 author_email = [email protected]
-url = https://github.com/open-telemetry/opentelemetry-python/ext/opentelemetry-ext-dbapi
+url = https://github.com/open-telemetry/opentelemetry-python/tree/master/ext/opentelemetry-ext-dbapi
 platforms = any
 license = Apache-2.0
 classifiers =
@@ -43,5 +43,9 @@ install_requires =
     opentelemetry-api == 0.7.dev0
     wrapt >= 1.0.0, < 2.0.0
 
+[options.extras_require]
+test =
+    opentelemetry-test == 0.7.dev0
+
 [options.packages.find]
 where = src

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

@@ -24,15 +24,16 @@
     import mysql.connector
     import pyodbc
 
+    from opentelemetry import trace
     from opentelemetry.ext.dbapi import trace_integration
     from opentelemetry.trace import TracerProvider
 
     trace.set_tracer_provider(TracerProvider())
-    tracer = trace.get_tracer(__name__)
+
     # Ex: mysql.connector
-    trace_integration(tracer, mysql.connector, "connect", "mysql", "sql")
+    trace_integration(mysql.connector, "connect", "mysql", "sql")
     # Ex: pyodbc
-    trace_integration(tracer, pyodbc, "Connection", "odbc", "sql")
+    trace_integration(pyodbc, "Connection", "odbc", "sql")
 
 API
 ---
@@ -44,13 +45,44 @@
 
 import wrapt
 
-from opentelemetry.trace import SpanKind, Tracer
+from opentelemetry.ext.dbapi.version import __version__
+from opentelemetry.trace import SpanKind, Tracer, TracerProvider, get_tracer
 from opentelemetry.trace.status import Status, StatusCanonicalCode
 
 logger = logging.getLogger(__name__)
 
 
 def trace_integration(
+    connect_module: typing.Callable[..., any],
+    connect_method_name: str,
+    database_component: str,
+    database_type: str = "",
+    connection_attributes: typing.Dict = None,
+    tracer_provider: typing.Optional[TracerProvider] = None,
+):
+    """Integrate with DB API library.
+        https://www.python.org/dev/peps/pep-0249/
+
+        Args:
+            connect_module: Module name where connect method is available.
+            connect_method_name: The connect method name.
+            database_component: Database driver name or database name "JDBI", "jdbc", "odbc", "postgreSQL".
+            database_type: The Database type. For any SQL database, "sql".
+            connection_attributes: Attribute names for database, port, host and user in Connection object.
+            tracer_provider: The :class:`TracerProvider` to use. If ommited the current configured one is used.
+    """
+    tracer = get_tracer(__name__, __version__, tracer_provider)
+    wrap_connect(
+        tracer,
+        connect_module,
+        connect_method_name,
+        database_component,
+        database_type,
+        connection_attributes,
+    )
+
+
+def wrap_connect(
     tracer: Tracer,
     connect_module: typing.Callable[..., any],
     connect_method_name: str,
@@ -71,7 +103,7 @@ def trace_integration(
     """
 
     # pylint: disable=unused-argument
-    def wrap_connect(
+    def wrap_connect_(
         wrapped: typing.Callable[..., any],
         instance: typing.Any,
         args: typing.Tuple[any, any],
@@ -87,12 +119,20 @@ def wrap_connect(
 
     try:
         wrapt.wrap_function_wrapper(
-            connect_module, connect_method_name, wrap_connect
+            connect_module, connect_method_name, wrap_connect_
         )
     except Exception as ex:  # pylint: disable=broad-except
         logger.warning("Failed to integrate with DB API. %s", str(ex))
 
 
+def unwrap_connect(
+    connect_module: typing.Callable[..., any], connect_method_name: str,
+):
+    conn = getattr(connect_module, connect_method_name, None)
+    if isinstance(conn, wrapt.ObjectProxy):
+        setattr(connect_module, connect_method_name, conn.__wrapped__)
+
+
 class DatabaseApiIntegration:
     def __init__(
         self,
@@ -146,10 +186,13 @@ def get_connection_attributes(self, connection):
         self.name = self.database_component
         self.database = self.connection_props.get("database", "")
         if self.database:
+            # PyMySQL encodes names with utf-8
+            if hasattr(self.database, "decode"):
+                self.database = self.database.decode(errors="ignore")
             self.name += "." + self.database
         user = self.connection_props.get("user")
         if user is not None:
-            self.span_attributes["db.user"] = user
+            self.span_attributes["db.user"] = str(user)
         host = self.connection_props.get("host")
         if host is not None:
             self.span_attributes["net.peer.name"] = host