pilot-platform-common 1.0.2__tar.gz → 2.2.0__tar.gz

{pilot-platform-common-1.0.2 → pilot_platform_common-2.2.0}/PKG-INFO

@@ -1,18 +1,30 @@
 Metadata-Version: 2.1
 Name: pilot-platform-common
-Version: 1.0.2
+Version: 2.2.0
 Summary: Generates entity ID and connects with Vault (secret engine) to retrieve credentials
 Author: Indoc Systems
 Author-email: etaylor@indocresearch.org
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+Requires-Dist: python-dotenv>=0.19.1
+Requires-Dist: httpx<0.27.0,>=0.23.0
+Requires-Dist: redis<5.0.0,>=4.5.0
+Requires-Dist: aioboto3==9.6.0
+Requires-Dist: xmltodict==0.13.0
+Requires-Dist: minio==7.1.8
+Requires-Dist: python-json-logger==2.0.2
+Requires-Dist: pyjwt==2.6.0
+Requires-Dist: starlette<0.38.0,>=0.37.2
+Requires-Dist: requests<2.32.0,>=2.26.0
+Requires-Dist: cryptography==39.0.0
+Requires-Dist: pydantic<3.0.0,>=2.7.1
 
 # common
 
 [![Run Tests](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml/badge.svg?branch=develop)](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml)
