|
| 1 | +# Copyright The OpenTelemetry Authors |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +""" |
| 16 | +The integration with pymssql supports the `pymssql`_ library and can be enabled |
| 17 | +by using ``PyMSSQLInstrumentor``. |
| 18 | +
|
| 19 | +.. _pymssql: https://pypi.org/project/pymssql/ |
| 20 | +
|
| 21 | +Usage |
| 22 | +----- |
| 23 | +
|
| 24 | +.. code:: python |
| 25 | +
|
| 26 | + import pymssql |
| 27 | + from opentelemetry.instrumentation.pymssql import PyMSSQLInstrumentor |
| 28 | +
|
| 29 | + PyMSSQLInstrumentor().instrument() |
| 30 | +
|
| 31 | + cnx = pymssql.connect(database="MSSQL_Database") |
| 32 | + cursor = cnx.cursor() |
| 33 | + cursor.execute("INSERT INTO test (testField) VALUES (123)" |
| 34 | + cnx.commit() |
| 35 | + cursor.close() |
| 36 | + cnx.close() |
| 37 | +
|
| 38 | +API |
| 39 | +--- |
| 40 | +""" |
| 41 | +import typing |
| 42 | + |
| 43 | +import pymssql |
| 44 | + |
| 45 | +from opentelemetry.instrumentation import dbapi |
| 46 | +from opentelemetry.instrumentation.instrumentor import BaseInstrumentor |
| 47 | +from opentelemetry.instrumentation.pymssql.package import _instruments |
| 48 | +from opentelemetry.instrumentation.pymssql.version import __version__ |
| 49 | + |
| 50 | + |
| 51 | +class PyMSSQLConnectMethodArgsTuple(typing.NamedTuple): |
| 52 | + server: str = None |
| 53 | + user: str = None |
| 54 | + password: str = None |
| 55 | + database: str = None |
| 56 | + timeout: int = None |
| 57 | + login_timeout: int = None |
| 58 | + charset: str = None |
| 59 | + as_dict: bool = None |
| 60 | + host: str = None |
| 61 | + appname: str = None |
| 62 | + port: str = None |
| 63 | + conn_properties: str = None |
| 64 | + autocommit: bool = None |
| 65 | + tds_version: str = None |
| 66 | + |
| 67 | + |
| 68 | +class PyMSSQLDatabaseApiIntegration(dbapi.DatabaseApiIntegration): |
| 69 | + def wrapped_connection( |
| 70 | + self, |
| 71 | + connect_method: typing.Callable[..., typing.Any], |
| 72 | + args: typing.Tuple[typing.Any, typing.Any], |
| 73 | + kwargs: typing.Dict[typing.Any, typing.Any], |
| 74 | + ): |
| 75 | + """Add object proxy to connection object.""" |
| 76 | + connection = connect_method(*args, **kwargs) |
| 77 | + connect_method_args = PyMSSQLConnectMethodArgsTuple(*args) |
| 78 | + |
| 79 | + self.name = self.database_system |
| 80 | + self.database = kwargs.get("database") or connect_method_args.database |
| 81 | + |
| 82 | + user = kwargs.get("user") or connect_method_args.user |
| 83 | + if user is not None: |
| 84 | + self.span_attributes["db.user"] = user |
| 85 | + |
| 86 | + port = kwargs.get("port") or connect_method_args.port |
| 87 | + host = kwargs.get("server") or connect_method_args.server |
| 88 | + if host is None: |
| 89 | + host = kwargs.get("host") or connect_method_args.host |
| 90 | + if host is not None: |
| 91 | + # The host string can include the port, separated by either a coma or |
| 92 | + # a column |
| 93 | + for sep in (":", ","): |
| 94 | + if sep in host: |
| 95 | + tokens = host.rsplit(sep) |
| 96 | + host = tokens[0] |
| 97 | + if len(tokens) > 1: |
| 98 | + port = tokens[1] |
| 99 | + if host is not None: |
| 100 | + self.span_attributes["net.peer.name"] = host |
| 101 | + if port is not None: |
| 102 | + self.span_attributes["net.peer.port"] = port |
| 103 | + |
| 104 | + charset = kwargs.get("charset") or connect_method_args.charset |
| 105 | + if charset is not None: |
| 106 | + self.span_attributes["db.charset"] = charset |
| 107 | + |
| 108 | + tds_version = ( |
| 109 | + kwargs.get("tds_version") or connect_method_args.tds_version |
| 110 | + ) |
| 111 | + if tds_version is not None: |
| 112 | + self.span_attributes["db.protocol.tds.version"] = tds_version |
| 113 | + |
| 114 | + return dbapi.get_traced_connection_proxy(connection, self) |
| 115 | + |
| 116 | + |
| 117 | +class PyMSSQLInstrumentor(BaseInstrumentor): |
| 118 | + _DATABASE_SYSTEM = "mssql" |
| 119 | + |
| 120 | + def instrumentation_dependencies(self) -> typing.Collection[str]: |
| 121 | + return _instruments |
| 122 | + |
| 123 | + def _instrument(self, **kwargs): |
| 124 | + """Integrate with the pymssql library. |
| 125 | + https://github.com/pymssql/pymssql/ |
| 126 | + """ |
| 127 | + tracer_provider = kwargs.get("tracer_provider") |
| 128 | + |
| 129 | + dbapi.wrap_connect( |
| 130 | + __name__, |
| 131 | + pymssql, |
| 132 | + "connect", |
| 133 | + self._DATABASE_SYSTEM, |
| 134 | + version=__version__, |
| 135 | + tracer_provider=tracer_provider, |
| 136 | + db_api_integration_factory=PyMSSQLDatabaseApiIntegration, |
| 137 | + ) |
| 138 | + |
| 139 | + def _uninstrument(self, **kwargs): |
| 140 | + """"Disable pymssql instrumentation""" |
| 141 | + dbapi.unwrap_connect(pymssql, "connect") |
| 142 | + |
| 143 | + # pylint:disable=no-self-use |
| 144 | + def instrument_connection(self, connection): |
| 145 | + """Enable instrumentation in a pymssql connection. |
| 146 | +
|
| 147 | + Args: |
| 148 | + connection: The connection to instrument. |
| 149 | +
|
| 150 | + Returns: |
| 151 | + An instrumented connection. |
| 152 | + """ |
| 153 | + |
| 154 | + return dbapi.instrument_connection( |
| 155 | + __name__, |
| 156 | + connection, |
| 157 | + self._DATABASE_SYSTEM, |
| 158 | + self._CONNECTION_ATTRIBUTES, |
| 159 | + version=__version__, |
| 160 | + ) |
| 161 | + |
| 162 | + def uninstrument_connection(self, connection): |
| 163 | + """Disable instrumentation in a pymssql connection. |
| 164 | +
|
| 165 | + Args: |
| 166 | + connection: The connection to uninstrument. |
| 167 | +
|
| 168 | + Returns: |
| 169 | + An uninstrumented connection. |
| 170 | + """ |
| 171 | + return dbapi.uninstrument_connection(connection) |
0 commit comments