diff --git a/docs/ext/sqlalchemy/sqlalchemy.rst b/docs/ext/sqlalchemy/sqlalchemy.rst
new file mode 100644
index 0000000000..5a3afbb3bb
--- /dev/null
+++ b/docs/ext/sqlalchemy/sqlalchemy.rst
@@ -0,0 +1,7 @@
+OpenTelemetry SQLAlchemy Instrumentation
+========================================
+
+.. automodule:: opentelemetry.ext.sqlalchemy
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/__init__.py b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/__init__.py
new file mode 100644
index 0000000000..b0a6f42841
--- /dev/null
+++ b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/__init__.py
@@ -0,0 +1,13 @@
+# Copyright The 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.
diff --git a/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/mixins.py b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/mixins.py
new file mode 100644
index 0000000000..84c6fd05f9
--- /dev/null
+++ b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/mixins.py
@@ -0,0 +1,184 @@
+# Copyright The 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 contextlib
+
+from sqlalchemy import Column, Integer, String, create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+
+from opentelemetry import trace
+from opentelemetry.ext.sqlalchemy import SQLAlchemyInstrumentor
+from opentelemetry.ext.sqlalchemy.engine import _DB, _ROWS, _STMT
+from opentelemetry.test.test_base import TestBase
+
+Base = declarative_base()
+
+
+def _create_engine(engine_args):
+ # create a SQLAlchemy engine
+ config = dict(engine_args)
+ url = config.pop("url")
+ return create_engine(url, **config)
+
+
+class Player(Base):
+ """Player entity used to test SQLAlchemy ORM"""
+
+ __tablename__ = "players"
+
+ id = Column(Integer, primary_key=True)
+ name = Column(String(20))
+
+
+class SQLAlchemyTestMixin(TestBase):
+ __test__ = False
+
+ """SQLAlchemy test mixin that includes a complete set of tests
+ that must be executed for different engine. When a new test (or
+ a regression test) should be added to SQLAlchemy test suite, a new
+ entry must be appended here so that it will be executed for all
+ available and supported engines. If the test is specific to only
+ one engine, that test must be added to the specific `TestCase`
+ implementation.
+
+ To support a new engine, create a new `TestCase` that inherits from
+ `SQLAlchemyTestMixin` and `TestCase`. Then you must define the following
+ static class variables:
+ * VENDOR: the database vendor name
+ * SQL_DB: the `db.type` tag that we expect (it's the name of the database available in the `.env` file)
+ * SERVICE: the service that we expect by default
+ * ENGINE_ARGS: all arguments required to create the engine
+
+ To check specific tags in each test, you must implement the
+ `check_meta(self, span)` method.
+ """
+
+ VENDOR = None
+ SQL_DB = None
+ SERVICE = None
+ ENGINE_ARGS = None
+
+ @contextlib.contextmanager
+ def connection(self):
+ # context manager that provides a connection
+ # to the underlying database
+ try:
+ conn = self.engine.connect()
+ yield conn
+ finally:
+ conn.close()
+
+ def check_meta(self, span):
+ """function that can be implemented according to the
+ specific engine implementation
+ """
+
+ def setUp(self):
+ super().setUp()
+ # create an engine with the given arguments
+ self.engine = _create_engine(self.ENGINE_ARGS)
+
+ # create the database / entities and prepare a session for the test
+ Base.metadata.drop_all(bind=self.engine)
+ Base.metadata.create_all(self.engine, checkfirst=False)
+ self.session = sessionmaker(bind=self.engine)()
+ # trace the engine
+ SQLAlchemyInstrumentor().instrument(
+ engine=self.engine, tracer_provider=self.tracer_provider
+ )
+ self.memory_exporter.clear()
+
+ def tearDown(self):
+ # pylint: disable=invalid-name
+ # clear the database and dispose the engine
+ self.session.close()
+ Base.metadata.drop_all(bind=self.engine)
+ self.engine.dispose()
+ SQLAlchemyInstrumentor().uninstrument()
+ super().tearDown()
+
+ def _check_span(self, span):
+ self.assertEqual(span.name, "{}.query".format(self.VENDOR))
+ self.assertEqual(span.attributes.get("service"), self.SERVICE)
+ self.assertEqual(span.attributes.get(_DB), self.SQL_DB)
+ self.assertIs(
+ span.status.canonical_code, trace.status.StatusCanonicalCode.OK
+ )
+ self.assertGreater((span.end_time - span.start_time), 0)
+
+ def test_orm_insert(self):
+ # ensures that the ORM session is traced
+ wayne = Player(id=1, name="wayne")
+ self.session.add(wayne)
+ self.session.commit()
+
+ spans = self.memory_exporter.get_finished_spans()
+ self.assertEqual(len(spans), 1)
+ span = spans[0]
+ self._check_span(span)
+ self.assertIn("INSERT INTO players", span.attributes.get(_STMT))
+ self.assertEqual(span.attributes.get(_ROWS), 1)
+ self.check_meta(span)
+
+ def test_session_query(self):
+ # ensures that the Session queries are traced
+ out = list(self.session.query(Player).filter_by(name="wayne"))
+ self.assertEqual(len(out), 0)
+
+ spans = self.memory_exporter.get_finished_spans()
+ self.assertEqual(len(spans), 1)
+ span = spans[0]
+ self._check_span(span)
+ self.assertIn(
+ "SELECT players.id AS players_id, players.name AS players_name \nFROM players \nWHERE players.name",
+ span.attributes.get(_STMT),
+ )
+ self.check_meta(span)
+
+ def test_engine_connect_execute(self):
+ # ensures that engine.connect() is properly traced
+ with self.connection() as conn:
+ rows = conn.execute("SELECT * FROM players").fetchall()
+ self.assertEqual(len(rows), 0)
+
+ spans = self.memory_exporter.get_finished_spans()
+ self.assertEqual(len(spans), 1)
+ span = spans[0]
+ self._check_span(span)
+ self.assertEqual(span.attributes.get(_STMT), "SELECT * FROM players")
+ self.check_meta(span)
+
+ def test_parent(self):
+ """Ensure that sqlalchemy works with opentelemetry."""
+ tracer = self.tracer_provider.get_tracer("sqlalch_svc")
+
+ with tracer.start_as_current_span("sqlalch_op"):
+ with self.connection() as conn:
+ rows = conn.execute("SELECT * FROM players").fetchall()
+ self.assertEqual(len(rows), 0)
+
+ spans = self.memory_exporter.get_finished_spans()
+ self.assertEqual(len(spans), 2)
+ child_span, parent_span = spans
+
+ # confirm the parenting
+ self.assertIsNone(parent_span.parent)
+ self.assertIs(child_span.parent, parent_span.get_context())
+
+ self.assertEqual(parent_span.name, "sqlalch_op")
+ self.assertEqual(parent_span.instrumentation_info.name, "sqlalch_svc")
+
+ self.assertEqual(child_span.name, "{}.query".format(self.VENDOR))
+ self.assertEqual(child_span.attributes.get("service"), self.SERVICE)
diff --git a/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_instrument.py b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_instrument.py
new file mode 100644
index 0000000000..845bf26cfa
--- /dev/null
+++ b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_instrument.py
@@ -0,0 +1,72 @@
+# Copyright The 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 unittest
+
+import sqlalchemy
+
+from opentelemetry import trace
+from opentelemetry.ext.sqlalchemy import SQLAlchemyInstrumentor
+from opentelemetry.test.test_base import TestBase
+
+POSTGRES_CONFIG = {
+ "host": "127.0.0.1",
+ "port": int(os.getenv("TEST_POSTGRES_PORT", "5432")),
+ "user": os.getenv("TEST_POSTGRES_USER", "testuser"),
+ "password": os.getenv("TEST_POSTGRES_PASSWORD", "testpassword"),
+ "dbname": os.getenv("TEST_POSTGRES_DB", "opentelemetry-tests"),
+}
+
+
+class SQLAlchemyInstrumentTestCase(TestBase):
+ """TestCase that checks if the engine is properly traced
+ when the `instrument()` method is used.
+ """
+
+ def setUp(self):
+ # create a traced engine with the given arguments
+ SQLAlchemyInstrumentor().instrument()
+ dsn = (
+ "postgresql://%(user)s:%(password)s@%(host)s:%(port)s/%(dbname)s"
+ % POSTGRES_CONFIG
+ )
+ self.engine = sqlalchemy.create_engine(dsn)
+
+ # prepare a connection
+ self.conn = self.engine.connect()
+ super().setUp()
+
+ def tearDown(self):
+ # clear the database and dispose the engine
+ self.conn.close()
+ self.engine.dispose()
+ SQLAlchemyInstrumentor().uninstrument()
+
+ def test_engine_traced(self):
+ # ensures that the engine is traced
+ rows = self.conn.execute("SELECT 1").fetchall()
+ self.assertEqual(len(rows), 1)
+
+ traces = self.memory_exporter.get_finished_spans()
+ # trace composition
+ self.assertEqual(len(traces), 1)
+ span = traces[0]
+ # check subset of span fields
+ self.assertEqual(span.name, "postgres.query")
+ self.assertEqual(span.attributes.get("service"), "postgres")
+ self.assertIs(
+ span.status.canonical_code, trace.status.StatusCanonicalCode.OK
+ )
+ self.assertGreater((span.end_time - span.start_time), 0)
diff --git a/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_mysql.py b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_mysql.py
new file mode 100644
index 0000000000..3b8adc8c62
--- /dev/null
+++ b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_mysql.py
@@ -0,0 +1,77 @@
+# Copyright The 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 unittest
+
+import pytest
+from sqlalchemy.exc import ProgrammingError
+
+from opentelemetry import trace
+from opentelemetry.ext.sqlalchemy.engine import _DB, _HOST, _PORT, _ROWS, _STMT
+
+from .mixins import SQLAlchemyTestMixin
+
+MYSQL_CONFIG = {
+ "host": "127.0.0.1",
+ "port": int(os.getenv("TEST_MYSQL_PORT", "3306")),
+ "user": os.getenv("TEST_MYSQL_USER", "testuser"),
+ "password": os.getenv("TEST_MYSQL_PASSWORD", "testpassword"),
+ "database": os.getenv("TEST_MYSQL_DATABASE", "opentelemetry-tests"),
+}
+
+
+class MysqlConnectorTestCase(SQLAlchemyTestMixin):
+ """TestCase for mysql-connector engine"""
+
+ __test__ = True
+
+ VENDOR = "mysql"
+ SQL_DB = "opentelemetry-tests"
+ SERVICE = "mysql"
+ ENGINE_ARGS = {
+ "url": "mysql+mysqlconnector://%(user)s:%(password)s@%(host)s:%(port)s/%(database)s"
+ % MYSQL_CONFIG
+ }
+
+ def check_meta(self, span):
+ # check database connection tags
+ self.assertEqual(span.attributes.get(_HOST), MYSQL_CONFIG["host"])
+ self.assertEqual(span.attributes.get(_PORT), MYSQL_CONFIG["port"])
+
+ def test_engine_execute_errors(self):
+ # ensures that SQL errors are reported
+ with pytest.raises(ProgrammingError):
+ with self.connection() as conn:
+ conn.execute("SELECT * FROM a_wrong_table").fetchall()
+
+ spans = self.memory_exporter.get_finished_spans()
+ self.assertEqual(len(spans), 1)
+ span = spans[0]
+ # span fields
+ self.assertEqual(span.name, "{}.query".format(self.VENDOR))
+ self.assertEqual(span.attributes.get("service"), self.SERVICE)
+ self.assertEqual(
+ span.attributes.get(_STMT), "SELECT * FROM a_wrong_table"
+ )
+ self.assertEqual(span.attributes.get(_DB), self.SQL_DB)
+ self.assertIsNone(span.attributes.get(_ROWS))
+ self.check_meta(span)
+ self.assertTrue(span.end_time - span.start_time > 0)
+ # check the error
+ self.assertIs(
+ span.status.canonical_code,
+ trace.status.StatusCanonicalCode.UNKNOWN,
+ )
+ self.assertIn("a_wrong_table", span.status.description)
diff --git a/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_postgres.py b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_postgres.py
new file mode 100644
index 0000000000..125c925209
--- /dev/null
+++ b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_postgres.py
@@ -0,0 +1,92 @@
+# Copyright The 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 unittest
+
+import psycopg2
+import pytest
+from sqlalchemy.exc import ProgrammingError
+
+from opentelemetry import trace
+from opentelemetry.ext.sqlalchemy.engine import _DB, _HOST, _PORT, _ROWS, _STMT
+
+from .mixins import SQLAlchemyTestMixin
+
+POSTGRES_CONFIG = {
+ "host": "127.0.0.1",
+ "port": int(os.getenv("TEST_POSTGRES_PORT", "5432")),
+ "user": os.getenv("TEST_POSTGRES_USER", "testuser"),
+ "password": os.getenv("TEST_POSTGRES_PASSWORD", "testpassword"),
+ "dbname": os.getenv("TEST_POSTGRES_DB", "opentelemetry-tests"),
+}
+
+
+class PostgresTestCase(SQLAlchemyTestMixin):
+ """TestCase for Postgres Engine"""
+
+ __test__ = True
+
+ VENDOR = "postgres"
+ SQL_DB = "opentelemetry-tests"
+ SERVICE = "postgres"
+ ENGINE_ARGS = {
+ "url": "postgresql://%(user)s:%(password)s@%(host)s:%(port)s/%(dbname)s"
+ % POSTGRES_CONFIG
+ }
+
+ def check_meta(self, span):
+ # check database connection tags
+ self.assertEqual(span.attributes.get(_HOST), POSTGRES_CONFIG["host"])
+ self.assertEqual(span.attributes.get(_PORT), POSTGRES_CONFIG["port"])
+
+ def test_engine_execute_errors(self):
+ # ensures that SQL errors are reported
+ with pytest.raises(ProgrammingError):
+ with self.connection() as conn:
+ conn.execute("SELECT * FROM a_wrong_table").fetchall()
+
+ spans = self.memory_exporter.get_finished_spans()
+ self.assertEqual(len(spans), 1)
+ span = spans[0]
+ # span fields
+ self.assertEqual(span.name, "{}.query".format(self.VENDOR))
+ self.assertEqual(span.attributes.get("service"), self.SERVICE)
+ self.assertEqual(
+ span.attributes.get(_STMT), "SELECT * FROM a_wrong_table"
+ )
+ self.assertEqual(span.attributes.get(_DB), self.SQL_DB)
+ self.assertIsNone(span.attributes.get(_ROWS))
+ self.check_meta(span)
+ self.assertTrue(span.end_time - span.start_time > 0)
+ # check the error
+ self.assertIs(
+ span.status.canonical_code,
+ trace.status.StatusCanonicalCode.UNKNOWN,
+ )
+ self.assertIn("a_wrong_table", span.status.description)
+
+
+class PostgresCreatorTestCase(PostgresTestCase):
+ """TestCase for Postgres Engine that includes the same tests set
+ of `PostgresTestCase`, but it uses a specific `creator` function.
+ """
+
+ VENDOR = "postgres"
+ SQL_DB = "opentelemetry-tests"
+ SERVICE = "postgres"
+ ENGINE_ARGS = {
+ "url": "postgresql://",
+ "creator": lambda: psycopg2.connect(**POSTGRES_CONFIG),
+ }
diff --git a/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_sqlite.py b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_sqlite.py
new file mode 100644
index 0000000000..7d8a54368f
--- /dev/null
+++ b/ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_sqlite.py
@@ -0,0 +1,61 @@
+# Copyright The 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
+
+import pytest
+from sqlalchemy.exc import OperationalError
+
+from opentelemetry import trace
+from opentelemetry.ext.sqlalchemy.engine import _DB, _ROWS, _STMT
+
+from .mixins import SQLAlchemyTestMixin
+
+
+class SQLiteTestCase(SQLAlchemyTestMixin):
+ """TestCase for the SQLite engine"""
+
+ __test__ = True
+
+ VENDOR = "sqlite"
+ SQL_DB = ":memory:"
+ SERVICE = "sqlite"
+ ENGINE_ARGS = {"url": "sqlite:///:memory:"}
+
+ def test_engine_execute_errors(self):
+ # ensures that SQL errors are reported
+ with pytest.raises(OperationalError):
+ with self.connection() as conn:
+ conn.execute("SELECT * FROM a_wrong_table").fetchall()
+
+ spans = self.memory_exporter.get_finished_spans()
+ self.assertEqual(len(spans), 1)
+ span = spans[0]
+ # span fields
+ self.assertEqual(span.name, "{}.query".format(self.VENDOR))
+ self.assertEqual(span.attributes.get("service"), self.SERVICE)
+ self.assertEqual(
+ span.attributes.get(_STMT), "SELECT * FROM a_wrong_table"
+ )
+ self.assertEqual(span.attributes.get(_DB), self.SQL_DB)
+ self.assertIsNone(span.attributes.get(_ROWS))
+ self.assertTrue((span.end_time - span.start_time) > 0)
+ # check the error
+ self.assertIs(
+ span.status.canonical_code,
+ trace.status.StatusCanonicalCode.UNKNOWN,
+ )
+ self.assertEqual(
+ span.status.description, "no such table: a_wrong_table"
+ )
diff --git a/ext/opentelemetry-ext-sqlalchemy/CHANGELOG.md b/ext/opentelemetry-ext-sqlalchemy/CHANGELOG.md
new file mode 100644
index 0000000000..33144da913
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+- Initial release
\ No newline at end of file
diff --git a/ext/opentelemetry-ext-sqlalchemy/LICENSE b/ext/opentelemetry-ext-sqlalchemy/LICENSE
new file mode 100644
index 0000000000..261eeb9e9f
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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.
diff --git a/ext/opentelemetry-ext-sqlalchemy/MANIFEST.in b/ext/opentelemetry-ext-sqlalchemy/MANIFEST.in
new file mode 100644
index 0000000000..aed3e33273
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/MANIFEST.in
@@ -0,0 +1,9 @@
+graft src
+graft tests
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__/*
+include CHANGELOG.md
+include MANIFEST.in
+include README.rst
+include LICENSE
diff --git a/ext/opentelemetry-ext-sqlalchemy/README.rst b/ext/opentelemetry-ext-sqlalchemy/README.rst
new file mode 100644
index 0000000000..2485c96a58
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/README.rst
@@ -0,0 +1,24 @@
+OpenTelemetry SQLAlchemy Tracing
+================================
+
+|pypi|
+
+.. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-sqlalchemy.svg
+ :target: https://pypi.org/project/opentelemetry-ext-sqlalchemy/
+
+This library allows tracing requests made by the SQLAlchemy library.
+
+Installation
+------------
+
+::
+
+ pip install opentelemetry-ext-sqlalchemy
+
+
+References
+----------
+
+* `SQLAlchemy Project `_
+* `OpenTelemetry SQLAlchemy Tracing `_
+* `OpenTelemetry Project `_
\ No newline at end of file
diff --git a/ext/opentelemetry-ext-sqlalchemy/setup.cfg b/ext/opentelemetry-ext-sqlalchemy/setup.cfg
new file mode 100644
index 0000000000..a13cead988
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/setup.cfg
@@ -0,0 +1,58 @@
+# Copyright The 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-sqlalchemy
+description = SQLAlchemy tracing for OpenTelemetry
+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/tree/master/ext/opentelemetry-ext-sqlalchemy
+platforms = any
+license = Apache-2.0
+classifiers =
+ Development Status :: 4 - Beta
+ 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
+ Programming Language :: Python :: 3.8
+
+[options]
+python_requires = >=3.4
+package_dir=
+ =src
+packages=find_namespace:
+install_requires =
+ opentelemetry-api == 0.7.dev0
+ opentelemetry-auto-instrumentation == 0.7.dev0
+ wrapt >= 1.11.2
+ sqlalchemy
+
+[options.extras_require]
+test =
+ opentelemetry-sdk == 0.7.dev0
+ pytest
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+opentelemetry_instrumentor =
+ sqlalchemy = opentelemetry.ext.sqlalchemy:SQLAlchemyInstrumentor
diff --git a/ext/opentelemetry-ext-sqlalchemy/setup.py b/ext/opentelemetry-ext-sqlalchemy/setup.py
new file mode 100644
index 0000000000..d776a90e82
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/setup.py
@@ -0,0 +1,26 @@
+# Copyright The 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", "sqlalchemy", "version.py",
+)
+PACKAGE_INFO = {}
+with open(VERSION_FILENAME) as f:
+ exec(f.read(), PACKAGE_INFO)
+
+setuptools.setup(version=PACKAGE_INFO["__version__"])
diff --git a/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py
new file mode 100644
index 0000000000..19078fe0a5
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py
@@ -0,0 +1,99 @@
+# Copyright The 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.
+
+"""
+Instrument `sqlalchemy`_ to report SQL queries.
+
+There are two options for instrumenting code. The first option is to use
+the `opentelemetry-auto-instrumentation` executable which will automatically
+instrument your SQLAlchemy engine. The second is to programmatically enable
+instrumentation via the following code:
+
+.. _sqlalchemy: https://pypi.org/project/sqlalchemy/
+Usage
+-----
+.. code:: python
+
+ from sqlalchemy import create_engine
+
+ from opentelemetry import trace
+ from opentelemetry.ext.sqlalchemy import SQLAlchemyInstrumentor
+ from opentelemetry.sdk.trace import TracerProvider
+ import sqlalchemy
+
+ trace.set_tracer_provider(TracerProvider())
+ engine = create_engine("sqlite:///:memory:")
+ SQLAlchemyInstrumentor().instrument(
+ engine=engine,
+ service="service-A",
+ )
+
+API
+---
+"""
+import sqlalchemy
+import wrapt
+from wrapt import wrap_function_wrapper as _w
+
+from opentelemetry.auto_instrumentation.instrumentor import BaseInstrumentor
+from opentelemetry.ext.sqlalchemy.engine import (
+ EngineTracer,
+ _get_tracer,
+ _wrap_create_engine,
+)
+
+
+def _unwrap(obj, attr):
+ func = getattr(obj, attr, None)
+ if (
+ func
+ and isinstance(func, wrapt.ObjectProxy)
+ and hasattr(func, "__wrapped__")
+ ):
+ setattr(obj, attr, func.__wrapped__)
+
+
+class SQLAlchemyInstrumentor(BaseInstrumentor):
+ """An instrumentor for SQLAlchemy
+ See `BaseInstrumentor`
+ """
+
+ def _instrument(self, **kwargs):
+ """Instruments SQLAlchemy engine creation methods and the engine
+ if passed as an argument.
+
+ Args:
+ **kwargs: Optional arguments
+ ``engine``: a SQLAlchemy engine instance
+ ``tracer_provider``: a TracerProvider, defaults to global
+ ``service``: the name of the service to trace.
+
+ Returns:
+ An instrumented engine if passed in as an argument, None otherwise.
+ """
+ _w("sqlalchemy", "create_engine", _wrap_create_engine)
+ _w("sqlalchemy.engine", "create_engine", _wrap_create_engine)
+ if kwargs.get("engine") is not None:
+ return EngineTracer(
+ _get_tracer(
+ kwargs.get("engine"), kwargs.get("tracer_provider")
+ ),
+ kwargs.get("service"),
+ kwargs.get("engine"),
+ )
+ return None
+
+ def _uninstrument(self, **kwargs):
+ _unwrap(sqlalchemy, "create_engine")
+ _unwrap(sqlalchemy.engine, "create_engine")
diff --git a/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/engine.py b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/engine.py
new file mode 100644
index 0000000000..890bbc7c8d
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/engine.py
@@ -0,0 +1,142 @@
+# Copyright The 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.
+
+from sqlalchemy.event import listen
+
+from opentelemetry import trace
+from opentelemetry.ext.sqlalchemy.version import __version__
+from opentelemetry.trace.status import Status, StatusCanonicalCode
+
+# Network attribute semantic convention here:
+# https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/span-general.md#general-network-connection-attributes
+_HOST = "net.peer.name"
+_PORT = "net.peer.port"
+# Database semantic conventions here:
+# https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/database.md
+_ROWS = "sql.rows" # number of rows returned by a query
+_STMT = "db.statement"
+_DB = "db.type"
+_URL = "db.url"
+
+
+def _normalize_vendor(vendor):
+ """Return a canonical name for a type of database."""
+ if not vendor:
+ return "db" # should this ever happen?
+
+ if "sqlite" in vendor:
+ return "sqlite"
+
+ if "postgres" in vendor or vendor == "psycopg2":
+ return "postgres"
+
+ return vendor
+
+
+def _get_tracer(engine, tracer_provider=None):
+ if tracer_provider is None:
+ tracer_provider = trace.get_tracer_provider()
+ return tracer_provider.get_tracer(
+ _normalize_vendor(engine.name), __version__
+ )
+
+
+# pylint: disable=unused-argument
+def _wrap_create_engine(func, module, args, kwargs):
+ """Trace the SQLAlchemy engine, creating an `EngineTracer`
+ object that will listen to SQLAlchemy events.
+ """
+ engine = func(*args, **kwargs)
+ EngineTracer(_get_tracer(engine), None, engine)
+ return engine
+
+
+class EngineTracer:
+ def __init__(self, tracer, service, engine):
+ self.tracer = tracer
+ self.engine = engine
+ self.vendor = _normalize_vendor(engine.name)
+ self.service = service or self.vendor
+ self.name = "%s.query" % self.vendor
+ self.current_span = None
+
+ listen(engine, "before_cursor_execute", self._before_cur_exec)
+ listen(engine, "after_cursor_execute", self._after_cur_exec)
+ listen(engine, "handle_error", self._handle_error)
+
+ # pylint: disable=unused-argument
+ def _before_cur_exec(self, conn, cursor, statement, *args):
+ self.current_span = self.tracer.start_span(self.name)
+ with self.tracer.use_span(self.current_span, end_on_exit=False):
+ self.current_span.set_attribute("service", self.vendor)
+ self.current_span.set_attribute(_STMT, statement)
+
+ if not _set_attributes_from_url(
+ self.current_span, conn.engine.url
+ ):
+ _set_attributes_from_cursor(
+ self.current_span, self.vendor, cursor
+ )
+
+ # pylint: disable=unused-argument
+ def _after_cur_exec(self, conn, cursor, statement, *args):
+ if self.current_span is None:
+ return
+
+ try:
+ if cursor and cursor.rowcount >= 0:
+ self.current_span.set_attribute(_ROWS, cursor.rowcount)
+ finally:
+ self.current_span.end()
+
+ def _handle_error(self, context):
+ if self.current_span is None:
+ return
+
+ try:
+ self.current_span.set_status(
+ Status(
+ StatusCanonicalCode.UNKNOWN,
+ str(context.original_exception),
+ )
+ )
+ finally:
+ self.current_span.end()
+
+
+def _set_attributes_from_url(span: trace.Span, url):
+ """Set connection tags from the url. return true if successful."""
+ if url.host:
+ span.set_attribute(_HOST, url.host)
+ if url.port:
+ span.set_attribute(_PORT, url.port)
+ if url.database:
+ span.set_attribute(_DB, url.database)
+
+ return bool(url.host)
+
+
+def _set_attributes_from_cursor(span: trace.Span, vendor, cursor):
+ """Attempt to set db connection attributes by introspecting the cursor."""
+ if vendor == "postgres":
+ # pylint: disable=import-outside-toplevel
+ from psycopg2.extensions import parse_dsn
+
+ if hasattr(cursor, "connection") and hasattr(cursor.connection, "dsn"):
+ dsn = getattr(cursor.connection, "dsn", None)
+ if dsn:
+ data = parse_dsn(dsn)
+ span.set_attribute(_DB, data.get("dbname"))
+ span.set_attribute(_HOST, data.get("host"))
+ span.set_attribute(_PORT, int(data.get("port")))
diff --git a/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/version.py b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/version.py
new file mode 100644
index 0000000000..86c61362ab
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/version.py
@@ -0,0 +1,15 @@
+# Copyright The 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.7.dev0"
diff --git a/ext/opentelemetry-ext-sqlalchemy/tests/__init__.py b/ext/opentelemetry-ext-sqlalchemy/tests/__init__.py
new file mode 100644
index 0000000000..b0a6f42841
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/tests/__init__.py
@@ -0,0 +1,13 @@
+# Copyright The 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.
diff --git a/ext/opentelemetry-ext-sqlalchemy/tests/test_sqlalchemy.py b/ext/opentelemetry-ext-sqlalchemy/tests/test_sqlalchemy.py
new file mode 100644
index 0000000000..858cc652ef
--- /dev/null
+++ b/ext/opentelemetry-ext-sqlalchemy/tests/test_sqlalchemy.py
@@ -0,0 +1,50 @@
+# Copyright The 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.
+
+from sqlalchemy import create_engine
+
+from opentelemetry.ext.sqlalchemy import SQLAlchemyInstrumentor
+from opentelemetry.test.test_base import TestBase
+
+
+class TestSqlalchemyInstrumentation(TestBase):
+ def tearDown(self):
+ super().tearDown()
+ SQLAlchemyInstrumentor().uninstrument()
+
+ def test_trace_integration(self):
+ engine = create_engine("sqlite:///:memory:")
+ SQLAlchemyInstrumentor().instrument(
+ engine=engine,
+ tracer_provider=self.tracer_provider,
+ service="my-database",
+ )
+ cnx = engine.connect()
+ cnx.execute("SELECT 1 + 1;").fetchall()
+ spans = self.memory_exporter.get_finished_spans()
+
+ self.assertEqual(len(spans), 1)
+ self.assertEqual(spans[0].name, "sqlite.query")
+
+ def test_create_engine_wrapper(self):
+ SQLAlchemyInstrumentor().instrument()
+ from sqlalchemy import create_engine # pylint: disable-all
+
+ engine = create_engine("sqlite:///:memory:")
+ cnx = engine.connect()
+ cnx.execute("SELECT 1 + 1;").fetchall()
+ spans = self.memory_exporter.get_finished_spans()
+
+ self.assertEqual(len(spans), 1)
+ self.assertEqual(spans[0].name, "sqlite.query")
diff --git a/tox.ini b/tox.ini
index ef8b633403..118d0b0963 100644
--- a/tox.ini
+++ b/tox.ini
@@ -87,6 +87,10 @@ envlist =
; opentelemetry-ext-grpc
py3{4,5,6,7,8}-test-ext-grpc
+ ; opentelemetry-ext-sqlalchemy
+ py3{4,5,6,7,8}-test-ext-sqlalchemy
+ pypy3-test-ext-sqlalchemy
+
; opentelemetry-ext-redis
py3{4,5,6,7,8}-test-ext-redis
pypy3-test-ext-redis
@@ -136,6 +140,7 @@ changedir =
test-example-basic-tracer: docs/examples/basic_tracer/tests
test-example-http: docs/examples/http/tests
test-opentracing-shim: ext/opentelemetry-ext-opentracing-shim/tests
+ test-ext-sqlalchemy: ext/opentelemetry-ext-sqlalchemy/tests
test-ext-redis: ext/opentelemetry-ext-redis/tests
commands_pre =
@@ -198,6 +203,9 @@ commands_pre =
zipkin: pip install {toxinidir}/ext/opentelemetry-ext-zipkin
+ sqlalchemy: pip install {toxinidir}/opentelemetry-auto-instrumentation
+ sqlalchemy: pip install {toxinidir}/ext/opentelemetry-ext-sqlalchemy
+
; In order to get a healthy coverage report,
; we have to install packages in editable mode.
coverage: python {toxinidir}/scripts/eachdist.py install --editable
@@ -292,6 +300,7 @@ deps =
pymongo ~= 3.1
pymysql ~= 0.9.3
psycopg2-binary ~= 2.8.4
+ sqlalchemy ~= 1.3.16
redis ~= 3.3.11
changedir =
@@ -307,6 +316,7 @@ commands_pre =
-e {toxinidir}/ext/opentelemetry-ext-psycopg2 \
-e {toxinidir}/ext/opentelemetry-ext-pymongo \
-e {toxinidir}/ext/opentelemetry-ext-pymysql \
+ -e {toxinidir}/ext/opentelemetry-ext-sqlalchemy \
-e {toxinidir}/ext/opentelemetry-ext-redis
docker-compose up -d
python check_availability.py