Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `opentelemetry-instrumentation-system-metrics`: Use proper numeric `cpython.gc.generation` attribute in CPython metrics, out of spec `generation` attribute is deprecated and will be removed in the future
([#4092](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4092))

### Breaking changes

- `opentelemetry-instrumentation-django`: Drop support for Django < 2.0
([#3848](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4083))

## Version 1.39.0/0.60b0 (2025-12-03)

### Added
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| [opentelemetry-instrumentation-click](./opentelemetry-instrumentation-click) | click >= 8.1.3, < 9.0.0 | No | development
| [opentelemetry-instrumentation-confluent-kafka](./opentelemetry-instrumentation-confluent-kafka) | confluent-kafka >= 1.8.2, <= 2.11.0 | No | development
| [opentelemetry-instrumentation-dbapi](./opentelemetry-instrumentation-dbapi) | dbapi | No | development
| [opentelemetry-instrumentation-django](./opentelemetry-instrumentation-django) | django >= 1.10 | Yes | development
| [opentelemetry-instrumentation-django](./opentelemetry-instrumentation-django) | django >= 2.0 | Yes | development
| [opentelemetry-instrumentation-elasticsearch](./opentelemetry-instrumentation-elasticsearch) | elasticsearch >= 6.0 | No | development
| [opentelemetry-instrumentation-falcon](./opentelemetry-instrumentation-falcon) | falcon >= 1.4.1, < 5.0.0 | Yes | migration
| [opentelemetry-instrumentation-fastapi](./opentelemetry-instrumentation-fastapi) | fastapi ~= 0.92 | Yes | migration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ asgi = [
"opentelemetry-instrumentation-asgi == 0.61b0.dev",
]
instruments = [
"django >= 1.10",
"django >= 2.0",
]

[project.entry-points.opentelemetry_instrumentor]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,6 @@ def response_hook(span, request, response):
from os import environ
from typing import Collection

from django import VERSION as django_version
from django.conf import settings
from django.core.exceptions import ImproperlyConfigured

Expand Down Expand Up @@ -335,21 +334,11 @@ def response_hook(span, request, response):
from opentelemetry.trace import get_tracer
from opentelemetry.util.http import get_excluded_urls, parse_excluded_urls

DJANGO_2_0 = django_version >= (2, 0)

_excluded_urls_from_env = get_excluded_urls("DJANGO")
_django_middleware_setting = "MIDDLEWARE"
_logger = getLogger(__name__)


def _get_django_middleware_setting() -> str:
# In Django versions 1.x, setting MIDDLEWARE_CLASSES can be used as a legacy
# alternative to MIDDLEWARE. This is the case when `settings.MIDDLEWARE` has
# its default value (`None`).
if not DJANGO_2_0 and getattr(settings, "MIDDLEWARE", None) is None:
return "MIDDLEWARE_CLASSES"
return "MIDDLEWARE"


def _get_django_otel_middleware_position(
middleware_length, default_middleware_position=0
):
Expand Down Expand Up @@ -452,24 +441,29 @@ def _instrument(self, **kwargs):
# https://docs.djangoproject.com/en/3.0/topics/http/middleware/#activating-middleware
# https://docs.djangoproject.com/en/3.0/ref/middleware/#middleware-ordering

_middleware_setting = _get_django_middleware_setting()
settings_middleware = []
try:
settings_middleware = getattr(settings, _middleware_setting, [])
settings_middleware = getattr(
settings, _django_middleware_setting, []
)
except ImproperlyConfigured as exception:
_logger.debug(
"DJANGO_SETTINGS_MODULE environment variable not configured. Defaulting to empty settings: %s",
exception,
)
settings.configure()
settings_middleware = getattr(settings, _middleware_setting, [])
settings_middleware = getattr(
settings, _django_middleware_setting, []
)
except ModuleNotFoundError as exception:
_logger.debug(
"DJANGO_SETTINGS_MODULE points to a non-existent module. Defaulting to empty settings: %s",
exception,
)
settings.configure()
settings_middleware = getattr(settings, _middleware_setting, [])
settings_middleware = getattr(
settings, _django_middleware_setting, []
)

# Django allows to specify middlewares as a tuple, so we convert this tuple to a
# list, otherwise we wouldn't be able to call append/remove
Expand All @@ -491,11 +485,12 @@ def _instrument(self, **kwargs):
middleware_position, self._opentelemetry_middleware
)

setattr(settings, _middleware_setting, settings_middleware)
setattr(settings, _django_middleware_setting, settings_middleware)

def _uninstrument(self, **kwargs):
_middleware_setting = _get_django_middleware_setting()
settings_middleware = getattr(settings, _middleware_setting, None)
settings_middleware = getattr(
settings, _django_middleware_setting, None
)

# FIXME This is starting to smell like trouble. We have 2 mechanisms
# that may make this condition be True, one implemented in
Expand All @@ -508,4 +503,4 @@ def _uninstrument(self, **kwargs):
return

settings_middleware.remove(self._opentelemetry_middleware)
setattr(settings, _middleware_setting, settings_middleware)
setattr(settings, _django_middleware_setting, settings_middleware)
Original file line number Diff line number Diff line change
Expand Up @@ -79,30 +79,8 @@
except ImportError:
from django.urls import Resolver404, resolve

DJANGO_2_0 = django_version >= (2, 0)
DJANGO_3_0 = django_version >= (3, 0)

if DJANGO_2_0:
# Since Django 2.0, only `settings.MIDDLEWARE` is supported, so new-style
# middlewares can be used.
class MiddlewareMixin:
def __init__(self, get_response):
self.get_response = get_response

def __call__(self, request):
self.process_request(request)
response = self.get_response(request)
return self.process_response(request, response)

else:
# Django versions 1.x can use `settings.MIDDLEWARE_CLASSES` and expect
# old-style middlewares, which are created by inheriting from
# `deprecation.MiddlewareMixin` since its creation in Django 1.10 and 1.11,
# or from `object` for older versions.
try:
from django.utils.deprecation import MiddlewareMixin
except ImportError:
MiddlewareMixin = object

if DJANGO_3_0:
from django.core.handlers.asgi import ASGIRequest
Expand Down Expand Up @@ -137,7 +115,7 @@ def _is_asgi_request(request: HttpRequest) -> bool:
return ASGIRequest is not None and isinstance(request, ASGIRequest)


class _DjangoMiddleware(MiddlewareMixin):
class _DjangoMiddleware:
"""Django Middleware for OpenTelemetry"""

_environ_activation_key = (
Expand Down Expand Up @@ -167,6 +145,14 @@ class _DjangoMiddleware(MiddlewareMixin):
None
)

def __init__(self, get_response):
self.get_response = get_response

def __call__(self, request):
self.process_request(request)
response = self.get_response(request)
return self.process_response(request, response)

@staticmethod
def _get_span_name(request):
method = sanitize_method(request.method.strip())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@
# limitations under the License.


_instruments = ("django >= 1.10",)
_instruments = ("django >= 2.0",)
_supports_metrics = True
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"instrumentation": "opentelemetry-instrumentation-confluent-kafka==0.61b0.dev",
},
{
"library": "django >= 1.10",
"library": "django >= 2.0",
"instrumentation": "opentelemetry-instrumentation-django==0.61b0.dev",
},
{
Expand Down
Loading