Requirements: update structlog and django-structlog

Related:

* #10954
* #10933

readthedocs/core/logs.py

@@ -204,6 +204,7 @@ def __call__(self, logger, method_name, event_dict):
 
 
 shared_processors = [
+    structlog.contextvars.merge_contextvars,
     structlog.stdlib.add_logger_name,
     structlog.stdlib.add_log_level,
     structlog.stdlib.PositionalArgumentsFormatter(),
@@ -219,7 +220,6 @@ def __call__(self, logger, method_name, event_dict):
             structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
         ]
     ),
-    context_class=structlog.threadlocal.wrap_dict(dict),
     logger_factory=structlog.stdlib.LoggerFactory(),
     wrapper_class=structlog.stdlib.BoundLogger,
     cache_logger_on_first_use=True,

readthedocs/settings/base.py

@@ -238,6 +238,7 @@ def INSTALLED_APPS(self):  # noqa
             'djstripe',
             'django_celery_beat',
             "django_safemigrate.apps.SafeMigrateConfig",
+            "django_structlog",
 
             # our apps
             'readthedocs.projects',
@@ -320,13 +321,12 @@ def MIDDLEWARE(self):
             'readthedocs.core.middleware.ReferrerPolicyMiddleware',
             'simple_history.middleware.HistoryRequestMiddleware',
             'readthedocs.core.logs.ReadTheDocsRequestMiddleware',
-            'django_structlog.middlewares.CeleryMiddleware',
         ]
         if self.SHOW_DEBUG_TOOLBAR:
             middlewares.insert(0, 'debug_toolbar.middleware.DebugToolbarMiddleware')
         return middlewares
 
