Log handling and representing for django projects
pip install sw-django-logger
Add to settings.py
INSTALLED_APPS = [
...
'sw_logger',
...
]
...
LOGGING = {
...
'handlers': {
...
'db': {
'level': 'INFO',
'class': 'sw_logger.handlers.DbHandler',
},
},
'loggers': {
...
'db': {
'handlers': ['db'],
'level': 'INFO',
}
}
}Migrate
./manage.py migrate
Add unique for project LOG_NAME attribute to models
class Book(models.Model)
LOG_NAME = 'book'
name = ...Using in view:
import logging
logger = logging.getLogger('db')
class Update(UpdateView):
...
def form_valid(self, form):
response = super().form_valid(form)
logger.info(
'Some message',
extra={
'action': sw_logger.consts.ACTION_UPDATED,
'request': self.request,
'object': self.get_object(),
}
)
return responseCreate log view
class Log(sw_logger.views.Log):
template_name = 'core/report/log.html'Add to urls.py
...
urlpatterns = [
...
url(r'^log/$', core.views.Log.as_view(), name='log'),
...
]Add template
...
{{ form }}
<table>
<thead>
<tr>
<th>#</th>
<th>Message</th>
<th>Object</th>
<th>Changes</th>
<th>Time</th>
<th>User</th>
<th>Level</th>
</tr>
</thead>
<tbody>
{% for object in page.object_list %}
<tr {% if object.action == 'created' %}class="info"
{% elif object.action == 'deleted' %}class="error"
{% elif object.action == 'updated' %}class="warning"
{% endif %}>
<td>{{ forloop.counter0|add:page.start_index }}</td>
<td>{{ object.message }}</td>
<td>{{ object.get_object_model_name }}</td>
<td>
<ul>
{% for field, value in object.get_changes.items %}
<li><b>{{ field }}</b>: {{ value|default:'' }}</li>
{% endfor %}
</ul>
</td>
<td>{{ object.get_user }}</td>
<td>
<span class="badge
{% if object.level == object.LOG_LEVEL_CRITICAL or object.level == object.LOG_LEVEL_ERROR %}badge-danger
{% elif object.level == object.LOG_LEVEL_WARNING %}badge-warning
{% elif object.level == object.LOG_LEVEL_INFO %}badge-info
{% endif %}
"
>
{{ object.get_level_display }}
</span>
</td>
</tr>
{% endfor %}
</tbody>
</table>
Add additional fields (for example, "client")
import sw_logger.models
class Log(sw_logger.models.Log):
client = models.ForeignKey(Client, db_index=True, null=True)Create customize handler (for example, for automatical filling client-field in log model)
from sw_logger.handlers import DbHandler as BaseDbHandler
class DbHandler(BaseDbHandler):
@staticmethod
def get_log_model():
from core import models
return models.Log
def _emit_extra(self, log, record):
from core import models
if not hasattr(record, 'object'):
return
if hasattr(record, 'client'):
log.client = record.object
elif isinstance(record.object, models.Client):
log.client = record.object
elif hasattr(record.object, 'client') and isinstance(record.object.client, models.Client):
log.client = record.object.clientAdd handler in settings
LOGGING = {
...
'handlers': {
'db': {
'level': 'INFO',
'class': 'core.handlers.DbHandler',
},
},
'loggers': {
'db': {
'handlers': ['db'],
'level': 'INFO',
}
}
}Migrations
./manage.py makemigrations core
./manage.py migrate core
Form
import sw_logger.forms
class Log(sw_logger.forms.Log):
client = forms.ModelChoicesField(...)Filters
from core import models
import sw_logger.filters
class Log(sw_logger.filters.Log):
class Meta:
model = models.Log
fields = sw_logger.filters.Log.Meta.fields + ['client']View
from core import forms
from core import models
from core import filters
import sw_logger.views
class Log(sw_logger.views.Log):
template_name = 'core/report/log.html'
form_class = forms.Log
model = models.Log
filter_class = filters.LogAdmin
from core import models
from django.contrib import admin
import sw_logger.admin
@admin.register(models.Log)
class Log(sw_logger.admin.Log):
pass
