Merge pull request #2 from fearlessspider/develop

Develop

Author: fearless-spider

.pypirc

@@ -1,4 +1,4 @@
-[disutils]
+[distutils]
 index-servers =
     pypi
 

Makefile

@@ -0,0 +1,63 @@
+PROJECT_NAME = django_logger
+SHELL := /bin/sh
+help:
+	@echo "Please use 'make <target>' where <target> is one of"
+	@echo "  all                      to setup the whole development environment for the project"
+	@echo "  env                      to create the virtualenv for the project"
+	@echo "  setup_dev                install the requirements to the virtualenv"
+	@echo "  migrations               create new migrations"
+	@echo "  migrate                  update database with latest changes"
+	@echo "  run_dev                  start the development server"
+	@echo "  docs                  compile documentation"
+	@echo "  clean                  clean environment"
+
+HERE = $(shell pwd)
+VENV = $(HERE)/venv
+BIN = $(VENV)/bin
+PYTHON = $(BIN)/python3
+VIRTUALENV = python3 -m venv
+MAKE = make
+
+.PHONY: all test docs
+
+dev: all setup_dev migrate
+
+all: clean env
+
+env:
+	$(VIRTUALENV) $(VENV)
+
+clean:
+	rm -rf $(VENV)
+	rm -rf build
+	rm -rf dist
+	find . -name "*.pyc" -exec rm -rf {} \;
+
+test_dependencies:
+	$(BIN)/pip3 install -e ".[tests]"
+
+test: test_dependencies
+	$(BIN)/tox
+
+docs_depedencies:
+	$(BIN)/pip3 install -e ".[docs]"
+
+docs: docs_depedencies
+	cd docs && $(MAKE) html SPHINXBUILD=$(VENV)/bin/sphinx-build
+
+run_dev: setup_dev
+	$(PYTHON) django_logger_project/manage.py
+
+setup_dev:
+	$(BIN)/pip3 install -e ".[dev]"
+
+migrations:
+	$(PYTHON) makemigrations.py
+
+migrate:
+	$(PYTHON) migrate.py
+
+twine:
+	$(PYTHON) setup.py sdist
+	$(PYTHON) setup.py bdist_wheel
+	$(BIN)/twine upload dist/*

README.md

@@ -6,6 +6,13 @@ Log exceptions, errors and user activity for Django
 
 > INSTALLED_APPS = [ ... 'django_logger', ]
 
-2. Run python manage.py migrate to create the django_logger models.
+2. Add 'django_logger.middleware.RequestLoggingMiddleware' to your MIDDLEWARE setting like this::
+   
+> MIDDLEWARE = [
+    ...,
+    'django_logger.middleware.RequestLoggingMiddleware',
+    ]
+
+3. Run python manage.py migrate to create the django_logger models.
 
 4. Visit http://127.0.0.1:8000/admin/ to see logs.

boot_django.py

@@ -9,6 +9,7 @@
 
 def boot_django():
     settings.configure(
+        DJANGO_LOGGER_APPLICATION="DJANGO LOGGER",
         BASE_DIR=BASE_DIR,
         DEBUG=True,
         DATABASES={

django_logger/admin.py

@@ -1,10 +1,10 @@
 from django.contrib import admin
 from django.utils.translation import gettext_lazy as _
 
-from django_logger.models import LogRecord, RemoteRequestLog, ActionLog
+from django_logger.models import Event, Remote, Action
 
 
-class LogRecordAdmin(admin.ModelAdmin):
+class EventAdmin(admin.ModelAdmin):
     list_display = ('timestamp', 'application', 'origin_server', 'client_ip', 'username', 'logger', 'level', 'message')
     list_filter = ('application', 'origin_server', 'username', 'logger', 'level')
     search_fields = ('application', 'origin_server', 'client_ip', 'username', 'logger', 'level', 'message')
@@ -52,18 +52,18 @@ class LogRecordAdmin(admin.ModelAdmin):
     )
 
 
-class RemoteRequestLogAdmin(admin.ModelAdmin):
+class RemoteAdmin(admin.ModelAdmin):
     list_display = ('timestamp', 'status_code')
     list_filter = ('timestamp', 'status_code')
     search_fields = ('request', 'response', 'status_code')
 
 
-class ActionLogAdmin(admin.ModelAdmin):
+class ActionAdmin(admin.ModelAdmin):
     list_display = ('timestamp', 'user_username', 'action', 'object_text')
     list_filter = ('user_username', 'section', 'action')
     search_fields = ('user_username', 'section', 'action', 'object_text')
 
 
-admin.site.register(LogRecord, LogRecordAdmin)
-admin.site.register(RemoteRequestLog, RemoteRequestLogAdmin)
-admin.site.register(ActionLog, ActionLogAdmin)
+admin.site.register(Event, EventAdmin)
+admin.site.register(Remote, RemoteAdmin)
+admin.site.register(Action, ActionAdmin)

django_logger/handlers.py

@@ -10,7 +10,7 @@
 from django.urls import reverse
 
 from django_logger.middleware import RequestLoggingMiddleware
-from django_logger.models import LogRecord
+from django_logger.models import Event
 
 
 class ExceptionLoggingHandler(logging.Handler):
@@ -21,7 +21,7 @@ class ExceptionLoggingHandler(logging.Handler):
 
     def get_debug_page(self, record, request):
         """
-        Given a logging.LogRecord and a Django request that encountered an
+        Given a django_logger.Event and a Django request that encountered an
         exception, create a Django server error debugging page.
         """
 
@@ -36,7 +36,7 @@ def get_debug_page(self, record, request):
 
     def get_stack_trace(self, record, request):
         """
-        Given a logging.LogRecord and a Django request that encountered an
+        Given a django_logger.Event and a Django request that encountered an
         exception, collect a stack trace.
         """
 
@@ -65,14 +65,11 @@ def emit(self, record):
         static_path = getattr(settings, "STATIC_ROOT", "")
 
         stack_trace = self.get_stack_trace(record, request)
-        millis = int(round(time.time() * 1000))
-        # file = open(static_path + "/../logs/" + str(millis) + ".html", "w")
-        # file.write(stack_trace)
-        # file.close()
-        #debug_page = self.get_debug_page(record, request)
+        debug_page = self.get_debug_page(record, request)
 
 
-        LogRecord.objects.create(
+        Event.objects.create(
+            application=settings.DJANGO_LOGGER_APPLICATION,
             logger=record.name,
             level=record.levelname,
             message=record.msg,
@@ -81,8 +78,7 @@ def emit(self, record):
             username=getattr(record, "username", "?"),
             user_pk=getattr(record, "user_pk", None),
             stack_trace=stack_trace,
-            # debug_page=debug_page // Need Handle Polish Unicode Characters
-            debug_page=''
+            debug_page=debug_page
         )
 
 
@@ -120,9 +116,7 @@ def emit(self, record):
         if record.exc_info:
             stack_trace = self.get_stack_trace(record, request)
 
-        # GOD DAMMIT CHARS
-        # message = u"%s\n\n%s" % (request_link, stack_trace)
-        message = ''
+        message = u"%s\n\n%s" % (request_link, stack_trace)
 
         mail.mail_admins(
             subject,

django_logger/locale/ en/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2021-03-06 18:35+0100\n"
+"POT-Creation-Date: 2021-03-07 13:41+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -33,89 +33,89 @@ msgstr ""
 msgid "Exception details"
 msgstr ""
 
-#: django_logger/models.py:57
+#: django_logger/models.py:52
 msgid "The application logging this record."
 msgstr ""
 
-#: django_logger/models.py:63
+#: django_logger/models.py:58
 msgid "The server logging this record."
 msgstr ""
 
-#: django_logger/models.py:70
+#: django_logger/models.py:65
 msgid "The IP address of the client making the request."
 msgstr ""
 
-#: django_logger/models.py:79 django_logger/models.py:190
+#: django_logger/models.py:74 django_logger/models.py:173
 msgid ""
 "The primary key of the user making the request in which this record was "
 "logged."
 msgstr ""
 
-#: django_logger/models.py:84 django_logger/models.py:196
+#: django_logger/models.py:79 django_logger/models.py:179
 msgid ""
 "The username of the user making the request in which this record was logged."
 msgstr ""
 
-#: django_logger/models.py:91 django_logger/models.py:130
+#: django_logger/models.py:86 django_logger/models.py:122
 msgid "The UUID of the Django request in which this record was logged."
 msgstr ""
 
-#: django_logger/models.py:98
+#: django_logger/models.py:93
 msgid "The name of the logger of the record."
 msgstr ""
 
-#: django_logger/models.py:104
+#: django_logger/models.py:99
 msgid "The level of the log record (DEBUG, INFO...)"
 msgstr ""
 
-#: django_logger/models.py:158 django_logger/models.py:159
+#: django_logger/models.py:147 django_logger/models.py:148
 msgid "Console"
 msgstr ""
 
-#: django_logger/models.py:160
+#: django_logger/models.py:149
 msgid "Admin"
 msgstr ""
 
-#: django_logger/models.py:172
+#: django_logger/models.py:159
 msgid "Log In"
 msgstr ""
 
-#: django_logger/models.py:173
+#: django_logger/models.py:160
 msgid "Log Out"
 msgstr ""
 
-#: django_logger/models.py:174
+#: django_logger/models.py:161
 msgid "Change Password"
 msgstr ""
 
-#: django_logger/models.py:175
+#: django_logger/models.py:162
 msgid "User Update"
 msgstr ""
 
-#: django_logger/models.py:176
+#: django_logger/models.py:163
 msgid "User Delete"
 msgstr ""
 
-#: django_logger/models.py:209
+#: django_logger/models.py:190
 msgid "The Backend/APP section in which this record was logged."
 msgstr ""
 
-#: django_logger/models.py:216
+#: django_logger/models.py:197
 msgid "The Backend/APP action in which this record was logged."
 msgstr ""
 
-#: django_logger/models.py:224
+#: django_logger/models.py:203
 msgid "The primary key of the object in which this record was logged."
 msgstr ""
 
-#: django_logger/models.py:231
+#: django_logger/models.py:210
 msgid "The name or definition of the object in which this record was logged."
 msgstr ""
 
-#: django_logger/models.py:242
+#: django_logger/models.py:219
 msgid "The previous value when this record was logged."
 msgstr ""
 
-#: django_logger/models.py:247
+#: django_logger/models.py:224
 msgid "The current value when this record was logged."
 msgstr ""