fixed #101 logging

django_tenants/log.py

@@ -0,0 +1,14 @@
+import logging
+
+from django.db import connection
+
+
+class TenantContextFilter(logging.Filter):
+    """
+    Add the current ``schema_name`` and ``domain_url`` to log records.
+    Thanks to @regolith for the snippet on https://github.com/bernardopires/django-tenant-schemas/issues/248
+    """
+    def filter(self, record):
+        record.schema_name = connection.tenant.schema_name
+        record.domain_url = getattr(connection.tenant, 'domain_url', '')
+        return True

django_tenants/middleware.py

@@ -31,7 +31,10 @@ def process_request(self, request):
 
         domain = get_object_or_404(get_tenant_domain_model().objects.select_related('tenant'),
                                    domain=hostname)
+
+        domain.tenant.domain_url = hostname
         request.tenant = domain.tenant
+
         connection.set_tenant(request.tenant)
 
         # Content type can no longer be cached as public and tenant schemas

docs/use.rst

@@ -196,6 +196,40 @@ The hook for ensuring the ``search_path`` is set properly happens inside the ``D
 When set, ``django-tenants`` will set the search path only once per request. The default is ``False``.
 
 
+Logging
+-------
+
+The optional ``TenantContextFilter`` can be included in ``settings.LOGGING`` to add the current ``schema_name`` and ``domain_url`` to the logging context.
+
+.. code-block:: python
+
+    # settings.py
+    LOGGING = {
+        'filters': {
+            'tenant_context': {
+                '()': 'django_tenants.log.TenantContextFilter'
+            },
+        },
+        'formatters': {
+            'tenant_context': {
+                'format': '[%(schema_name)s:%(domain_url)s] '
+                '%(levelname)-7s %(asctime)s %(message)s',
+            },
+        },
+        'handlers': {
+            'console': {
+                'filters': ['tenant_context'],
+            },
+        },
+    }
+
+This will result in logging output that looks similar to:
+
+.. code-block:: text
+
+    [example:example.com] DEBUG 13:29 django.db.backends: (0.001) SELECT ...
+
+
 Running in Development
 ----------------------