Skip to content

Commit 38948cd

Browse files
committed
Requirements: update structlog and django-structlog
Related: * #10954 * #10933
1 parent b03f28d commit 38948cd

File tree

7 files changed

+40
-29
lines changed

7 files changed

+40
-29
lines changed

readthedocs/core/logs.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ def __call__(self, logger, method_name, event_dict):
204204

205205

206206
shared_processors = [
207+
structlog.contextvars.merge_contextvars,
207208
structlog.stdlib.add_logger_name,
208209
structlog.stdlib.add_log_level,
209210
structlog.stdlib.PositionalArgumentsFormatter(),
@@ -219,7 +220,6 @@ def __call__(self, logger, method_name, event_dict):
219220
structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
220221
]
221222
),
222-
context_class=structlog.threadlocal.wrap_dict(dict),
223223
logger_factory=structlog.stdlib.LoggerFactory(),
224224
wrapper_class=structlog.stdlib.BoundLogger,
225225
cache_logger_on_first_use=True,

readthedocs/settings/base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,7 @@ def INSTALLED_APPS(self): # noqa
238238
'djstripe',
239239
'django_celery_beat',
240240
"django_safemigrate.apps.SafeMigrateConfig",
241+
"django_structlog",
241242

242243
# our apps
243244
'readthedocs.projects',
@@ -320,13 +321,12 @@ def MIDDLEWARE(self):
320321
'readthedocs.core.middleware.ReferrerPolicyMiddleware',
321322
'simple_history.middleware.HistoryRequestMiddleware',
322323
'readthedocs.core.logs.ReadTheDocsRequestMiddleware',
323-
'django_structlog.middlewares.CeleryMiddleware',
324324
]
325325
if self.SHOW_DEBUG_TOOLBAR:
326326
middlewares.insert(0, 'debug_toolbar.middleware.DebugToolbarMiddleware')
327327
return middlewares
328328

329-
329+
DJANGO_STRUCTLOG_CELERY_ENABLED = True
330330

