django-log-formatter-asim 1.1.0a3__py3-none-any.whl → 1.1.0a4__py3-none-any.whl

django_log_formatter_asim/__init__.py

@@ -1,6 +1,5 @@
 import json
 import logging
-import os
 from datetime import datetime
 from datetime import timezone
 from importlib.metadata import distribution
@@ -9,6 +8,8 @@ import ddtrace
 from ddtrace.trace import tracer
 from django.conf import settings
 
+from .ecs import _get_container_id
+
 
 class ASIMRootFormatter:
     def __init__(self, record):
@@ -29,19 +30,6 @@ class ASIMRootFormatter:
 
         return copied_dict
 
-    def _get_container_id(self):
-        """
-        The dockerId (container Id) is available via the metadata endpoint. However, it looks like it is embedded in the
-        metadata URL e.g.:
-        ECS_CONTAINER_METADATA_URI=http://169.254.170.2/v3/709d1c10779d47b2a84db9eef2ebd041-0265927825
-        See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4-response.html
-        """
-
-        try:
-            return os.environ["ECS_CONTAINER_METADATA_URI"].split("/")[-1]
-        except (KeyError, IndexError):
-            return ""
-
     def _get_first_64_bits_of(self, trace_id):
         # See https://docs.datadoghq.com/tracing/other_telemetry/connect_logs_and_traces/python/#no-standard-library-logging
         return str((1 << 64) - 1 & trace_id)
@@ -65,7 +53,7 @@ class ASIMRootFormatter:
         event_dict["service"] = ddtrace.config.service or ""
         event_dict["version"] = ddtrace.config.version or ""
 
-        event_dict["container_id"] = self._get_container_id()
+        event_dict["container_id"] = _get_container_id()
 
         return event_dict
 

django_log_formatter_asim/ecs.py

@@ -0,0 +1,16 @@
+import os
+
+
+def _get_container_id():
+    """
+    The dockerId (container Id) is available via the metadata endpoint.
+
+    However, it looks like it is embedded in the metadata URL e.g.:
+    ECS_CONTAINER_METADATA_URI=http://169.254.170.2/v3/709d1c10779d47b2a84db9eef2ebd041-0265927825
+    See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4-response.html
+    """
+
+    try:
+        return os.environ["ECS_CONTAINER_METADATA_URI"].split("/")[-1]
+    except (KeyError, IndexError):
+        return ""

django_log_formatter_asim/events/authentication.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+import os
 from enum import Enum
 from typing import Literal
 from typing import Optional
@@ -7,6 +8,8 @@ from typing import TypedDict
 
 from django.http import HttpRequest
 
+from django_log_formatter_asim.ecs import _get_container_id
+
 from .common import Client
 from .common import Result
 from .common import Server
@@ -51,12 +54,6 @@ class AuthenticationUser(TypedDict):
     """
     username: Optional[str]
     """
-    Email address for the user if one exists.
-
-    Defaults to the logged in Django User.email if not provided.
-    """
-    email: Optional[str]
-    """
     A unique identifier for this authentication session if one exists.
 
     Defaults to the Django Sessions session key if not provided.
