1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
"""
Django settings for demoproj project.
Generated by 'django-admin startproject' using Django 3.0.1.
For more information on this file, see
https://docs.djangoproject.com/en/3.0/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/3.0/ref/settings/
"""
import os
from typing import List
from celery.schedules import crontab
from django_guid.integrations import CeleryIntegration, SentryIntegration
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
SECRET_KEY = 'secret'
DEBUG = True
ALLOWED_HOSTS: List[str] = []
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework',
'django_guid',
]
MIDDLEWARE = [
'django_guid.middleware.guid_middleware', # <-- Add middleware at the top of your middlewares
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
ROOT_URLCONF = 'demoproj.urls'
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
# 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
'NAME': ':memory:',
}
}
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True
STATIC_URL = '/static/'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
# fmt: off
# OBS: No setting in Django GUID is required. These are example settings.
DJANGO_GUID = {
'GUID_HEADER_NAME': 'Correlation-ID',
'VALIDATE_GUID': True,
'INTEGRATIONS': [
CeleryIntegration(
use_django_logging=True,
log_parent=True,
uuid_length=10
),
SentryIntegration()
],
'IGNORE_URLS': ['no-guid'],
}
# Set up logging for the project
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'filters': {
'correlation_id': {'()': 'django_guid.log_filters.CorrelationId'}, # <-- Add correlation ID
'celery_tracing': {'()': 'django_guid.integrations.celery.log_filters.CeleryTracing'}, # <-- Add celery IDs
},
'formatters': {
# Basic log format without django-guid filters
'basic_format': {'format': '%(levelname)s %(asctime)s %(name)s - %(message)s'},
# Format with correlation ID output to the console
'correlation_id_format': {'format': '%(levelname)s %(asctime)s [%(correlation_id)s] %(name)s - %(message)s'},
# Format with correlation ID plus a celery process' parent ID and a unique current ID that will
# become the parent ID of any child processes that are created (most likely you won't want to
# display these values in your formatter, but include them just as a filter)
'celery_depth_format': {
'format': '%(levelname)s [%(correlation_id)s] [%(celery_parent_id)s-%(celery_current_id)s] %(name)s - %(message)s'
},
},
'handlers': {
'correlation_id_handler': {
'class': 'logging.StreamHandler',
'formatter': 'correlation_id_format',
# Here we include the filters on the handler - this means our IDs are included in the logger extra data
# and *can* be displayed in our log message if specified in the formatter - but it will be
# included in the logs whether shown in the message or not.
'filters': ['correlation_id', 'celery_tracing'],
},
'celery_depth_handler': {
'class': 'logging.StreamHandler',
'formatter': 'celery_depth_format',
'filters': ['correlation_id', 'celery_tracing'],
},
},
'loggers': {
'django': {
'handlers': ['correlation_id_handler'],
'level': 'INFO'
},
'demoproj': {
'handlers': ['correlation_id_handler'],
'level': 'DEBUG'
},
'django_guid': {
'handlers': ['correlation_id_handler'],
'level': 'DEBUG',
'propagate': True,
},
'django_guid.celery': {
'handlers': ['celery_depth_handler'],
'level': 'DEBUG',
'propagate': False,
},
'celery': {
'handlers': ['celery_depth_handler'],
'level': 'INFO',
},
}
}
# fmt: on
CELERY_BROKER_URL = 'redis://:@localhost:6378'
CELERY_RESULT_BACKEND = CELERY_BROKER_URL
CELERY_BEAT_SCHEDULE = {
'test': {
'task': 'demoproj.celery.debug_task',
'schedule': crontab(minute='*/1'),
},
}
|
