From 88c851f37fcb69d81c7505fcfe4274ff150f78a9 Mon Sep 17 00:00:00 2001 From: Guillaume Pratte Date: Tue, 21 Jan 2025 16:08:55 -0500 Subject: [PATCH] Add pymssql instrumentation --- CHANGELOG.md | 2 + docs-requirements.txt | 1 + docs/instrumentation/pymssql/pymssql.rst | 7 + instrumentation/README.md | 1 + .../instrumentation/dbapi/__init__.py | 7 +- .../LICENSE | 201 ++++++++++++++++++ .../README.rst | 21 ++ .../pyproject.toml | 56 +++++ .../instrumentation/pymssql/__init__.py | 184 ++++++++++++++++ .../instrumentation/pymssql/package.py | 16 ++ .../instrumentation/pymssql/version.py | 15 ++ .../test-requirements.txt | 6 + .../tests/__init__.py | 0 .../tests/test_pymssql_integration.py | 125 +++++++++++ .../pyproject.toml | 1 + .../instrumentation/bootstrap_gen.py | 4 + tox.ini | 13 ++ 17 files changed, 659 insertions(+), 1 deletion(-) create mode 100644 docs/instrumentation/pymssql/pymssql.rst create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/LICENSE create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/README.rst create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/pyproject.toml create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/package.py create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/version.py create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/test-requirements.txt create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/tests/__init__.py create mode 100644 instrumentation/opentelemetry-instrumentation-pymssql/tests/test_pymssql_integration.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 39e3fcdba8..eff5069005 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,6 +41,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#3127](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3127)) - `opentelemetry-opentelemetry-botocore` Add basic support for GenAI attributes for AWS Bedrock Converse API ([#3161](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3161)) +- `opentelemetry-instrumentation-pymssql` Add pymssql instrumentation + ([#394](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/394)) ### Fixed diff --git a/docs-requirements.txt b/docs-requirements.txt index d547e806a3..0e36426fe3 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -35,6 +35,7 @@ psycopg~=3.1.17 pika>=0.12.0 pymongo~=4.6.3 PyMySQL~=1.1.1 +pymssql~=2.3.2 pyramid>=1.7 redis>=2.6 remoulade>=0.50 diff --git a/docs/instrumentation/pymssql/pymssql.rst b/docs/instrumentation/pymssql/pymssql.rst new file mode 100644 index 0000000000..0b1b589cb9 --- /dev/null +++ b/docs/instrumentation/pymssql/pymssql.rst @@ -0,0 +1,7 @@ +OpenTelemetry pymssql Instrumentation +===================================== + +.. automodule:: opentelemetry.instrumentation.pymssql + :members: + :undoc-members: + :show-inheritance: diff --git a/instrumentation/README.md b/instrumentation/README.md index 75341dad9a..400230ab51 100644 --- a/instrumentation/README.md +++ b/instrumentation/README.md @@ -35,6 +35,7 @@ | [opentelemetry-instrumentation-psycopg2](./opentelemetry-instrumentation-psycopg2) | psycopg2 >= 2.7.3.1 | No | experimental | [opentelemetry-instrumentation-pymemcache](./opentelemetry-instrumentation-pymemcache) | pymemcache >= 1.3.5, < 5 | No | experimental | [opentelemetry-instrumentation-pymongo](./opentelemetry-instrumentation-pymongo) | pymongo >= 3.1, < 5.0 | No | experimental +| [opentelemetry-instrumentation-pymssql](./opentelemetry-instrumentation-pymssql) | pymssql >= 2, < 3 | No | experimental | [opentelemetry-instrumentation-pymysql](./opentelemetry-instrumentation-pymysql) | PyMySQL < 2 | No | experimental | [opentelemetry-instrumentation-pyramid](./opentelemetry-instrumentation-pyramid) | pyramid >= 1.7 | Yes | experimental | [opentelemetry-instrumentation-redis](./opentelemetry-instrumentation-redis) | redis >= 2.6 | No | experimental diff --git a/instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py b/instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py index 27aafc7308..f42b95ac2c 100644 --- a/instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py +++ b/instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py @@ -204,6 +204,7 @@ def instrument_connection( commenter_options: dict[str, Any] | None = None, connect_module: Callable[..., Any] | None = None, enable_attribute_commenter: bool = False, + db_api_integration_factory: type[DatabaseApiIntegration] | None = None, ) -> TracedConnectionProxy[ConnectionT]: """Enable instrumentation in a database connection. @@ -228,7 +229,11 @@ def instrument_connection( _logger.warning("Connection already instrumented") return connection - db_integration = DatabaseApiIntegration( + db_api_integration_factory = ( + db_api_integration_factory or DatabaseApiIntegration + ) + + db_integration = db_api_integration_factory( name, database_system, connection_attributes=connection_attributes, diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/LICENSE b/instrumentation/opentelemetry-instrumentation-pymssql/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/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/instrumentation/opentelemetry-instrumentation-pymssql/README.rst b/instrumentation/opentelemetry-instrumentation-pymssql/README.rst new file mode 100644 index 0000000000..b885d6b5c5 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/README.rst @@ -0,0 +1,21 @@ +OpenTelemetry pymssql Instrumentation +===================================== + +|pypi| + +.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-pymssql.svg + :target: https://pypi.org/project/opentelemetry-instrumentation-pymssql/ + +Installation +------------ + +:: + + pip install opentelemetry-instrumentation-pymssql + + +References +---------- +* `OpenTelemetry pymssql Instrumentation `_ +* `OpenTelemetry Project `_ +* `OpenTelemetry Python Examples `_ diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/pyproject.toml b/instrumentation/opentelemetry-instrumentation-pymssql/pyproject.toml new file mode 100644 index 0000000000..045f09b21b --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/pyproject.toml @@ -0,0 +1,56 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "opentelemetry-instrumentation-pymssql" +dynamic = ["version"] +description = "OpenTelemetry pymssql instrumentation" +readme = "README.rst" +license = "Apache-2.0" +requires-python = ">=3.8" +authors = [ + { name = "OpenTelemetry Authors", email = "cncf-opentelemetry-contributors@lists.cncf.io" }, +] +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.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", +] +dependencies = [ + "opentelemetry-api ~= 1.12", + "opentelemetry-instrumentation == 0.51b0.dev", + "opentelemetry-instrumentation-dbapi == 0.51b0.dev", +] + +[project.optional-dependencies] +instruments = [ + "pymssql >= 2, < 3", +] + +[project.entry-points.opentelemetry_instrumentor] +pymssql = "opentelemetry.instrumentation.pymssql:pymssqlInstrumentor" + +[project.urls] +Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-pymssql" +Repository = "https://github.com/open-telemetry/opentelemetry-python-contrib" + +[tool.hatch.version] +path = "src/opentelemetry/instrumentation/pymssql/version.py" + +[tool.hatch.build.targets.sdist] +include = [ + "/src", + "/tests", +] + +[tool.hatch.build.targets.wheel] +packages = ["src/opentelemetry"] diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py b/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py new file mode 100644 index 0000000000..c914dab45d --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.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. + +""" +The integration with pymssql supports the `pymssql`_ library and can be enabled +by using ``PyMSSQLInstrumentor``. + +.. _pymssql: https://pypi.org/project/pymssql/ + +Usage +----- + +.. code:: python + + import pymssql + from opentelemetry.instrumentation.pymssql import PyMSSQLInstrumentor + + PyMSSQLInstrumentor().instrument() + + cnx = pymssql.connect(database="MSSQL_Database") + cursor = cnx.cursor() + cursor.execute("INSERT INTO test (testField) VALUES (123)" + cnx.commit() + cursor.close() + cnx.close() + +API +--- +The `instrument` method accepts the following keyword args: + +tracer_provider (TracerProvider) - an optional tracer provider +""" + +from __future__ import annotations + +from typing import Any, Callable, Collection, NamedTuple + +import pymssql + +from opentelemetry.instrumentation import dbapi +from opentelemetry.instrumentation.instrumentor import BaseInstrumentor +from opentelemetry.instrumentation.pymssql.package import _instruments +from opentelemetry.instrumentation.pymssql.version import __version__ + +_DATABASE_SYSTEM = "mssql" + + +class _PyMSSQLConnectMethodArgsTuple(NamedTuple): + server: str | None = None + user: str | None = None + password: str | None = None + database: str | None = None + timeout: int | None = None + login_timeout: int | None = None + charset: str | None = None + as_dict: bool | None = None + host: str | None = None + appname: str | None = None + port: str | None = None + conn_properties: str | None = None + autocommit: bool | None = None + tds_version: str | None = None + + +class _PyMSSQLDatabaseApiIntegration(dbapi.DatabaseApiIntegration): + def wrapped_connection( + self, + connect_method: Callable[..., Any], + args: tuple[Any, Any], + kwargs: dict[Any, Any], + ): + """Add object proxy to connection object.""" + connection = connect_method(*args, **kwargs) + connect_method_args = _PyMSSQLConnectMethodArgsTuple(*args) + + self.name = self.database_system + self.database = kwargs.get("database") or connect_method_args.database + + user = kwargs.get("user") or connect_method_args.user + if user is not None: + self.span_attributes["db.user"] = user + + port = kwargs.get("port") or connect_method_args.port + host = kwargs.get("server") or connect_method_args.server + if host is None: + host = kwargs.get("host") or connect_method_args.host + if host is not None: + # The host string can include the port, separated by either a coma or + # a column + for sep in (":", ","): + if sep in host: + tokens = host.rsplit(sep) + host = tokens[0] + if len(tokens) > 1: + port = tokens[1] + if host is not None: + self.span_attributes["net.peer.name"] = host + if port is not None: + self.span_attributes["net.peer.port"] = port + + charset = kwargs.get("charset") or connect_method_args.charset + if charset is not None: + self.span_attributes["db.charset"] = charset + + tds_version = ( + kwargs.get("tds_version") or connect_method_args.tds_version + ) + if tds_version is not None: + self.span_attributes["db.protocol.tds.version"] = tds_version + + return dbapi.get_traced_connection_proxy(connection, self) + + +class PyMSSQLInstrumentor(BaseInstrumentor): + def instrumentation_dependencies(self) -> Collection[str]: + return _instruments + + def _instrument(self, **kwargs): + """Integrate with the pymssql library. + https://github.com/pymssql/pymssql/ + """ + tracer_provider = kwargs.get("tracer_provider") + + dbapi.wrap_connect( + __name__, + pymssql, + "connect", + _DATABASE_SYSTEM, + version=__version__, + tracer_provider=tracer_provider, + # pymssql does not keep the connection attributes in its connection object; + # instead, we get the attributes from the connect method (which is done + # via PyMSSQLDatabaseApiIntegration.wrapped_connection) + db_api_integration_factory=_PyMSSQLDatabaseApiIntegration, + ) + + def _uninstrument(self, **kwargs): + """ "Disable pymssql instrumentation""" + dbapi.unwrap_connect(pymssql, "connect") + + @staticmethod + def instrument_connection(connection, tracer_provider=None): + """Enable instrumentation in a pymssql connection. + + Args: + connection: The connection to instrument. + tracer_provider: The optional tracer provider to use. If omitted + the current globally configured one is used. + + Returns: + An instrumented connection. + """ + + return dbapi.instrument_connection( + __name__, + connection, + _DATABASE_SYSTEM, + version=__version__, + tracer_provider=tracer_provider, + db_api_integration_factory=_PyMSSQLDatabaseApiIntegration, + ) + + @staticmethod + def uninstrument_connection(connection): + """Disable instrumentation in a pymssql connection. + + Args: + connection: The connection to uninstrument. + + Returns: + An uninstrumented connection. + """ + return dbapi.uninstrument_connection(connection) diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/package.py b/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/package.py new file mode 100644 index 0000000000..bafbc62625 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/package.py @@ -0,0 +1,16 @@ +# 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. + + +_instruments = ("pymssql >= 2, < 3",) diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/version.py b/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/version.py new file mode 100644 index 0000000000..6e2923f0db --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/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.51b0.dev" diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/test-requirements.txt b/instrumentation/opentelemetry-instrumentation-pymssql/test-requirements.txt new file mode 100644 index 0000000000..d0c2ecfd94 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/test-requirements.txt @@ -0,0 +1,6 @@ +pymssql==2.3.2 +pytest==7.4.4 +typing_extensions==4.12.2 +-e opentelemetry-instrumentation +-e instrumentation/opentelemetry-instrumentation-dbapi +-e instrumentation/opentelemetry-instrumentation-pymssql diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/tests/__init__.py b/instrumentation/opentelemetry-instrumentation-pymssql/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/instrumentation/opentelemetry-instrumentation-pymssql/tests/test_pymssql_integration.py b/instrumentation/opentelemetry-instrumentation-pymssql/tests/test_pymssql_integration.py new file mode 100644 index 0000000000..fa25e6d9d6 --- /dev/null +++ b/instrumentation/opentelemetry-instrumentation-pymssql/tests/test_pymssql_integration.py @@ -0,0 +1,125 @@ +# 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 unittest.mock import Mock, patch + +import pymssql # type: ignore + +import opentelemetry.instrumentation.pymssql +from opentelemetry.instrumentation.pymssql import PyMSSQLInstrumentor +from opentelemetry.sdk import resources +from opentelemetry.test.test_base import TestBase + + +def mock_connect(*args, **kwargs): + class MockConnection: + def cursor(self): + # pylint: disable=no-self-use + return Mock() + + return MockConnection() + + +class TestPyMSSQLIntegration(TestBase): + def tearDown(self): + super().tearDown() + with self.disable_logging(): + PyMSSQLInstrumentor().uninstrument() + + @patch("pymssql.connect", new=mock_connect) + # pylint: disable=unused-argument + def test_instrumentor(self): + PyMSSQLInstrumentor().instrument() + + cnx = pymssql.connect(database="test") + cursor = cnx.cursor() + query = "SELECT * FROM test" + cursor.execute(query) + + spans_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(spans_list), 1) + span = spans_list[0] + + # Check version and name in span's instrumentation info + self.assertEqualSpanInstrumentationScope( + span, opentelemetry.instrumentation.pymssql + ) + + # check that no spans are generated after uninstrument + PyMSSQLInstrumentor().uninstrument() + + cnx = pymssql.connect(database="test") + cursor = cnx.cursor() + query = "SELECT * FROM test" + cursor.execute(query) + + spans_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(spans_list), 1) + + @patch("pymssql.connect", new=mock_connect) + # pylint: disable=unused-argument + def test_custom_tracer_provider(self): + resource = resources.Resource.create({}) + result = self.create_tracer_provider(resource=resource) + tracer_provider, exporter = result + + PyMSSQLInstrumentor().instrument(tracer_provider=tracer_provider) + + cnx = pymssql.connect(database="test") + cursor = cnx.cursor() + query = "SELECT * FROM test" + cursor.execute(query) + + spans_list = exporter.get_finished_spans() + self.assertEqual(len(spans_list), 1) + span = spans_list[0] + + self.assertIs(span.resource, resource) + + @patch("pymssql.connect", new=mock_connect) + # pylint: disable=unused-argument + def test_instrument_connection(self): + cnx = pymssql.connect(database="test") + query = "SELECT * FROM test" + cursor = cnx.cursor() + cursor.execute(query) + + spans_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(spans_list), 0) + + cnx = PyMSSQLInstrumentor().instrument_connection(cnx) + cursor = cnx.cursor() + cursor.execute(query) + + spans_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(spans_list), 1) + + @patch("pymssql.connect", new=mock_connect) + # pylint: disable=unused-argument + def test_uninstrument_connection(self): + PyMSSQLInstrumentor().instrument() + cnx = pymssql.connect(database="test") + query = "SELECT * FROM test" + cursor = cnx.cursor() + cursor.execute(query) + + spans_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(spans_list), 1) + + cnx = PyMSSQLInstrumentor().uninstrument_connection(cnx) + cursor = cnx.cursor() + cursor.execute(query) + + spans_list = self.memory_exporter.get_finished_spans() + self.assertEqual(len(spans_list), 1) diff --git a/opentelemetry-contrib-instrumentations/pyproject.toml b/opentelemetry-contrib-instrumentations/pyproject.toml index e19c0d69d8..9c0ab886d5 100644 --- a/opentelemetry-contrib-instrumentations/pyproject.toml +++ b/opentelemetry-contrib-instrumentations/pyproject.toml @@ -64,6 +64,7 @@ dependencies = [ "opentelemetry-instrumentation-psycopg2==0.51b0.dev", "opentelemetry-instrumentation-pymemcache==0.51b0.dev", "opentelemetry-instrumentation-pymongo==0.51b0.dev", + "opentelemetry-instrumentation-pymssql==0.51b0.dev", "opentelemetry-instrumentation-pymysql==0.51b0.dev", "opentelemetry-instrumentation-pyramid==0.51b0.dev", "opentelemetry-instrumentation-redis==0.51b0.dev", diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py index 071abe2ad7..db26ed68fc 100644 --- a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py +++ b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap_gen.py @@ -152,6 +152,10 @@ "library": "pymongo >= 3.1, < 5.0", "instrumentation": "opentelemetry-instrumentation-pymongo==0.51b0.dev", }, + { + "library": "pymssql >= 2, < 3", + "instrumentation": "opentelemetry-instrumentation-pymssql==0.51b0.dev", + }, { "library": "PyMySQL < 2", "instrumentation": "opentelemetry-instrumentation-pymysql==0.51b0.dev", diff --git a/tox.ini b/tox.ini index 70c6ae6a28..57af981c52 100644 --- a/tox.ini +++ b/tox.ini @@ -242,6 +242,12 @@ envlist = pypy3-test-instrumentation-pymysql lint-instrumentation-pymysql + ; opentelemetry-instrumentation-pymssql + py3{8,9,10,11,12,13}-test-instrumentation-pymysql + ; pymssql has no support for pypy: see https://github.com/pymssql/pymssql/pull/517 + ; pypy3-test-instrumentation-pymysql + lint-instrumentation-pymssql + ; opentelemetry-instrumentation-pyramid ; TODO: add py313 when supported by pyramid py3{8,9,10,11,12}-test-instrumentation-pyramid @@ -577,6 +583,9 @@ deps = pymysql: {[testenv]test_deps} pymysql: -r {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql/test-requirements.txt + pymssql: {[testenv]test_deps} + pymssql: -r {toxinidir}/instrumentation/opentelemetry-instrumentation-pymssql/test-requirements.txt + pyramid: {[testenv]test_deps} pyramid: -r {toxinidir}/instrumentation/opentelemetry-instrumentation-pyramid/test-requirements.txt @@ -822,6 +831,9 @@ commands = test-instrumentation-pymysql: pytest {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql/tests {posargs} lint-instrumentation-pymysql: sh -c "cd instrumentation && pylint --rcfile ../.pylintrc opentelemetry-instrumentation-pymysql" + test-instrumentation-pymssql: pytest {toxinidir}/instrumentation/opentelemetry-instrumentation-pymssql/tests {posargs} + lint-instrumentation-pymssql: sh -c "cd instrumentation && pylint --rcfile ../.pylintrc opentelemetry-instrumentation-pymssql" + test-instrumentation-pyramid: pytest {toxinidir}/instrumentation/opentelemetry-instrumentation-pyramid/tests {posargs} lint-instrumentation-pyramid: sh -c "cd instrumentation && pylint --rcfile ../.pylintrc opentelemetry-instrumentation-pyramid" @@ -937,6 +949,7 @@ deps = -e {toxinidir}/instrumentation/opentelemetry-instrumentation-psycopg2 -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymongo -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql + -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymssql -e {toxinidir}/instrumentation/opentelemetry-instrumentation-sqlalchemy -e {toxinidir}/instrumentation/opentelemetry-instrumentation-aiopg -e {toxinidir}/instrumentation/opentelemetry-instrumentation-redis