-[![Python](https://img.shields.io/badge/python-3.8-brightgreen.svg)](https://www.python.org/)
+[![Python](https://img.shields.io/badge/python-3.10-brightgreen.svg)](https://www.python.org/)
 [![PyPI](https://img.shields.io/pypi/v/pilot-platform-common.svg)](https://pypi.org/project/pilot-platform-common/)
 
 Importable package responsible for cross-service tasks within the Pilot Platform (e.g. logging, Vault connection, etc.).

{pilot-platform-common-1.0.2 → pilot_platform_common-2.2.0}/README.md

@@ -1,7 +1,7 @@
 # common
 
 [![Run Tests](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml/badge.svg?branch=develop)](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml)
-[![Python](https://img.shields.io/badge/python-3.8-brightgreen.svg)](https://www.python.org/)
+[![Python](https://img.shields.io/badge/python-3.10-brightgreen.svg)](https://www.python.org/)
 [![PyPI](https://img.shields.io/pypi/v/pilot-platform-common.svg)](https://pypi.org/project/pilot-platform-common/)
 
 Importable package responsible for cross-service tasks within the Pilot Platform (e.g. logging, Vault connection, etc.).

{pilot-platform-common-1.0.2 → pilot_platform_common-2.2.0}/common/logging/logging.py

@@ -10,6 +10,8 @@ from collections.abc import Mapping
 from typing import Any
 from typing import Union
 
+from opentelemetry import trace
+
 AUDIT = logging.INFO + 5
 
 
@@ -19,12 +21,22 @@ class Logger(logging.Logger):
 
 
 class JsonFormatter(logging.Formatter):
-    """Convert LogRecord to json string."""
+    """Convert LogRecord to JSON string with trace and span IDs."""
 
     def format(self, record: logging.LogRecord) -> str:
+        # Get the current span
+        span = trace.get_current_span()
+
+        # Extract trace ID and span ID
+        span_context = span.get_span_context()
+        trace_id = format(span_context.trace_id, '032x') if span_context.is_valid else None
+        span_id = format(span_context.span_id, '016x') if span_context.is_valid else None
+        trace_enabled = span_context.trace_flags.sampled if span_context.trace_flags is not None else False
+
         asctime = dt.datetime.fromtimestamp(record.created, tz=dt.timezone.utc).isoformat()
         level = record.levelname
         logger = record.name
+        location = f'{record.filename}:{record.lineno}'
         message = record.getMessage()
         exc_info = None
         if record.exc_info:
@@ -38,9 +50,13 @@ class JsonFormatter(logging.Formatter):
                 'asctime': asctime,
                 'level': level,
                 'logger': logger,
+                'location': location,
                 'message': message,
                 'exc_info': exc_info,
                 'details': details,
+                'trace_id': trace_id,
+                'span_id': span_id,
+                'trace_enabled': trace_enabled,
             }
         )
 

{pilot-platform-common-1.0.2 → pilot_platform_common-2.2.0}/pilot_platform_common.egg-info/PKG-INFO

@@ -1,18 +1,30 @@
 Metadata-Version: 2.1
 Name: pilot-platform-common
-Version: 1.0.2
+Version: 2.2.0
 Summary: Generates entity ID and connects with Vault (secret engine) to retrieve credentials
 Author: Indoc Systems
 Author-email: etaylor@indocresearch.org
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+Requires-Dist: python-dotenv>=0.19.1
+Requires-Dist: httpx<0.27.0,>=0.23.0
+Requires-Dist: redis<5.0.0,>=4.5.0
+Requires-Dist: aioboto3==9.6.0
+Requires-Dist: xmltodict==0.13.0
+Requires-Dist: minio==7.1.8
+Requires-Dist: python-json-logger==2.0.2
+Requires-Dist: pyjwt==2.6.0
+Requires-Dist: starlette<0.38.0,>=0.37.2
+Requires-Dist: requests<2.32.0,>=2.26.0
+Requires-Dist: cryptography==39.0.0
+Requires-Dist: pydantic<3.0.0,>=2.7.1
 
 # common
 
 [![Run Tests](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml/badge.svg?branch=develop)](https://github.com/PilotDataPlatform/common/actions/workflows/run-tests.yml)
-[![Python](https://img.shields.io/badge/python-3.8-brightgreen.svg)](https://www.python.org/)
+[![Python](https://img.shields.io/badge/python-3.10-brightgreen.svg)](https://www.python.org/)
 [![PyPI](https://img.shields.io/pypi/v/pilot-platform-common.svg)](https://pypi.org/project/pilot-platform-common/)
 
 Importable package responsible for cross-service tasks within the Pilot Platform (e.g. logging, Vault connection, etc.).

{pilot-platform-common-1.0.2 → pilot_platform_common-2.2.0}/pyproject.toml

@@ -1,11 +1,11 @@
 [tool.poetry]
 name = "common"
-version = "1.0.2"
+version = "2.2.0"
 description = ""
 authors = ["Indoc Systems"]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.10"
 python-dotenv = ">=0.19.1"
 python-json-logger = ">= 0.1.11, <= 2.02"
 aioboto3 = "^9.6.0"
@@ -18,6 +18,8 @@ starlette = ">=0.37.2,<0.38.0"
 cryptography = "39.0.0"
 pydantic = "^2.7.1"
 requests = ">=2.26.0,<2.32.0"
+opentelemetry-instrumentation-fastapi = "^0.39b0"
+opentelemetry-sdk = "1.18.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "7.2.1"

{pilot-platform-common-1.0.2 → pilot_platform_common-2.2.0}/setup.py

@@ -11,7 +11,7 @@ long_description = (this_directory / 'README.md').read_text()
 
 setuptools.setup(
     name='pilot-platform-common',
-    version='1.0.2',
+    version='2.2.0',
     author='Indoc Systems',
     author_email='etaylor@indocresearch.org',
     description='Generates entity ID and connects with Vault (secret engine) to retrieve credentials',
@@ -22,7 +22,7 @@ setuptools.setup(
         'Programming Language :: Python :: 3',
         'Operating System :: OS Independent',
     ],
-    python_requires='>=3.9',
+    python_requires='>=3.10',
     install_requires=[
         'python-dotenv>=0.19.1',
         'httpx>=0.23.0,<0.27.0',

{pilot-platform-common-1.0.2 → pilot_platform_common-2.2.0}/tests/test_logging.py

@@ -8,6 +8,11 @@ import logging
 from logging import LogRecord
 from logging import getLevelName
 
+from opentelemetry import trace
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.sdk.trace.export import ConsoleSpanExporter
+
 from common.logging.logging import AUDIT
 from common.logging.logging import JsonFormatter
 from common.logging.logging import Logger
@@ -17,6 +22,12 @@ from common.logging.logging import extend_logger_class
 
 class TestJsonFormatter:
     def test_format_converts_log_record_into_expected_json_string(self, fake):
+        provider = TracerProvider()
+        processor = BatchSpanProcessor(ConsoleSpanExporter())
+        provider.add_span_processor(processor)
+        trace.set_tracer_provider(provider)
+        tracer = trace.get_tracer('test.format.logging')
+
         logger = fake.word()
         level = fake.pyint(0, 5) * 10
         message = fake.word()
@@ -24,20 +35,32 @@ class TestJsonFormatter:
         exception = Exception(exception_message)
         exc_info = (type(exception), exception, exception.__traceback__)
         details = fake.pydict(allowed_types=(str, int, float, bool))
-        record = LogRecord(logger, level, '', 0, message, details, exc_info)
+        record = LogRecord(logger, level, 'test.py', 0, message, details, exc_info)
         asctime = dt.datetime.fromtimestamp(record.created, tz=dt.timezone.utc).isoformat()
-        expected_string = json.dumps(
-            {
-                'asctime': asctime,
-                'level': getLevelName(level),
-                'logger': logger,
-                'message': message,
-                'exc_info': f'Exception: {exception_message}',
-                'details': details,
-            }
-        )
-
-        received_string = JsonFormatter().format(record)
+        with tracer.start_as_current_span('test-log-record-format') as span:
+            span_context = span.get_span_context()
+            trace_id = format(span_context.trace_id, '032x') if span_context.is_valid else None
+            span_id = format(span_context.span_id, '016x') if span_context.is_valid else None
+            trace_enabled = span_context.trace_flags.sampled if span_context.trace_flags is not None else False
+            expected_string = json.dumps(
+                {
+                    'asctime': asctime,
+                    'level': getLevelName(level),
+                    'logger': logger,
+                    'location': 'test.py:0',
+                    'message': message,
+                    'exc_info': f'Exception: {exception_message}',
+                    'details': details,
+                    'trace_id': trace_id,
+                    'span_id': span_id,
+                    'trace_enabled': trace_enabled,
+                }
+            )
+            received_string = JsonFormatter().format(record)
+        trace.get_tracer_provider().shutdown()
+        # Normalize newlines by replacing them with `\\n` in both strings for comparison
+        expected_string = expected_string.replace('\n', '\\n')
+        received_string = received_string.replace('\n', '\\n')
 
         assert received_string == expected_string