django-log-formatter-asim 0.0.5__py3-none-any.whl → 1.0.0__py3-none-any.whl

django_log_formatter_asim/__init__.py

@@ -2,7 +2,10 @@ import json
 import logging
 from datetime import datetime
 from importlib.metadata import distribution
+import os
 
+import ddtrace
+from ddtrace.trace import tracer
 from django.conf import settings
 
 
@@ -25,6 +28,46 @@ 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)
+
+    def _datadog_trace_dict(self):
+        event_dict = {}
+
+        span = tracer.current_span()
+        trace_id, span_id = (
+            (self._get_first_64_bits_of(span.trace_id), span.span_id)
+            if span
+            else (None, None)
+        )
+
+        # add ids to structlog event dictionary
+        event_dict["dd.trace_id"] = str(trace_id or 0)
+        event_dict["dd.span_id"] = str(span_id or 0)
+
+        # add the env, service, and version configured for the tracer
+        event_dict["env"] = ddtrace.config.env or ""
+        event_dict["service"] = ddtrace.config.service or ""
+        event_dict["version"] = ddtrace.config.version or ""
+
+        event_dict["container_id"] = self._get_container_id()
+
+        return event_dict
+
     def get_log_dict(self):
         record = self.record
         log_time = datetime.utcfromtimestamp(record.created).isoformat()
@@ -48,6 +91,8 @@ class ASIMRootFormatter:
             },
         }
 
+        log_dict.update(self._datadog_trace_dict())
+
         if getattr(settings, "DLFA_INCLUDE_RAW_LOG", False):
             return self.get_log_dict_with_raw(log_dict)
 

{django_log_formatter_asim-0.0.5.dist-info → django_log_formatter_asim-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: django-log-formatter-asim
-Version: 0.0.5
+Version: 1.0.0
 Summary: Formats Django logs in ASIM format.
 License: MIT
 Author: Department for Business and Trade Platform Team
@@ -12,7 +12,9 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: django (>=3,<5) ; python_version >= "3.9" and python_version < "3.10"
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: ddtrace (>=3.2.1,<4.0.0)
+Requires-Dist: django (>=3,<5) ; python_version == "3.9"
 Requires-Dist: django (>=3,<6) ; python_version >= "3.10" and python_version < "4"
 Requires-Dist: pre-commit (>=3.5.0,<4.0.0)
 Description-Content-Type: text/markdown
@@ -140,3 +142,35 @@ Run `poetry run pytest` in the root directory to run all tests.
 
 Or, run `poetry run tox` in the root directory to run all tests for multiple Python versions. See the [`tox` configuration file](tox.ini).
 
+### Publishing
+
+1. Acquire API token from [Passman](https://passman.ci.uktrade.digital/secret/cc82a3f7-ddfa-4312-ab56-1ff8528dadc8/).
+   - Request access from the SRE team.
+   - _Note: You will need access to the `platform` group in Passman._
+2. Run `poetry config pypi-token.pypi <token>` to add the token to your Poetry configuration.
+
+Update the version, as the same version cannot be published to PyPI.
+
+```
+poetry version patch
+```
+
+More options for the `version` command can be found in the [Poetry documentation](https://python-poetry.org/docs/cli/#version). For example, for a minor version bump: `poetry version minor`.
+
+Build the Python package.
+
+```
+poetry build
+```
+
+Publish the Python package.
+
+_Note: Make sure your Pull Request (PR) is approved and contains the version upgrade in `pyproject.toml` before publishing the package._
+
+```
+poetry publish
+```
+
+Check the [PyPI Release history](https://pypi.org/project/django-log-formatter-asim/#history) to make sure the package has been updated.
+
+For an optional manual check, install the package locally and test everything works as expected.

django_log_formatter_asim-1.0.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+django_log_formatter_asim/__init__.py,sha256=i-7HqYE5s3hjmHLh4TTzLpEdgr5N22msFEQw16Pe_EI,7867
+django_log_formatter_asim-1.0.0.dist-info/LICENSE,sha256=dP79lN73--7LMApnankTGLqDbImXg8iYFqWgnExGkGk,1090
+django_log_formatter_asim-1.0.0.dist-info/METADATA,sha256=Gmn92QLejMsh63aivEaeqLfOKfnGl-9Hw5MPO-YC5KQ,5576
+django_log_formatter_asim-1.0.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+django_log_formatter_asim-1.0.0.dist-info/RECORD,,

{django_log_formatter_asim-0.0.5.dist-info → django_log_formatter_asim-1.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 2.1.1
 Root-Is-Purelib: true
 Tag: py3-none-any

django_log_formatter_asim-0.0.5.dist-info/RECORD

@@ -1,5 +0,0 @@
-django_log_formatter_asim/__init__.py,sha256=xB7ESmQuHJ1XZJpXOdRIpdB9qra9b_Uc6es3FsgDlEc,6215
-django_log_formatter_asim-0.0.5.dist-info/LICENSE,sha256=dP79lN73--7LMApnankTGLqDbImXg8iYFqWgnExGkGk,1090
-django_log_formatter_asim-0.0.5.dist-info/METADATA,sha256=iwI4EBJpc7lQApvTjQ-y-B2tIK3kWo-a_WVPzhjEL18,4408
-django_log_formatter_asim-0.0.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-django_log_formatter_asim-0.0.5.dist-info/RECORD,,