@@ -86,7 +83,7 @@ def log_authentication(
                         - Django Session middlewares Session Key
                         - Client IP address
                         - URL requested by the client
-                        - Server hostname
+                        - Server domain name
     :param event: What authentication action was attempted, either "Logon" or "Logoff"
     :param result: What outcome did the action have, either "Success", "Failure", "Partial", "NA"
     :param login_method: What authentication mechanism was being used, one of:
@@ -132,10 +129,19 @@ def log_authentication(
         "EventSchemaVersion": "0.1.4",
     }
 
-    if "hostname" in server:
-        log["DvcHostname"] = server["hostname"]
+    if "domain_name" in server:
+        log["HttpHost"] = server["domain_name"]
     elif "HTTP_HOST" in request.META:
-        log["DvcHostname"] = request.get_host()
+        log["HttpHost"] = request.get_host()
+
+    if "service_name" in server:
+        log["TargetAppName"] = server["service_name"]
+    elif os.environ.get("COPILOT_APPLICATION_NAME") and os.environ.get("COPILOT_SERVICE_NAME"):
+        app_name = f"{os.environ['COPILOT_APPLICATION_NAME']}-{os.environ['COPILOT_SERVICE_NAME']}"
+        log["TargetAppName"] = app_name
+
+    if container_id := _get_container_id():
+        log["ContainerId"] = container_id
 
     if "ip_address" in client:
         log["SrcIpAddr"] = client["ip_address"]
@@ -148,23 +154,18 @@ def log_authentication(
         log["TargetUrl"] = request.scheme + "://" + request.get_host() + request.get_full_path()
 
     if "role" in user:
-        log["ActorUserType"] = user["role"]
+        log["TargetUserType"] = user["role"]
 
     if "sessionId" in user:
-        log["ActorSessionId"] = user["sessionId"]
+        log["TargetSessionId"] = user["sessionId"]
     elif request.session.session_key:
-        log["ActorSessionId"] = request.session.session_key
+        log["TargetSessionId"] = request.session.session_key
 
     if "username" in user:
         log["TargetUsername"] = user["username"]
     elif hasattr(request, "user") and request.user.username:
         log["TargetUsername"] = request.user.username
 
-    if "email" in user:
-        log["ActorUsername"] = user["email"]
-    elif hasattr(request, "user") and hasattr(request.user, "email") and request.user.email:
-        log["ActorUsername"] = request.user.email
-
     if result_details:
         log["EventResultDetails"] = result_details
 

django_log_formatter_asim/events/common.py

@@ -33,13 +33,22 @@ class Server(TypedDict):
     """Dictionary to represent properties of the HTTP Server."""
 
     """
-    A unique identifier for the server which serviced the Authentication event.
+    The FQDN that this server is listening to HTTP requests on. For example:
+        web.trade.gov.uk
 
     Defaults to the WSGI HTTP_HOST field if not provided.
     """
-    hostname: Optional[str]
+    domain_name: Optional[str]
     """Internet Protocol Address of the server serving this request."""
     ip_address: Optional[str]
+    """
+    A unique (within DBT) identifier for the software running on the server.
+    For example: berry-auctions-frontend
+
+    Defaults to combining the environment variables COPILOT_APPLICATION_NAME and
+    COPILOT_SERVICE_NAME separated by a '-'.
+    """
+    service_name: Optional[str]
 
 
 def _default_severity(result: Result) -> Severity:

django_log_formatter_asim/events/file_activity.py

@@ -7,6 +7,8 @@ from typing import TypedDict
 
 from django.http import HttpRequest
 
+from django_log_formatter_asim.ecs import _get_container_id
+
 from .common import Client
 from .common import Result
 from .common import Server
@@ -94,7 +96,7 @@ def log_file_activity(
                         - Django Authentication systems current username
                         - Client IP address
                         - URL requested by the client
-                        - Server hostname
+                        - Server domain name
     :param event: What File Event action was attempted, one of:
                         - FileAccessed
                         - FileCreated
@@ -167,10 +169,19 @@ def log_file_activity(
     if "size" in file:
         log["TargetFileSize"] = file["size"]
 
-    if "hostname" in server:
-        log["DvcHostname"] = server["hostname"]
+    if "domain_name" in server:
+        log["HttpHost"] = server["domain_name"]
     elif "HTTP_HOST" in request.META:
-        log["DvcHostname"] = request.get_host()
+        log["HttpHost"] = request.get_host()
+
+    if "service_name" in server:
+        log["TargetAppName"] = server["service_name"]
+    elif os.environ.get("COPILOT_APPLICATION_NAME") and os.environ.get("COPILOT_SERVICE_NAME"):
+        app_name = f"{os.environ['COPILOT_APPLICATION_NAME']}-{os.environ['COPILOT_SERVICE_NAME']}"
+        log["TargetAppName"] = app_name
+
+    if container_id := _get_container_id():
+        log["ContainerId"] = container_id
 
     if "ip_address" in client:
         log["SrcIpAddr"] = client["ip_address"]
@@ -184,7 +195,7 @@ def log_file_activity(
 
     if "username" in user:
         log["TargetUsername"] = user["username"]
-    elif request.user.username:
+    elif hasattr(request, "user") and request.user.username:
         log["TargetUsername"] = request.user.username
 
     if result_details:

{django_log_formatter_asim-1.1.0a3.dist-info → django_log_formatter_asim-1.1.0a4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-log-formatter-asim
-Version: 1.1.0a3
+Version: 1.1.0a4
 Summary: Formats Django logs in ASIM format.
 License: MIT
 Author: Department for Business and Trade Platform Team

django_log_formatter_asim-1.1.0a4.dist-info/RECORD

@@ -0,0 +1,10 @@
+django_log_formatter_asim/__init__.py,sha256=ftbSWdejSnWK_MpT3RSfTgcs3E-661FM-e3ugnoiBqA,7133
+django_log_formatter_asim/ecs.py,sha256=SSg3A5pfS5E-Hm7AXQnN1RrtXclgq07oSBxPCRn5gDg,536
+django_log_formatter_asim/events/__init__.py,sha256=th8AEFNM-J5lNlO-d8Lk465jXqplE3IoTwj4DlscwYo,92
+django_log_formatter_asim/events/authentication.py,sha256=IjGTPb8Ucky-NtHGFe2CLwER-57lnMYoemjswWJE8Jk,6985
+django_log_formatter_asim/events/common.py,sha256=9LeiEn11FJowf2QiI5MLXlGIbY4MVRChABVcfchX8ko,1676
+django_log_formatter_asim/events/file_activity.py,sha256=fSNXWCr0De6EZDfoz-JQgQMQce4Wf9Kn2XeUPHW7oI0,7471
+django_log_formatter_asim-1.1.0a4.dist-info/LICENSE,sha256=dP79lN73--7LMApnankTGLqDbImXg8iYFqWgnExGkGk,1090
+django_log_formatter_asim-1.1.0a4.dist-info/METADATA,sha256=ygNuO5M_cSJoctnfCzAI6J4N8miKlpbeaEliD3ubmxs,5581
+django_log_formatter_asim-1.1.0a4.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+django_log_formatter_asim-1.1.0a4.dist-info/RECORD,,

django_log_formatter_asim-1.1.0a3.dist-info/RECORD

@@ -1,9 +0,0 @@
-django_log_formatter_asim/__init__.py,sha256=LDQQch2GKY6LRj-KOME393FCiwjisQ49ATWBEqAP4ZA,7684
-django_log_formatter_asim/events/__init__.py,sha256=th8AEFNM-J5lNlO-d8Lk465jXqplE3IoTwj4DlscwYo,92
-django_log_formatter_asim/events/authentication.py,sha256=OxWztyvgaIXRZm-ake_OrxVXoH4NVMW1PaWZQi67UN8,6863
-django_log_formatter_asim/events/common.py,sha256=YJ_t6nXShoMwgqgezUzi1f5qA-8J5DcBJWTqwbdZehs,1358
-django_log_formatter_asim/events/file_activity.py,sha256=Re51ZOrcy1k62bORruPwCTdhuQqExbN_OtZ9UuCgDBE,6967
-django_log_formatter_asim-1.1.0a3.dist-info/LICENSE,sha256=dP79lN73--7LMApnankTGLqDbImXg8iYFqWgnExGkGk,1090
-django_log_formatter_asim-1.1.0a3.dist-info/METADATA,sha256=3ivJhQmrP7al1vvMKK-zQX2iBiLX56nek4sLCUR9E1A,5581
-django_log_formatter_asim-1.1.0a3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-django_log_formatter_asim-1.1.0a3.dist-info/RECORD,,