Adding pymongo integration

ext/opentelemetry-ext-pymongo/README.rst

@@ -0,0 +1,27 @@
+OpenTelemetry pymongo integration
+=================================
+
+The integration with MongoDB supports the `pymongo`_ library and is specified
+to ``trace_integration`` using ``'pymongo'``.
+
+.. _pymongo: https://pypi.org/project/pymongo
+
+Usage
+-----
+
+.. code:: python
+
+    from pymongo import MongoClient
+    from opentelemetry.trace import tracer
+    from opentelemetry.trace.ext.pymongo import trace_integration
+
+    trace_integration(tracer())
+    client = MongoClient()
+    db = client["MongoDB_Database"]
+    collection = db["MongoDB_Collection"]
+    collection.find_one()
+
+References
+----------
+
+* `OpenTelemetry Project <https://opentelemetry.io/>`_

ext/opentelemetry-ext-pymongo/setup.cfg

@@ -0,0 +1,46 @@
+# Copyright 2019, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+[metadata]
+name = opentelemetry-ext-pymongo
+description = OpenTelemetry pymongo integration
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+author = OpenTelemetry Authors
+author_email = cncf-opentelemetry-contributors@lists.cncf.io
+url = https://github.com/open-telemetry/opentelemetry-python/ext/opentelemetry-ext-pymongo
+platforms = any
+license = Apache-2.0
+classifiers =
+    Development Status :: 3 - Alpha
+    Intended Audience :: Developers
+    License :: OSI Approved :: Apache Software License
+    Programming Language :: Python
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.4
+    Programming Language :: Python :: 3.5
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+
+[options]
+python_requires = >=3.4
+package_dir=
+    =src
+packages=find_namespace:
+install_requires =
+    opentelemetry-api >= 0.1.dev0
+    pymongo >= 3.1.0
+
+[options.packages.find]
+where = src

ext/opentelemetry-ext-pymongo/setup.py

@@ -0,0 +1,26 @@
+# Copyright 2019, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+
+import setuptools
+
+BASE_DIR = os.path.dirname(__file__)
+VERSION_FILENAME = os.path.join(
+    BASE_DIR, "src", "opentelemetry", "ext", "pymongo", "version.py"
+)
+PACKAGE_INFO = {}
+with open(VERSION_FILENAME) as f:
+    exec(f.read(), PACKAGE_INFO)
+
+setuptools.setup(version=PACKAGE_INFO["__version__"])

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

