forked from open-telemetry/opentelemetry-python-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Integrating sql commenter into otel_django_instrumentation (open-tele…
…metry#896) * Integrating sql commenter into otel_django_instrumentation * Added test cases for django * - Linting changes - Added Changelog * - Linting changes * - Linting changes * - Linting changes * - Linting changes * - Linting changes * - Linting changes * - Linting changes * PR changes * PR changes * Linting changes * Linting changes * Linting changes * Linting changes * PR changes * PR changes * PR changes * linting changes * PR changes * linting changes * PR changes * PR changes * PR changes * PR changes * PR changes Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com> Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>
- Loading branch information
3 people
authored
Jun 29, 2022
1 parent
e267ebc
commit ac84e99
Showing
8 changed files
with
334 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
File renamed without changes.
153 changes: 153 additions & 0 deletions
153
...ion-django/src/opentelemetry/instrumentation/django/middleware/sqlcommenter_middleware.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| #!/usr/bin/python | ||
| # | ||
| # 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 logging import getLogger | ||
| from typing import Any, Type, TypeVar | ||
| from urllib.parse import quote as urllib_quote | ||
|
|
||
| # pylint: disable=no-name-in-module | ||
| from django import conf, get_version | ||
| from django.db import connection | ||
| from django.db.backends.utils import CursorDebugWrapper | ||
|
|
||
| from opentelemetry.trace.propagation.tracecontext import ( | ||
| TraceContextTextMapPropagator, | ||
| ) | ||
|
|
||
| _propagator = TraceContextTextMapPropagator() | ||
|
|
||
| _django_version = get_version() | ||
| _logger = getLogger(__name__) | ||
|
|
||
| T = TypeVar("T") # pylint: disable-msg=invalid-name | ||
|
|
||
|
|
||
| class SqlCommenter: | ||
| """ | ||
| Middleware to append a comment to each database query with details about | ||
| the framework and the execution context. | ||
| """ | ||
|
|
||
| def __init__(self, get_response) -> None: | ||
| self.get_response = get_response | ||
|
|
||
| def __call__(self, request) -> Any: | ||
| with connection.execute_wrapper(_QueryWrapper(request)): | ||
| return self.get_response(request) | ||
|
|
||
|
|
||
| class _QueryWrapper: | ||
| def __init__(self, request) -> None: | ||
| self.request = request | ||
|
|
||
| def __call__(self, execute: Type[T], sql, params, many, context) -> T: | ||
| # pylint: disable-msg=too-many-locals | ||
| with_framework = getattr( | ||
| conf.settings, "SQLCOMMENTER_WITH_FRAMEWORK", True | ||
| ) | ||
| with_controller = getattr( | ||
| conf.settings, "SQLCOMMENTER_WITH_CONTROLLER", True | ||
| ) | ||
| with_route = getattr(conf.settings, "SQLCOMMENTER_WITH_ROUTE", True) | ||
| with_app_name = getattr( | ||
| conf.settings, "SQLCOMMENTER_WITH_APP_NAME", True | ||
| ) | ||
| with_opentelemetry = getattr( | ||
| conf.settings, "SQLCOMMENTER_WITH_OPENTELEMETRY", True | ||
| ) | ||
| with_db_driver = getattr( | ||
| conf.settings, "SQLCOMMENTER_WITH_DB_DRIVER", True | ||
| ) | ||
|
|
||
| db_driver = context["connection"].settings_dict.get("ENGINE", "") | ||
| resolver_match = self.request.resolver_match | ||
|
|
||
| sql_comment = _generate_sql_comment( | ||
| # Information about the controller. | ||
| controller=resolver_match.view_name | ||
| if resolver_match and with_controller | ||
| else None, | ||
| # route is the pattern that matched a request with a controller i.e. the regex | ||
| # See https://docs.djangoproject.com/en/stable/ref/urlresolvers/#django.urls.ResolverMatch.route | ||
| # getattr() because the attribute doesn't exist in Django < 2.2. | ||
| route=getattr(resolver_match, "route", None) | ||
| if resolver_match and with_route | ||
| else None, | ||
| # app_name is the application namespace for the URL pattern that matches the URL. | ||
| # See https://docs.djangoproject.com/en/stable/ref/urlresolvers/#django.urls.ResolverMatch.app_name | ||
| app_name=(resolver_match.app_name or None) | ||
| if resolver_match and with_app_name | ||
| else None, | ||
| # Framework centric information. | ||
| framework=f"django:{_django_version}" if with_framework else None, | ||
| # Information about the database and driver. | ||
| db_driver=db_driver if with_db_driver else None, | ||
| **_get_opentelemetry_values() if with_opentelemetry else {}, | ||
| ) | ||
|
|
||
| # TODO: MySQL truncates logs > 1024B so prepend comments | ||
| # instead of statements, if the engine is MySQL. | ||
| # See: | ||
| # * https://github.com/basecamp/marginalia/issues/61 | ||
| # * https://github.com/basecamp/marginalia/pull/80 | ||
| sql += sql_comment | ||
|
|
||
| # Add the query to the query log if debugging. | ||
| if context["cursor"].__class__ is CursorDebugWrapper: | ||
| context["connection"].queries_log.append(sql) | ||
|
|
||
| return execute(sql, params, many, context) | ||
|
|
||
|
|
||
| def _generate_sql_comment(**meta) -> str: | ||
| """ | ||
| Return a SQL comment with comma delimited key=value pairs created from | ||
| **meta kwargs. | ||
| """ | ||
| key_value_delimiter = "," | ||
|
|
||
| if not meta: # No entries added. | ||
| return "" | ||
|
|
||
| # Sort the keywords to ensure that caching works and that testing is | ||
| # deterministic. It eases visual inspection as well. | ||
| return ( | ||
| " /*" | ||
| + key_value_delimiter.join( | ||
| f"{_url_quote(key)}={_url_quote(value)!r}" | ||
| for key, value in sorted(meta.items()) | ||
| if value is not None | ||
| ) | ||
| + "*/" | ||
| ) | ||
|
|
||
|
|
||
| def _url_quote(value) -> str: | ||
| if not isinstance(value, (str, bytes)): | ||
| return value | ||
| _quoted = urllib_quote(value) | ||
| # Since SQL uses '%' as a keyword, '%' is a by-product of url quoting | ||
| # e.g. foo,bar --> foo%2Cbar | ||
| # thus in our quoting, we need to escape it too to finally give | ||
| # foo,bar --> foo%%2Cbar | ||
| return _quoted.replace("%", "%%") | ||
|
|
||
|
|
||
| def _get_opentelemetry_values() -> dict or None: | ||
| """ | ||
| Return the OpenTelemetry Trace and Span IDs if Span ID is set in the | ||
| OpenTelemetry execution context. | ||
| """ | ||
| return _propagator.inject({}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.