mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-30 21:56:07 +08:00
Instrument mysqlclient library (#1744)
Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>
This commit is contained in:
Alexandre Papin
17
CHANGELOG.md
17
CHANGELOG.md
@ -17,16 +17,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
([#1870](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1870))
|
||||
- Update falcon instrumentation to follow semantic conventions
|
||||
([#1824](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1824))
|
||||
- Fix sqlalchemy instrumentation wrap methods to accept sqlcommenter options([#1873](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1873))
|
||||
- Fix sqlalchemy instrumentation wrap methods to accept sqlcommenter options
|
||||
([#1873](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1873))
|
||||
|
||||
### Added
|
||||
|
||||
- Fix async redis clients not being traced correctly ([#1830](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1830))
|
||||
- Add instrumentor support for mysqlclient
|
||||
([#1744](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1744))
|
||||
- Fix async redis clients not being traced correctly
|
||||
([#1830](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1830))
|
||||
- Make Flask request span attributes available for `start_span`.
|
||||
([#1784](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1784))
|
||||
- Fix falcon instrumentation's usage of Span Status to only set the description if the status code is ERROR.
|
||||
([#1840](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1840))
|
||||
- Instrument all httpx versions >= 0.18. ([#1748](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1748))
|
||||
- Instrument all httpx versions >= 0.18.
|
||||
([#1748](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1748))
|
||||
- Fix `Invalid type NoneType for attribute X (opentelemetry-instrumentation-aws-lambda)` error when some attributes do not exist
|
||||
([#1780](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1780))
|
||||
- Add metric instrumentation for celery
|
||||
@ -44,7 +49,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## Version 1.18.0/0.39b0 (2023-05-10)
|
||||
|
||||
- `opentelemetry-instrumentation-system-metrics` Add `process.` prefix to `runtime.memory`, `runtime.cpu.time`, and `runtime.gc_count`. Change `runtime.memory` from count to UpDownCounter. ([#1735](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1735))
|
||||
- Update runtime metrics to follow semantic conventions
|
||||
([#1735](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1735))
|
||||
- Add request and response hooks for GRPC instrumentation (client only)
|
||||
([#1706](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1706))
|
||||
- Fix memory leak in SQLAlchemy instrumentation where disposed `Engine` does not get garbage collected
|
||||
@ -71,8 +77,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
### Changed
|
||||
|
||||
- `opentelemetry-instrumentation-botocore` now uses the AWS X-Ray propagator by
|
||||
default
|
||||
- `opentelemetry-instrumentation-botocore` now uses the AWS X-Ray propagator by default
|
||||
([#1741](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1741))
|
||||
|
||||
### Fixed
|
||||
|
||||
@ -33,6 +33,7 @@ falcon~=2.0
|
||||
grpcio~=1.27
|
||||
kafka-python>=2.0,<3.0
|
||||
mysql-connector-python~=8.0
|
||||
mysqlclient~=2.1.1
|
||||
psutil>=5
|
||||
pika>=0.12.0
|
||||
pymongo~=3.1
|
||||
|
||||
7
docs/instrumentation/mysqlclient/mysqlclient.rst
Normal file
7
docs/instrumentation/mysqlclient/mysqlclient.rst
Normal file
@ -0,0 +1,7 @@
|
||||
OpenTelemetry mysqlclient Instrumentation
|
||||
=========================================
|
||||
|
||||
.. automodule:: opentelemetry.instrumentation.mysqlclient
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -24,6 +24,7 @@
|
||||
| [opentelemetry-instrumentation-kafka-python](./opentelemetry-instrumentation-kafka-python) | kafka-python >= 2.0 | No
|
||||
| [opentelemetry-instrumentation-logging](./opentelemetry-instrumentation-logging) | logging | No
|
||||
| [opentelemetry-instrumentation-mysql](./opentelemetry-instrumentation-mysql) | mysql-connector-python ~= 8.0 | No
|
||||
| [opentelemetry-instrumentation-mysqlclient](./opentelemetry-instrumentation-mysqlclient) | mysqlclient < 3 | No
|
||||
| [opentelemetry-instrumentation-pika](./opentelemetry-instrumentation-pika) | pika >= 0.12.0 | No
|
||||
| [opentelemetry-instrumentation-psycopg2](./opentelemetry-instrumentation-psycopg2) | psycopg2 >= 2.7.3.1 | No
|
||||
| [opentelemetry-instrumentation-pymemcache](./opentelemetry-instrumentation-pymemcache) | pymemcache >= 1.3.5, < 5 | No
|
||||
|
||||
@ -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 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.
|
||||
@ -0,0 +1,21 @@
|
||||
OpenTelemetry mysqlclient Instrumentation
|
||||
=========================================
|
||||
|
||||
|pypi|
|
||||
|
||||
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-mysqlclient.svg
|
||||
:target: https://pypi.org/project/opentelemetry-instrumentation-mysqlclient/
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
::
|
||||
|
||||
pip install opentelemetry-instrumentation-mysqlclient
|
||||
|
||||
|
||||
References
|
||||
----------
|
||||
* `OpenTelemetry mysqlclient Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/mysqlclient/mysqlclient.html>`_
|
||||
* `OpenTelemetry Project <https://opentelemetry.io/>`_
|
||||
* `OpenTelemetry Python Examples <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples>`_
|
||||
@ -0,0 +1,58 @@
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "opentelemetry-instrumentation-mysqlclient"
|
||||
dynamic = ["version"]
|
||||
description = "OpenTelemetry mysqlclient instrumentation"
|
||||
readme = "README.rst"
|
||||
license = "Apache-2.0"
|
||||
requires-python = ">=3.7"
|
||||
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.7",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
]
|
||||
dependencies = [
|
||||
"opentelemetry-api ~= 1.12",
|
||||
"opentelemetry-instrumentation == 0.40b0.dev",
|
||||
"opentelemetry-instrumentation-dbapi == 0.40b0.dev",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
instruments = [
|
||||
"mysqlclient < 3",
|
||||
]
|
||||
test = [
|
||||
"opentelemetry-instrumentation-mysqlclient[instruments]",
|
||||
"opentelemetry-test-utils == 0.40b0.dev",
|
||||
]
|
||||
|
||||
[project.entry-points.opentelemetry_instrumentor]
|
||||
mysqlclient = "opentelemetry.instrumentation.mysqlclient:MySQLClientInstrumentor"
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-mysqlclient"
|
||||
|
||||
[tool.hatch.version]
|
||||
path = "src/opentelemetry/instrumentation/mysqlclient/version.py"
|
||||
|
||||
[tool.hatch.build.targets.sdist]
|
||||
include = [
|
||||
"/src",
|
||||
"/tests",
|
||||
]
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/opentelemetry"]
|
||||
@ -0,0 +1,117 @@
|
||||
# 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 MySQLClient supports the `MySQLClient`_ library and can be enabled
|
||||
by using ``MySQLClientInstrumentor``.
|
||||
|
||||
.. _MySQLClient: https://pypi.org/project/MySQLClient/
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
.. code:: python
|
||||
|
||||
import MySQLdb
|
||||
from opentelemetry.instrumentation.mysqlclient import MySQLClientInstrumentor
|
||||
|
||||
|
||||
MySQLClientInstrumentor().instrument()
|
||||
|
||||
cnx = MySQLdb.connect(database="MySQL_Database")
|
||||
cursor = cnx.cursor()
|
||||
cursor.execute("INSERT INTO test (testField) VALUES (123)"
|
||||
cnx.commit()
|
||||
cursor.close()
|
||||
cnx.close()
|
||||
|
||||
API
|
||||
---
|
||||
"""
|
||||
|
||||
from typing import Collection
|
||||
|
||||
import MySQLdb
|
||||
|
||||
from opentelemetry.instrumentation import dbapi
|
||||
from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
|
||||
from opentelemetry.instrumentation.mysqlclient.package import _instruments
|
||||
from opentelemetry.instrumentation.mysqlclient.version import __version__
|
||||
|
||||
_CONNECTION_ATTRIBUTES = {
|
||||
"database": "db",
|
||||
"port": "port",
|
||||
"host": "host",
|
||||
"user": "user",
|
||||
}
|
||||
_DATABASE_SYSTEM = "mysql"
|
||||
|
||||
|
||||
class MySQLClientInstrumentor(BaseInstrumentor):
|
||||
def instrumentation_dependencies(self) -> Collection[str]:
|
||||
return _instruments
|
||||
|
||||
def _instrument(self, **kwargs):
|
||||
"""Integrate with the mysqlclient library.
|
||||
https://github.com/PyMySQL/mysqlclient/
|
||||
"""
|
||||
tracer_provider = kwargs.get("tracer_provider")
|
||||
|
||||
dbapi.wrap_connect(
|
||||
__name__,
|
||||
MySQLdb,
|
||||
"connect",
|
||||
_DATABASE_SYSTEM,
|
||||
_CONNECTION_ATTRIBUTES,
|
||||
version=__version__,
|
||||
tracer_provider=tracer_provider,
|
||||
)
|
||||
|
||||
def _uninstrument(self, **kwargs):
|
||||
""" "Disable mysqlclient instrumentation"""
|
||||
dbapi.unwrap_connect(MySQLdb, "connect")
|
||||
|
||||
@staticmethod
|
||||
def instrument_connection(connection, tracer_provider=None):
|
||||
"""Enable instrumentation in a mysqlclient 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,
|
||||
_CONNECTION_ATTRIBUTES,
|
||||
version=__version__,
|
||||
tracer_provider=tracer_provider,
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def uninstrument_connection(connection):
|
||||
"""Disable instrumentation in a mysqlclient connection.
|
||||
|
||||
Args:
|
||||
connection: The connection to uninstrument.
|
||||
|
||||
Returns:
|
||||
An uninstrumented connection.
|
||||
"""
|
||||
return dbapi.uninstrument_connection(connection)
|
||||
@ -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 = ("mysqlclient < 3",)
|
||||
@ -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.40b0.dev"
|
||||
@ -0,0 +1,118 @@
|
||||
# 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 import mock
|
||||
|
||||
import MySQLdb
|
||||
|
||||
import opentelemetry.instrumentation.mysqlclient
|
||||
from opentelemetry.instrumentation.mysqlclient import MySQLClientInstrumentor
|
||||
from opentelemetry.sdk import resources
|
||||
from opentelemetry.test.test_base import TestBase
|
||||
|
||||
|
||||
class TestMySQLClientIntegration(TestBase):
|
||||
def tearDown(self):
|
||||
super().tearDown()
|
||||
with self.disable_logging():
|
||||
MySQLClientInstrumentor().uninstrument()
|
||||
|
||||
@mock.patch("MySQLdb.connect")
|
||||
# pylint: disable=unused-argument
|
||||
def test_instrumentor(self, mock_connect):
|
||||
MySQLClientInstrumentor().instrument()
|
||||
|
||||
cnx = MySQLdb.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.assertEqualSpanInstrumentationInfo(
|
||||
span, opentelemetry.instrumentation.mysqlclient
|
||||
)
|
||||
|
||||
# check that no spans are generated after uninstrument
|
||||
MySQLClientInstrumentor().uninstrument()
|
||||
|
||||
cnx = MySQLdb.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)
|
||||
|
||||
@mock.patch("MySQLdb.connect")
|
||||
# pylint: disable=unused-argument
|
||||
def test_custom_tracer_provider(self, mock_connect):
|
||||
resource = resources.Resource.create({})
|
||||
result = self.create_tracer_provider(resource=resource)
|
||||
tracer_provider, exporter = result
|
||||
|
||||
MySQLClientInstrumentor().instrument(tracer_provider=tracer_provider)
|
||||
|
||||
cnx = MySQLdb.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)
|
||||
|
||||
@mock.patch("MySQLdb.connect")
|
||||
# pylint: disable=unused-argument
|
||||
def test_instrument_connection(self, mock_connect):
|
||||
cnx = MySQLdb.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 = MySQLClientInstrumentor().instrument_connection(cnx)
|
||||
cursor = cnx.cursor()
|
||||
cursor.execute(query)
|
||||
|
||||
spans_list = self.memory_exporter.get_finished_spans()
|
||||
self.assertEqual(len(spans_list), 1)
|
||||
|
||||
@mock.patch("MySQLdb.connect")
|
||||
# pylint: disable=unused-argument
|
||||
def test_uninstrument_connection(self, mock_connect):
|
||||
MySQLClientInstrumentor().instrument()
|
||||
cnx = MySQLdb.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)
|
||||
|
||||
self.memory_exporter.clear()
|
||||
|
||||
cnx = MySQLClientInstrumentor().uninstrument_connection(cnx)
|
||||
cursor = cnx.cursor()
|
||||
cursor.execute(query)
|
||||
|
||||
spans_list = self.memory_exporter.get_finished_spans()
|
||||
self.assertEqual(len(spans_list), 0)
|
||||
@ -52,6 +52,7 @@ dependencies = [
|
||||
"opentelemetry-instrumentation-kafka-python==0.40b0.dev",
|
||||
"opentelemetry-instrumentation-logging==0.40b0.dev",
|
||||
"opentelemetry-instrumentation-mysql==0.40b0.dev",
|
||||
"opentelemetry-instrumentation-mysqlclient==0.40b0.dev",
|
||||
"opentelemetry-instrumentation-pika==0.40b0.dev",
|
||||
"opentelemetry-instrumentation-psycopg2==0.40b0.dev",
|
||||
"opentelemetry-instrumentation-pymemcache==0.40b0.dev",
|
||||
|
||||
@ -96,6 +96,10 @@ libraries = {
|
||||
"library": "mysql-connector-python ~= 8.0",
|
||||
"instrumentation": "opentelemetry-instrumentation-mysql==0.40b0.dev",
|
||||
},
|
||||
"mysqlclient": {
|
||||
"library": "mysqlclient < 3",
|
||||
"instrumentation": "opentelemetry-instrumentation-mysqlclient==0.40b0.dev",
|
||||
},
|
||||
"pika": {
|
||||
"library": "pika >= 0.12.0",
|
||||
"instrumentation": "opentelemetry-instrumentation-pika==0.40b0.dev",
|
||||
|
||||
10
tox.ini
10
tox.ini
@ -121,6 +121,10 @@ envlist =
|
||||
py3{7,8,9,10,11}-test-instrumentation-mysql
|
||||
pypy3-test-instrumentation-mysql
|
||||
|
||||
; opentelemetry-instrumentation-mysqlclient
|
||||
py3{7,8,9,10,11}-test-instrumentation-mysqlclient
|
||||
pypy3-test-instrumentation-mysqlclient
|
||||
|
||||
; opentelemetry-instrumentation-psycopg2
|
||||
py3{7,8,9,10,11}-test-instrumentation-psycopg2
|
||||
; ext-psycopg2 intentionally excluded from pypy3
|
||||
@ -319,6 +323,7 @@ changedir =
|
||||
test-instrumentation-confluent-kafka: instrumentation/opentelemetry-instrumentation-confluent-kafka/tests
|
||||
test-instrumentation-logging: instrumentation/opentelemetry-instrumentation-logging/tests
|
||||
test-instrumentation-mysql: instrumentation/opentelemetry-instrumentation-mysql/tests
|
||||
test-instrumentation-mysqlclient: instrumentation/opentelemetry-instrumentation-mysqlclient/tests
|
||||
test-instrumentation-pika{0,1}: instrumentation/opentelemetry-instrumentation-pika/tests
|
||||
test-instrumentation-aio-pika{7,8,9}: instrumentation/opentelemetry-instrumentation-aio-pika/tests
|
||||
test-instrumentation-psycopg2: instrumentation/opentelemetry-instrumentation-psycopg2/tests
|
||||
@ -402,6 +407,8 @@ commands_pre =
|
||||
|
||||
mysql: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi {toxinidir}/instrumentation/opentelemetry-instrumentation-mysql[test]
|
||||
|
||||
mysqlclient: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi {toxinidir}/instrumentation/opentelemetry-instrumentation-mysqlclient[test]
|
||||
|
||||
pymemcache{135,200,300,342,400}: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-pymemcache[test]
|
||||
|
||||
pymongo: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-pymongo[test]
|
||||
@ -547,6 +554,7 @@ commands_pre =
|
||||
python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-urllib[test]
|
||||
python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-urllib3[test]
|
||||
python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql[test]
|
||||
python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-mysqlclient[test]
|
||||
python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymongo[test]
|
||||
python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-elasticsearch[test]
|
||||
python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-asyncpg[test]
|
||||
@ -587,6 +595,7 @@ deps =
|
||||
pyodbc~=4.0.30
|
||||
flaky==3.7.0
|
||||
remoulade>=0.50
|
||||
mysqlclient~=2.1.1
|
||||
|
||||
changedir =
|
||||
tests/opentelemetry-docker-tests/tests
|
||||
@ -604,6 +613,7 @@ commands_pre =
|
||||
-e {toxinidir}/instrumentation/opentelemetry-instrumentation-confluent-kafka \
|
||||
-e {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi \
|
||||
-e {toxinidir}/instrumentation/opentelemetry-instrumentation-mysql \
|
||||
-e {toxinidir}/instrumentation/opentelemetry-instrumentation-mysqlclient \
|
||||
-e {toxinidir}/instrumentation/opentelemetry-instrumentation-psycopg2 \
|
||||
-e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymongo \
|
||||
-e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql \
|
||||
|
||||
Reference in New Issue
Block a user