331331
AUTHENTICATION_BACKENDS = (
332332
# Needed to login by username in Django admin, regardless of `allauth`

requirements/deploy.txt

+9-3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ asgiref==3.7.2
1313
# -r requirements/pip.txt
1414
# django
1515
# django-cors-headers
16+
# django-structlog
1617
asttokens==2.4.1
1718
# via stack-data
1819
async-timeout==4.0.3
@@ -36,6 +37,7 @@ celery==5.2.7
3637
# via
3738
# -r requirements/pip.txt
3839
# django-celery-beat
40+
# django-structlog
3941
certifi==2024.2.2
4042
# via
4143
# -r requirements/pip.txt
@@ -145,7 +147,7 @@ django-formtools==2.3
145147
# via -r requirements/pip.txt
146148
django-gravatar2==1.4.4
147149
# via -r requirements/pip.txt
148-
django-ipware==5.0.2
150+
django-ipware==6.0.4
149151
# via
150152
# -r requirements/pip.txt
151153
# django-structlog
@@ -157,7 +159,7 @@ django-simple-history==3.0.0
157159
# via -r requirements/pip.txt
158160
django-storages[boto3]==1.14.2
159161
# via -r requirements/pip.txt
160-
django-structlog==2.2.0
162+
django-structlog[celery]==7.1.0
161163
# via -r requirements/pip.txt
162164
django-taggit==5.0.1
163165
# via -r requirements/pip.txt
@@ -299,6 +301,10 @@ python-dateutil==2.8.2
299301
# botocore
300302
# elasticsearch-dsl
301303
# python-crontab
304+
python-ipware==2.0.1
305+
# via
306+
# -r requirements/pip.txt
307+
# django-ipware
302308
python3-openid==3.2.0
303309
# via
304310
# -r requirements/pip.txt
@@ -362,7 +368,7 @@ stripe==4.2.0
362368
# via
363369
# -r requirements/pip.txt
364370
# dj-stripe
365-
structlog==23.2.0
371+
structlog==24.1.0
366372
# via
367373
# -r requirements/pip.txt
368374
# django-structlog

requirements/docker.txt

+9-3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ asgiref==3.7.2
1313
# -r requirements/pip.txt
1414
# django
1515
# django-cors-headers
16+
# django-structlog
1617
asttokens==2.4.1
1718
# via stack-data
1819
async-timeout==4.0.3
@@ -40,6 +41,7 @@ celery==5.2.7
4041
# via
4142
# -r requirements/pip.txt
4243
# django-celery-beat
44+
# django-structlog
4345
certifi==2024.2.2
4446
# via
4547
# -r requirements/pip.txt
@@ -156,7 +158,7 @@ django-formtools==2.3
156158
# via -r requirements/pip.txt
157159
django-gravatar2==1.4.4
158160
# via -r requirements/pip.txt
159-
django-ipware==5.0.2
161+
django-ipware==6.0.4
160162
# via
161163
# -r requirements/pip.txt
162164
# django-structlog
@@ -168,7 +170,7 @@ django-simple-history==3.0.0
168170
# via -r requirements/pip.txt
169171
django-storages[boto3]==1.14.2
170172
# via -r requirements/pip.txt
171-
django-structlog==2.2.0
173+
django-structlog[celery]==7.1.0
172174
# via -r requirements/pip.txt
173175
django-taggit==5.0.1
174176
# via -r requirements/pip.txt
@@ -332,6 +334,10 @@ python-dateutil==2.8.2
332334
# botocore
333335
# elasticsearch-dsl
334336
# python-crontab
337+
python-ipware==2.0.1
338+
# via
339+
# -r requirements/pip.txt
340+
# django-ipware
335341
python3-openid==3.2.0
336342
# via
337343
# -r requirements/pip.txt
@@ -395,7 +401,7 @@ stripe==4.2.0
395401
# via
396402
# -r requirements/pip.txt
397403
# dj-stripe
398-
structlog==23.2.0
404+
structlog==24.1.0
399405
# via
400406
# -r requirements/pip.txt
401407
# django-structlog

requirements/pip.in

+2-11
Original file line numberDiff line numberDiff line change
@@ -161,17 +161,8 @@ django-debug-toolbar
161161
# For enabling content-security-policy
162162
django-csp
163163

164-
# Upgrading to 3.x requires some extra work
165-
# https://django-structlog.readthedocs.io/en/latest/upgrade_guide.html#upgrading-to-3-0
166-
# NOTE: that django-structlog is in version 6.x now,
167-
# so we should probably consider migrating to avoid incompatibility issues.
168-
django-structlog==2.2.0
169-
# Pining due to a Sentry error we started getting
170-
# https://read-the-docs.sentry.io/issues/4678167578/events/2d9d348729874d67b120b153908ca54c/
171-
django-ipware<6.0.0
172-
173-
# https://github.com/readthedocs/readthedocs.org/issues/10990
174-
structlog==23.2.0
164+
django-structlog[celery]
165+
structlog
175166
dparse
176167

177168
gunicorn

requirements/pip.txt

+8-6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ asgiref==3.7.2
1010
# via
1111
# django
1212
# django-cors-headers
13+
# django-structlog
1314
async-timeout==4.0.3
1415
# via redis
1516
billiard==3.6.4.0
@@ -24,6 +25,7 @@ celery==5.2.7
2425
# via
2526
# -r requirements/pip.in
2627
# django-celery-beat
28+
# django-structlog
2729
certifi==2024.2.2
2830
# via
2931
# elastic-transport
@@ -108,10 +110,8 @@ django-formtools==2.3
108110
# via -r requirements/pip.in
109111
django-gravatar2==1.4.4
110112
# via -r requirements/pip.in
111-
django-ipware==5.0.2
112-
# via
113-
# -r requirements/pip.in
114-
# django-structlog
113+
django-ipware==6.0.4
114+
# via django-structlog
115115
django-polymorphic==3.1.0
116116
# via -r requirements/pip.in
117117
django-safemigrate==4.2
@@ -120,7 +120,7 @@ django-simple-history==3.0.0
120120
# via -r requirements/pip.in
121121
django-storages[boto3]==1.14.2
122122
# via -r requirements/pip.in
123-
django-structlog==2.2.0
123+
django-structlog[celery]==7.1.0
124124
# via -r requirements/pip.in
125125
django-taggit==5.0.1
126126
# via -r requirements/pip.in
@@ -212,6 +212,8 @@ python-dateutil==2.8.2
212212
# botocore
213213
# elasticsearch-dsl
214214
# python-crontab
215+
python-ipware==2.0.1
216+
# via django-ipware
215217
python3-openid==3.2.0
216218
# via django-allauth
217219
pytz==2024.1
@@ -264,7 +266,7 @@ stripe==4.2.0
264266
# via
265267
# -r requirements/pip.in
266268
# dj-stripe
267-
structlog==23.2.0
269+
structlog==24.1.0
268270
# via
269271
# -r requirements/pip.in
270272
# django-structlog

requirements/testing.txt

+9-3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ asgiref==3.7.2
1515
# -r requirements/pip.txt
1616
# django
1717
# django-cors-headers
18+
# django-structlog
1819
async-timeout==4.0.3
1920
# via
2021
# -r requirements/pip.txt
@@ -38,6 +39,7 @@ celery==5.2.7
3839
# via
3940
# -r requirements/pip.txt
4041
# django-celery-beat
42+
# django-structlog
4143
certifi==2024.2.2
4244
# via
4345
# -r requirements/pip.txt
@@ -148,7 +150,7 @@ django-formtools==2.3
148150
# via -r requirements/pip.txt
149151
django-gravatar2==1.4.4
150152
# via -r requirements/pip.txt
151-
django-ipware==5.0.2
153+
django-ipware==6.0.4
152154
# via
153155
# -r requirements/pip.txt
154156
# django-structlog
@@ -160,7 +162,7 @@ django-simple-history==3.0.0
160162
# via -r requirements/pip.txt
161163
django-storages[boto3]==1.14.2
162164
# via -r requirements/pip.txt
163-
django-structlog==2.2.0
165+
django-structlog[celery]==7.1.0
164166
# via -r requirements/pip.txt
165167
django-taggit==5.0.1
166168
# via -r requirements/pip.txt
@@ -314,6 +316,10 @@ python-dateutil==2.8.2
314316
# botocore
315317
# elasticsearch-dsl
316318
# python-crontab
319+
python-ipware==2.0.1
320+
# via
321+
# -r requirements/pip.txt
322+
# django-ipware
317323
python3-openid==3.2.0
318324
# via
319325
# -r requirements/pip.txt
@@ -395,7 +401,7 @@ stripe==4.2.0
395401
# via
396402
# -r requirements/pip.txt
397403
# dj-stripe
398-
structlog==23.2.0
404+
structlog==24.1.0
399405
# via
400406
# -r requirements/pip.txt
401407
# django-structlog

0 commit comments

Comments
 (0)