django-log-formatter-asim 0.0.5__tar.gz → 1.0.0__tar.gz

{django_log_formatter_asim-0.0.5 → django_log_formatter_asim-1.0.0}/PKG-INFO

@@ -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-0.0.5 → django_log_formatter_asim-1.0.0}/README.md

@@ -120,3 +120,36 @@ If you wish to create your own ASIM formatter, you can inherit from ASIMSystemFo
 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-0.0.5 → django_log_formatter_asim-1.0.0}/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 → django_log_formatter_asim-1.0.0}/pyproject.toml

@@ -3,7 +3,7 @@ line-length = 100
 
 [tool.poetry]
 name = "django-log-formatter-asim"
-version = "0.0.5"
+version = "1.0.0"
 description = "Formats Django logs in ASIM format."
 authors = ["Department for Business and Trade Platform Team <sre-team@digital.trade.gov.uk>"]
 license = "MIT"
@@ -19,6 +19,7 @@ django = [
     { version = ">=3,<5", python = ">=3.9,<3.10" },
     { version = ">=3,<6", python = ">=3.10,<4" },
 ]
+ddtrace = "^3.2.1"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.5.0"