-
+    DJANGO_STRUCTLOG_CELERY_ENABLED = True
 
     AUTHENTICATION_BACKENDS = (
         # Needed to login by username in Django admin, regardless of `allauth`

requirements/deploy.txt

@@ -13,6 +13,7 @@ asgiref==3.7.2
     #   -r requirements/pip.txt
     #   django
     #   django-cors-headers
+    #   django-structlog
 asttokens==2.4.1
     # via stack-data
 async-timeout==4.0.3
@@ -36,6 +37,7 @@ celery==5.2.7
     # via
     #   -r requirements/pip.txt
     #   django-celery-beat
+    #   django-structlog
 certifi==2024.2.2
     # via
     #   -r requirements/pip.txt
@@ -145,7 +147,7 @@ django-formtools==2.3
     # via -r requirements/pip.txt
 django-gravatar2==1.4.4
     # via -r requirements/pip.txt
-django-ipware==5.0.2
+django-ipware==6.0.4
     # via
     #   -r requirements/pip.txt
     #   django-structlog
@@ -157,7 +159,7 @@ django-simple-history==3.0.0
     # via -r requirements/pip.txt
 django-storages[boto3]==1.14.2
     # via -r requirements/pip.txt
-django-structlog==2.2.0
+django-structlog[celery]==7.1.0
     # via -r requirements/pip.txt
 django-taggit==5.0.1
     # via -r requirements/pip.txt
@@ -299,6 +301,10 @@ python-dateutil==2.8.2
     #   botocore
     #   elasticsearch-dsl
     #   python-crontab
+python-ipware==2.0.1
+    # via
+    #   -r requirements/pip.txt
+    #   django-ipware
 python3-openid==3.2.0
     # via
     #   -r requirements/pip.txt
@@ -362,7 +368,7 @@ stripe==4.2.0
     # via
     #   -r requirements/pip.txt
     #   dj-stripe
-structlog==23.2.0
+structlog==24.1.0
     # via
     #   -r requirements/pip.txt
     #   django-structlog

requirements/docker.txt

@@ -13,6 +13,7 @@ asgiref==3.7.2
     #   -r requirements/pip.txt
     #   django
     #   django-cors-headers
+    #   django-structlog
 asttokens==2.4.1
     # via stack-data
 async-timeout==4.0.3
@@ -40,6 +41,7 @@ celery==5.2.7
     # via
     #   -r requirements/pip.txt
     #   django-celery-beat
+    #   django-structlog
 certifi==2024.2.2
     # via
     #   -r requirements/pip.txt
@@ -156,7 +158,7 @@ django-formtools==2.3
     # via -r requirements/pip.txt
 django-gravatar2==1.4.4
     # via -r requirements/pip.txt
-django-ipware==5.0.2
+django-ipware==6.0.4
     # via
     #   -r requirements/pip.txt
     #   django-structlog
@@ -168,7 +170,7 @@ django-simple-history==3.0.0
     # via -r requirements/pip.txt
 django-storages[boto3]==1.14.2
     # via -r requirements/pip.txt
-django-structlog==2.2.0
+django-structlog[celery]==7.1.0
     # via -r requirements/pip.txt
 django-taggit==5.0.1
     # via -r requirements/pip.txt
@@ -332,6 +334,10 @@ python-dateutil==2.8.2
     #   botocore
     #   elasticsearch-dsl
     #   python-crontab
+python-ipware==2.0.1
+    # via
+    #   -r requirements/pip.txt
+    #   django-ipware
 python3-openid==3.2.0
     # via
     #   -r requirements/pip.txt
@@ -395,7 +401,7 @@ stripe==4.2.0
     # via
     #   -r requirements/pip.txt
     #   dj-stripe
-structlog==23.2.0
+structlog==24.1.0
     # via
     #   -r requirements/pip.txt
     #   django-structlog

requirements/pip.in

@@ -161,17 +161,8 @@ django-debug-toolbar
 # For enabling content-security-policy
 django-csp
 
-# Upgrading to 3.x requires some extra work
-# https://django-structlog.readthedocs.io/en/latest/upgrade_guide.html#upgrading-to-3-0
-# NOTE: that django-structlog is in version 6.x now,
-# so we should probably consider migrating to avoid incompatibility issues.
-django-structlog==2.2.0
-# Pining due to a Sentry error we started getting
-# https://read-the-docs.sentry.io/issues/4678167578/events/2d9d348729874d67b120b153908ca54c/
-django-ipware<6.0.0
-
-# https://github.com/readthedocs/readthedocs.org/issues/10990
-structlog==23.2.0
+django-structlog[celery]
+structlog
 dparse
 
 gunicorn

requirements/pip.txt

@@ -10,6 +10,7 @@ asgiref==3.7.2
     # via
     #   django
     #   django-cors-headers
+    #   django-structlog
 async-timeout==4.0.3
     # via redis
 billiard==3.6.4.0
@@ -24,6 +25,7 @@ celery==5.2.7
     # via
     #   -r requirements/pip.in
     #   django-celery-beat
+    #   django-structlog
 certifi==2024.2.2
     # via
     #   elastic-transport
@@ -108,10 +110,8 @@ django-formtools==2.3
     # via -r requirements/pip.in
 django-gravatar2==1.4.4
     # via -r requirements/pip.in
-django-ipware==5.0.2
-    # via
-    #   -r requirements/pip.in
-    #   django-structlog
+django-ipware==6.0.4
+    # via django-structlog
 django-polymorphic==3.1.0
     # via -r requirements/pip.in
 django-safemigrate==4.2
@@ -120,7 +120,7 @@ django-simple-history==3.0.0
     # via -r requirements/pip.in
 django-storages[boto3]==1.14.2
     # via -r requirements/pip.in
-django-structlog==2.2.0
+django-structlog[celery]==7.1.0
     # via -r requirements/pip.in
 django-taggit==5.0.1
     # via -r requirements/pip.in
@@ -212,6 +212,8 @@ python-dateutil==2.8.2
     #   botocore
     #   elasticsearch-dsl
     #   python-crontab
+python-ipware==2.0.1
+    # via django-ipware
 python3-openid==3.2.0
     # via django-allauth
 pytz==2024.1
@@ -264,7 +266,7 @@ stripe==4.2.0
     # via
     #   -r requirements/pip.in
     #   dj-stripe
-structlog==23.2.0
+structlog==24.1.0
     # via
     #   -r requirements/pip.in
     #   django-structlog

requirements/testing.txt

@@ -15,6 +15,7 @@ asgiref==3.7.2
     #   -r requirements/pip.txt
     #   django
     #   django-cors-headers
+    #   django-structlog
 async-timeout==4.0.3
     # via
     #   -r requirements/pip.txt
@@ -38,6 +39,7 @@ celery==5.2.7
     # via
     #   -r requirements/pip.txt
     #   django-celery-beat
+    #   django-structlog
 certifi==2024.2.2
     # via
     #   -r requirements/pip.txt
@@ -148,7 +150,7 @@ django-formtools==2.3
     # via -r requirements/pip.txt
 django-gravatar2==1.4.4
     # via -r requirements/pip.txt
-django-ipware==5.0.2
+django-ipware==6.0.4
     # via
     #   -r requirements/pip.txt
     #   django-structlog
@@ -160,7 +162,7 @@ django-simple-history==3.0.0
     # via -r requirements/pip.txt
 django-storages[boto3]==1.14.2
     # via -r requirements/pip.txt
-django-structlog==2.2.0
+django-structlog[celery]==7.1.0
     # via -r requirements/pip.txt
 django-taggit==5.0.1
     # via -r requirements/pip.txt
@@ -314,6 +316,10 @@ python-dateutil==2.8.2
     #   botocore
     #   elasticsearch-dsl
     #   python-crontab
+python-ipware==2.0.1
+    # via
+    #   -r requirements/pip.txt
+    #   django-ipware
 python3-openid==3.2.0
     # via
     #   -r requirements/pip.txt
@@ -395,7 +401,7 @@ stripe==4.2.0
     # via
     #   -r requirements/pip.txt
     #   dj-stripe
-structlog==23.2.0
+structlog==24.1.0
     # via
     #   -r requirements/pip.txt
     #   django-structlog