@@ -0,0 +1,78 @@
+# Copyright 2019, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+The opentelemetry-ext-pymongo package allows tracing commands made by the
+pymongo library.
+"""
+
+from pymongo import monitoring
+from opentelemetry.trace import SpanKind, Span
+from opentelemetry.trace.status import Status, StatusCanonicalCode
+
+DATA_BASE_TYPE = "mongodb"
+COMMAND_ATTRIBUTES = ["filter", "sort", "skip", "limit", "pipeline"]
+
+
+def trace_integration(tracer=None):
+    """Integrate with pymongo to trace it using event listener.
+       https://api.mongodb.com/python/current/api/pymongo/monitoring.html
+    """
+    monitoring.register(CommandTracer(tracer))
+
+
+class CommandTracer(monitoring.CommandListener):
+    def __init__(self, tracer):
+        self._tracer = tracer
+
+    def started(self, event: monitoring.CommandStartedEvent):
+        name = (
+            DATA_BASE_TYPE
+            + "."
+            + event.command_name
+            + "."
+            + event.command.get(event.command_name)
+        )
+        span = self._tracer.start_span(name, kind=SpanKind.CLIENT)
+        span.set_attribute("component", DATA_BASE_TYPE)
+        span.set_attribute("db.type", DATA_BASE_TYPE)
+        span.set_attribute("db.instance", event.database_name)
+        span.set_attribute(
+            "db.statement",
+            event.command_name + " " + event.command.get(event.command_name),
+        )
+        if event.connection_id is not None:
+            span.set_attribute("peer.address", str(event.connection_id))
+            span.set_attribute("peer.hostname", event.connection_id[0])
+            span.set_attribute("peer.port", event.connection_id[1])
+
+        span.set_attribute("operation_id", event.operation_id)
+        span.set_attribute("request_id", event.request_id)
+
+        for attr in COMMAND_ATTRIBUTES:
+            _attr = event.command.get(attr)
+            if _attr is not None:
+                span.set_attribute(attr, str(_attr))
+
+    def succeeded(self, event: monitoring.CommandSucceededEvent):
+        span = self._tracer.get_current_span()
+        span.set_attribute("duration_micros", event.duration_micros)
+        span.set_status(Status(StatusCanonicalCode.OK, event.reply))
+        span.end()
+
+    def failed(self, event: monitoring.CommandFailedEvent):
+        span = self._tracer.get_current_span()
+        span.set_attribute("duration_micros", event.duration_micros)
+        span.set_status(Status(StatusCanonicalCode.UNKNOWN, event.failure))
+        span.end()

ext/opentelemetry-ext-pymongo/src/opentelemetry/ext/pymongo/version.py

@@ -0,0 +1,15 @@
+# Copyright 2019, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = "0.1.dev0"

ext/opentelemetry-ext-pymongo/tests/test_pymongo_integration.py

@@ -0,0 +1,144 @@
+# Copyright 2019, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import unittest
+from unittest import mock
+
+from opentelemetry import trace as trace_api
+from opentelemetry.ext.pymongo import trace_integration, CommandTracer
+from opentelemetry.util import time_ns
+
+
+class TestPymongoIntegration(unittest.TestCase):
+    def test_trace_integration(self):
+        mock_register = mock.Mock()
+        patch = mock.patch(
+            "pymongo.monitoring.register", side_effect=mock_register
+        )
+        with patch:
+            trace_integration()
+
+        self.assertTrue(mock_register.called)
+
+    def test_started(self):
+        command_attrs = {
+            "filter": "filter",
+            "sort": "sort",
+            "limit": "limit",
+            "pipeline": "pipeline",
+            "command_name": "find",
+        }
+        mock_tracer = MockTracer()
+        CommandTracer(mock_tracer).started(
+            event=MockEvent(command_attrs, ("test.com", "1234"))
+        )
+        span = mock_tracer.get_current_span()
+        self.assertIs(span.kind, trace_api.SpanKind.CLIENT)
+        self.assertEqual(span.name, "mongodb.command_name.find")
+        self.assertEqual(span.attributes["component"], "mongodb")
+        self.assertEqual(span.attributes["db.type"], "mongodb")
+        self.assertEqual(span.attributes["db.instance"], "database_name")
+        self.assertEqual(span.attributes["db.statement"], "command_name find")
+        self.assertEqual(
+            span.attributes["peer.address"], "('test.com', '1234')"
+        )
+        self.assertEqual(span.attributes["peer.hostname"], "test.com")
+        self.assertEqual(span.attributes["peer.port"], "1234")
+        self.assertEqual(span.attributes["operation_id"], "operation_id")
+        self.assertEqual(span.attributes["request_id"], "request_id")
+
+        self.assertEqual(span.attributes["filter"], "filter")
+        self.assertEqual(span.attributes["sort"], "sort")
+        self.assertEqual(span.attributes["limit"], "limit")
+        self.assertEqual(span.attributes["pipeline"], "pipeline")
+
+    def test_succeeded(self):
+        mock_tracer = MockTracer()
+        CommandTracer(mock_tracer).succeeded(event=MockEvent(None))
+        span = mock_tracer.get_current_span()
+        self.assertEqual(span.attributes["duration_micros"], "duration_micros")
+        self.assertIs(
+            span.status.canonical_code, trace_api.status.StatusCanonicalCode.OK
+        )
+        self.assertEqual(span.status.description, "reply")
+        self.assertIsNotNone(span.end_time)
+
+    def test_failed(self):
+        mock_tracer = MockTracer()
+        CommandTracer(mock_tracer).failed(event=MockEvent(None))
+        span = mock_tracer.get_current_span()
+        self.assertEqual(span.attributes["duration_micros"], "duration_micros")
+        self.assertIs(
+            span.status.canonical_code,
+            trace_api.status.StatusCanonicalCode.UNKNOWN,
+        )
+        self.assertEqual(span.status.description, "failure")
+        self.assertIsNotNone(span.end_time)
+
+
+class MockCommand(object):
+    def __init__(self, command_attrs):
+        self.command_attrs = command_attrs
+
+    def get(self, key):
+        return self.command_attrs.get(key)
+
+
+class MockEvent(object):
+    def __init__(self, command_attrs, connection_id=""):
+        self.command = MockCommand(command_attrs)
+        self.connection_id = connection_id
+
+    def __getattr__(self, item):
+        return item
+
+
+class MockSpan(object):
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        return False
+
+    def __init__(self):
+        self.status = None
+        self.name = ""
+        self.kind = trace_api.SpanKind.INTERNAL
+        self.attributes = None
+        self.end_time = None
+
+    def set_attribute(self, key, value):
+        self.attributes[key] = value
+
+    def set_status(self, status):
+        self.status = status
+
+    def end(self, end_time=None):
+        self.end_time = end_time if end_time is not None else time_ns()
+
+
+class MockTracer(object):
+    def __init__(self):
+        self.span = MockSpan()
+        self.end_span = mock.Mock()
+        self.span.attributes = {}
+        self.span.status = None
+
+    def start_span(self, name, kind):
+        self.span.name = name
+        self.span.kind = kind
+        return self.span
+
+    def get_current_span(self):
+        return self.span

tox.ini

@@ -24,6 +24,7 @@ changedir =
   test-sdk: opentelemetry-sdk/tests
   test-ext-http-requests: ext/opentelemetry-ext-http-requests/tests
   test-ext-jaeger: ext/opentelemetry-ext-jaeger/tests
+  test-ext-pymongo: ext/opentelemetry-ext-pymongo/tests
   test-ext-wsgi: ext/opentelemetry-ext-wsgi/tests
   test-example-app: examples/opentelemetry-example-app/tests
 
@@ -38,6 +39,7 @@ commands_pre =
   example-app: pip install {toxinidir}/examples/opentelemetry-example-app
   ext: pip install {toxinidir}/opentelemetry-api
   wsgi: pip install {toxinidir}/ext/opentelemetry-ext-wsgi
+  pymongo: pip install {toxinidir}/ext/opentelemetry-ext-pymongo
   http-requests: pip install {toxinidir}/ext/opentelemetry-ext-http-requests
   jaeger: pip install {toxinidir}/opentelemetry-sdk
   jaeger: pip install {toxinidir}/ext/opentelemetry-ext-jaeger
@@ -72,6 +74,7 @@ commands_pre =
   pip install -e {toxinidir}/ext/opentelemetry-ext-azure-monitor
   pip install -e {toxinidir}/ext/opentelemetry-ext-http-requests
   pip install -e {toxinidir}/ext/opentelemetry-ext-jaeger
+  pip install -e {toxinidir}/ext/opentelemetry-ext-pymongo
   pip install -e {toxinidir}/ext/opentelemetry-ext-wsgi
   pip install -e {toxinidir}/examples/opentelemetry-example-app
 
@@ -90,6 +93,8 @@ commands =
          ext/opentelemetry-ext-http-requests/tests/ \
          ext/opentelemetry-ext-jaeger/src/opentelemetry \
          ext/opentelemetry-ext-jaeger/tests/ \
+         ext/opentelemetry-ext-pymongo/src/ \
+         ext/opentelemetry-ext-pymongo/tests/ \
          ext/opentelemetry-ext-wsgi/tests/ \
          examples/opentelemetry-example-app/src/opentelemetry_example_app/ \
          examples/opentelemetry-example-app/tests/