fluidattacks-core 2.16.1__tar.gz → 3.0.0__tar.gz

{fluidattacks_core-2.16.1 → fluidattacks_core-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fluidattacks-core
-Version: 2.16.1
+Version: 3.0.0
 Summary: Fluid Attacks Core Library
 Author-email: Development <development@fluidattacks.com>
 License: MPL-2.0

fluidattacks_core-3.0.0/fluidattacks_core/logging/__init__.py

@@ -0,0 +1,44 @@
+import logging
+import logging.config
+import sys
+from types import TracebackType
+
+from fluidattacks_core.logging.presets import DATE_FORMAT, PRODUCT_LOGGING
+from fluidattacks_core.logging.types import JobMetadata
+from fluidattacks_core.logging.utils import get_job_metadata, set_telemetry_metadata
+
+
+def init_uncaught_exception_logging() -> None:
+    logger = logging.getLogger("unhandled")
+
+    def handle_uncaught_exception(
+        exception_type: type[BaseException],
+        msg: BaseException,
+        traceback: TracebackType | None,
+    ) -> None:
+        if issubclass(exception_type, KeyboardInterrupt):
+            sys.__excepthook__(exception_type, msg, traceback)
+            return
+
+        logger.critical(
+            "Uncaught exception",
+            exc_info=(exception_type, msg, traceback),
+        )
+
+    sys.excepthook = handle_uncaught_exception
+
+
+def init_logging() -> None:
+    logging.config.dictConfig(PRODUCT_LOGGING)
+    init_uncaught_exception_logging()
+
+
+__all__ = [
+    "DATE_FORMAT",
+    "PRODUCT_LOGGING",
+    "JobMetadata",
+    "get_job_metadata",
+    "init_logging",
+    "init_uncaught_exception_logging",
+    "set_telemetry_metadata",
+]

{fluidattacks_core-2.16.1 → fluidattacks_core-3.0.0}/fluidattacks_core/logging/filters.py

@@ -1,6 +1,6 @@
 import logging
 
-from fluidattacks_core.logging.utils import get_job_metadata, is_trunk_branch
+from fluidattacks_core.logging.utils import is_trunk_branch
 
 
 class NoProductionFilter(logging.Filter):
@@ -15,13 +15,3 @@ class ProductionOnlyFilter(logging.Filter):
 
     def filter(self, _record: logging.LogRecord) -> bool:
         return is_trunk_branch()
-
-
-class BatchOnlyFilter(logging.Filter):
-    def filter(self, _record: logging.LogRecord) -> bool:
-        return get_job_metadata().job_id is not None
-
-
-class NoBatchFilter(logging.Filter):
-    def filter(self, _record: logging.LogRecord) -> bool:
-        return get_job_metadata().job_id is None

{fluidattacks_core-2.16.1 → fluidattacks_core-3.0.0}/fluidattacks_core/logging/formatters.py

@@ -13,6 +13,8 @@ from fluidattacks_core.logging.utils import (
     get_pipeline_environment,
     get_pipeline_metadata,
     get_telemetry_metadata,
+    is_in_batch,
+    is_in_lambda,
 )
 
 # Main formats
@@ -101,19 +103,20 @@ class CustomJsonFormatter(JsonFormatter):
         """Add service information to the log record.
 
         It includes:
+        - Source
+        - Service
         - Version
-        - Product name
         """
         batch_info = get_job_metadata().job_queue
-        is_in_batch = get_job_metadata().job_id is not None
-        product_name = get_environment_metadata().product_id
-        service = f"{product_name}" + (f"/{batch_info}" if is_in_batch else "")
+        source = (
+            f"batch/{batch_info}" if is_in_batch() else "lambda" if is_in_lambda() else "python"
+        )
+        service = get_environment_metadata().product_id
         version = get_environment_metadata().version
 
-        log_record["dd.version"] = version
-        log_record["service.version"] = version
+        log_record["ddsource"] = source
         log_record["dd.service"] = service
-        log_record["service.name"] = service
+        log_record["dd.version"] = version
 
     def _add_deployment_fields(self, log_record: dict[str, Any]) -> None:
         """Add deployment information to the log record.

fluidattacks_core-3.0.0/fluidattacks_core/logging/presets.py

@@ -0,0 +1,29 @@
+from fluidattacks_core.logging.handlers import DebuggingHandler, ProductionSyncHandler
+
+# Main formats
+DATE_FORMAT = "%Y-%m-%dT%H:%M:%S%z"
+"""
+Default date format for logs.
+"""
+
+
+PRODUCT_LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "production_handler": {"()": ProductionSyncHandler},
+        "debugging_handler": {"()": DebuggingHandler},
+    },
+    "root": {
+        "handlers": ["production_handler", "debugging_handler"],
+        "level": "INFO",
+    },
+}
+"""
+Default logging configuration dict for all the products.
+
+Required environment variables:
+- `PRODUCT_ID`
+- `CI_COMMIT_REF_NAME`
+- `CI_COMMIT_SHA`
+"""

{fluidattacks_core-2.16.1 → fluidattacks_core-3.0.0}/fluidattacks_core/logging/utils.py

@@ -10,10 +10,20 @@ DEFAULT_TELEMETRY_METADATA = {}
 
 
 def is_trunk_branch() -> bool:
-    """Check if code is using the trunk branch."""
+    """Check if the code is using the trunk branch."""
     return os.environ.get("CI_COMMIT_REF_NAME", "default") == "trunk"
 
 
+def is_in_batch() -> bool:
+    """Check if the code is running in a batch environment."""
+    return os.environ.get("AWS_BATCH_JOB_ID") is not None
+
+
+def is_in_lambda() -> bool:
+    """Check if the code is running in an AWS Lambda function."""
+    return os.environ.get("AWS_LAMBDA_FUNCTION_NAME") is not None
+
+
 def get_job_metadata() -> JobMetadata:
     """Get the job metadata for applications running in batch environments."""
     return JobMetadata(
@@ -26,7 +36,9 @@ def get_job_metadata() -> JobMetadata:
 def get_environment_metadata() -> EnvironmentMetadata:
     """Get the environment metadata for applications."""
     environment = "production" if is_trunk_branch() else "development"
-    product_id = os.environ.get("PRODUCT_ID", "universe")
+    product_id = (
+        os.environ.get("AWS_LAMBDA_FUNCTION_NAME") or os.environ.get("PRODUCT_ID") or "universe"
+    )
     commit_sha = os.environ.get("CI_COMMIT_SHA", "00000000")
     commit_short_sha = commit_sha[:8]
 

{fluidattacks_core-2.16.1 → fluidattacks_core-3.0.0}/fluidattacks_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fluidattacks-core
-Version: 2.16.1
+Version: 3.0.0
 Summary: Fluid Attacks Core Library
 Author-email: Development <development@fluidattacks.com>
 License: MPL-2.0

{fluidattacks_core-2.16.1 → fluidattacks_core-3.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fluidattacks-core"
-version = "2.16.1"
+version = "3.0.0"
 description = "Fluid Attacks Core Library"
 authors = [{ name = "Development", email = "development@fluidattacks.com" }]
 license = { text = "MPL-2.0" }

{fluidattacks_core-2.16.1 → fluidattacks_core-3.0.0}/test/test_logging.py

@@ -1,10 +1,10 @@
 import logging
-import logging.config
+import sys
 
 import pytest
 import simplejson as json
 
-from fluidattacks_core.logging import PRODUCT_LOGGING
+from fluidattacks_core.logging import init_logging
 from fluidattacks_core.logging.utils import set_telemetry_metadata
 
 
@@ -17,14 +17,23 @@ def _developer_setup(monkeypatch: pytest.MonkeyPatch) -> None:
 
 
 @pytest.mark.parametrize(
-    "product_id, job_id, queue_name, expected_service_name",  # noqa: PT006
+    "product_id, job_id, queue_name, lambda_name, expected_source, expected_service_name",  # noqa: PT006
     [
         # Interacts running in EC2
-        ("interacts", None, None, "interacts"),
+        ("interacts", None, None, None, "python", "interacts"),
         # Labels running in a Batch Job
-        ("labels", "111", "skims", "labels/skims"),
+        ("labels", "111", "skims", None, "batch/skims", "labels"),
         # Integrates scheduler running in a Batch Job
-        ("integrates", "111", "integrates_large", "integrates/integrates_large"),
+        ("integrates", "111", "integrates_large", None, "batch/integrates_large", "integrates"),
+        # Lambda function
+        (
+            None,
+            None,
+            None,
+            "integrates_streams_hooks",
+            "lambda",
+            "integrates_streams_hooks",
+        ),
     ],
 )
 def test_json_formatter_uses_envs_to_fill_keys(  # noqa: PLR0913
@@ -33,16 +42,21 @@ def test_json_formatter_uses_envs_to_fill_keys(  # noqa: PLR0913
     product_id: str,
     job_id: str,
     queue_name: str,
+    lambda_name: str,
+    expected_source: str,
     expected_service_name: str,
 ) -> None:
     _production_setup(monkeypatch)
-    monkeypatch.setenv("PRODUCT_ID", product_id)
+    if product_id is not None:
+        monkeypatch.setenv("PRODUCT_ID", product_id)
     if job_id is not None:
         monkeypatch.setenv("AWS_BATCH_JOB_ID", job_id)
     if queue_name is not None:
         monkeypatch.setenv("AWS_BATCH_JQ_NAME", queue_name)
+    if lambda_name is not None:
+        monkeypatch.setenv("AWS_LAMBDA_FUNCTION_NAME", lambda_name)
 
-    logging.config.dictConfig(PRODUCT_LOGGING)
+    init_logging()
     logger = logging.getLogger("product")
 
     logger.critical("A critical message")
@@ -50,17 +64,43 @@ def test_json_formatter_uses_envs_to_fill_keys(  # noqa: PLR0913
     output = capsys.readouterr()
     log_entry = json.loads(output.err)
 
-    assert log_entry["service.name"] == expected_service_name
+    assert log_entry["ddsource"] == expected_source
     assert log_entry["dd.service"] == expected_service_name
 
 
+def test_uncaught_exception_logging(
+    monkeypatch: pytest.MonkeyPatch,
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    _production_setup(monkeypatch)
+    monkeypatch.setenv("PRODUCT_ID", "universe")
+
+    init_logging()
+
+    error = ValueError("This is an uncaught exception")
+
+    # Simulate an uncaught exception
+    sys.excepthook(error.__class__, error, error.__traceback__)
+
+    output = capsys.readouterr()
+    log_entry = json.loads(output.err)
+
+    assert log_entry["ddsource"] == "python"
+    assert log_entry["dd.service"] == "universe"
+
+    assert log_entry["name"] == "unhandled"
+    assert log_entry["level"] == "CRITICAL"
+    assert log_entry["error.type"] == "ValueError"
+    assert log_entry["error.message"] == "This is an uncaught exception"
+
+
 def test_json_formatter_adds_keys_for_exception(
     monkeypatch: pytest.MonkeyPatch,
     capsys: pytest.CaptureFixture[str],
 ) -> None:
     _production_setup(monkeypatch)
 
-    logging.config.dictConfig(PRODUCT_LOGGING)
+    init_logging()
     logger = logging.getLogger("product")
 
     try:
@@ -86,7 +126,7 @@ def test_json_formatter_adds_keys_with_extra_fields(
 ) -> None:
     _production_setup(monkeypatch)
 
-    logging.config.dictConfig(PRODUCT_LOGGING)
+    init_logging()
     logger = logging.getLogger("product")
 
     logger.info("A info message", extra={"trace_id": "111", "span_id": "222", "other.tag": "val"})
@@ -105,7 +145,7 @@ def test_json_formatter_adds_telemetry_metadata(
 ) -> None:
     _production_setup(monkeypatch)
 
-    logging.config.dictConfig(PRODUCT_LOGGING)
+    init_logging()
     logger = logging.getLogger("product")
     set_telemetry_metadata({"trace_id": "111", "span_id": "222", "other.tag": "val"})
 
@@ -125,7 +165,7 @@ def test_colorful_formatter_uses_colors_for_warning(
 ) -> None:
     _developer_setup(monkeypatch)
 
-    logging.config.dictConfig(PRODUCT_LOGGING)
+    init_logging()
     logger = logging.getLogger("product")
 
     logger.warning("A warning message")

fluidattacks_core-2.16.1/fluidattacks_core/logging/__init__.py

@@ -1,12 +0,0 @@
-from fluidattacks_core.logging.presets import BATCH_LOGGING, DATE_FORMAT, PRODUCT_LOGGING
-from fluidattacks_core.logging.types import JobMetadata
-from fluidattacks_core.logging.utils import get_job_metadata, set_telemetry_metadata
-
-__all__ = [
-    "BATCH_LOGGING",
-    "DATE_FORMAT",
-    "PRODUCT_LOGGING",
-    "JobMetadata",
-    "get_job_metadata",
-    "set_telemetry_metadata",
-]

fluidattacks_core-2.16.1/fluidattacks_core/logging/presets.py

@@ -1,95 +0,0 @@
-from fluidattacks_core.logging.filters import BatchOnlyFilter, NoBatchFilter
-from fluidattacks_core.logging.formatters import ColorfulFormatter
-from fluidattacks_core.logging.handlers import DebuggingHandler, ProductionSyncHandler
-from fluidattacks_core.logging.utils import get_environment_metadata, get_job_metadata
-
-# Main formats
-DATE_FORMAT = "%Y-%m-%dT%H:%M:%S%z"
-"""
-Default date format for logs.
-"""
-
-
-# Configuration for logging in batch environments
-_JOB_METADATA = get_job_metadata()
-_ENVIRONMENT_METADATA = get_environment_metadata()
-
-BATCH_LOGGING = {
-    "version": 1,
-    "disable_existing_loggers": False,
-    "filters": {
-        "batch_only": {"()": BatchOnlyFilter},
-        "no_batch": {"()": NoBatchFilter},
-    },
-    "formatters": {
-        "one_line_format": {
-            "class": "logging.Formatter",
-            "format": (
-                "{asctime} {levelname} [{name}] [{filename}:{lineno}] "
-                "[trace_id=None span_id=None "
-                f"service.name=batch/{_JOB_METADATA.job_queue} "
-                f"service.version={_ENVIRONMENT_METADATA.version} "
-                f"deployment.environment={_ENVIRONMENT_METADATA.environment} "
-                "trace_sampled=False]"
-                " - {message}, extra=None"
-            ),
-            "datefmt": DATE_FORMAT,
-            "style": "{",
-        },
-        "simple_format": {
-            "class": "logging.Formatter",
-            "format": "{asctime} [{levelname}] [{name}] {message}",
-            "datefmt": DATE_FORMAT,
-            "style": "{",
-        },
-        "colorful_format": {
-            "()": ColorfulFormatter,
-            "datefmt": DATE_FORMAT,
-            "style": "{",
-        },
-    },
-    "handlers": {
-        "batch_handler": {
-            "class": "logging.StreamHandler",
-            "stream": "ext://sys.stdout",
-            "formatter": "one_line_format",
-            "filters": ["batch_only"],
-        },
-        "console_handler": {
-            "class": "logging.StreamHandler",
-            "stream": "ext://sys.stdout",
-            "formatter": "colorful_format",
-            "filters": ["no_batch"],
-        },
-    },
-    "root": {
-        "handlers": ["batch_handler", "console_handler"],
-        "level": "INFO",
-    },
-}
-"""
-Logging configuration dict for batch environments.
-
-Root logger will have two handlers for batch and non-batch environments.
-"""
-
-PRODUCT_LOGGING = {
-    "version": 1,
-    "disable_existing_loggers": False,
-    "handlers": {
-        "production_handler": {"()": ProductionSyncHandler},
-        "debugging_handler": {"()": DebuggingHandler},
-    },
-    "root": {
-        "handlers": ["production_handler", "debugging_handler"],
-        "level": "INFO",
-    },
-}
-"""
-Default logging configuration dict for all the products.
-
-Required environment variables:
-- `PRODUCT_ID`
-- `CI_COMMIT_REF_NAME`
-- `CI_COMMIT_SHA`
-"""