azpaddypy 0.3.7__py3-none-any.whl → 0.3.9__py3-none-any.whl

azpaddypy/mgmt/logging.py

@@ -517,70 +517,101 @@ class AzureLogger:
         is_async: bool,
     ):
         """Handle failed function execution in tracing."""
-        span.set_status(Status(StatusCode.ERROR, str(e)))
+        span.set_status(Status(StatusCode.ERROR, description=str(e)))
         span.record_exception(e)
-        span.set_attribute("function.duration_ms", duration_ms)
-        span.set_attribute("function.success", False)
-        span.set_attribute("error.type", type(e).__name__)
-        span.set_attribute("error.message", str(e))
-
         if log_execution:
             self.log_function_execution(
-                func.__name__,
-                duration_ms,
-                False,
-                {
-                    "error_type": type(e).__name__,
-                    "error_message": str(e),
-                    "is_async": is_async,
-                },
+                function_name=func.__name__, duration_ms=duration_ms, success=False
+            )
+            self.error(
+                f"Exception in {'async ' if is_async else ''}"
+                f"function '{func.__name__}': {e}"
             )
-
-        log_prefix = "Async function" if is_async else "Function"
-        self.error(f"{log_prefix} execution failed: {func.__name__} - {str(e)}")
 
     def trace_function(
         self,
         function_name: Optional[str] = None,
         log_execution: bool = True,
         log_args: bool = True,
-        log_result: bool = False
+        log_result: bool = False,
     ) -> Callable:
-        """Decorator for automatic function execution tracing with correlation ID support.
+        """Trace function execution with OpenTelemetry.
 
-        Supports both synchronous and asynchronous functions with comprehensive
-        logging and OpenTelemetry span creation. Automatically generates and manages
-        correlation IDs for distributed tracing.
+        This decorator provides a simple way to instrument a function by automatically
+        creating an OpenTelemetry span to trace its execution. It measures execution
+        time, captures arguments, and records the result as attributes on the span.
+        It supports both synchronous and asynchronous functions.
 
-        CORRELATION ID AUTOMATION:
-        - If no correlation_id is set, automatically generates a UUID4 correlation_id
-        - If correlation_id is manually set, preserves the existing value
-        - Correlation_id is automatically added to all spans and log entries
-        - Ensures consistent tracing across function calls
+        A correlation ID is automatically managed. If one is not already set on the
+        logger instance, a new UUID4 correlation ID will be generated and used for
+        the function's trace, ensuring that all related logs and traces can be
+        linked together.
 
         Args:
-            function_name: Custom span name (defaults to function name)
-            log_execution: Whether to log execution metrics
-            log_args: Whether to log function arguments
-            log_result: Whether to log function result
+            function_name (Optional[str], optional):
+                Specifies a custom name for the span. If not provided, the name of the
+                decorated function is used. Defaults to None.
+            log_execution (bool, optional):
+                When True, a log message is emitted at the start and end of the function's
+                execution, including the execution duration. This provides a clear
+                record of the function's lifecycle. Defaults to True.
+            log_args (bool, optional):
+                When True, the arguments passed to the function are recorded as
+                attributes on the span. This is useful for understanding the context
+                of the function call. Sensitive arguments should be handled with care.
+                Defaults to True.
+            log_result (bool, optional):
+                When True, the return value of the function is recorded as an attribute
+                on the span. This should be used cautiously, as large or sensitive
+                return values may be captured. Defaults to False.
 
         Returns:
-            Decorated function with automatic tracing and correlation ID support
+            Callable: A decorator that can be applied to a function.
 
-        Example:
-            # Automatic correlation_id generation
-            @logger.trace_function()
-            def my_function():
-                return "result"
+        Examples:
+            Basic usage with default settings:
+            Logs execution, arguments, but not the result.
 
-            # Manual correlation_id (preserved)
-            logger.set_correlation_id("manual-id")
             @logger.trace_function()
-            def my_function():
-                return "result"
+            def sample_function(param1, param2="default"):
+                return "done"
+
+            Customizing the span name:
+            The span will be named "MyCustomTask" instead of "process_data".
+
+            @logger.trace_function(function_name="MyCustomTask")
+            def process_data(data):
+                # processing logic
+                return {"status": "processed"}
+
+            Logging the result:
+            Enable `log_result=True` to capture the function's return value.
+
+            @logger.trace_function(log_result=True)
+            def get_user_id(username):
+                return 12345
+
+            Disabling argument logging for sensitive data:
+            If a function handles sensitive information, disable argument logging.
+
+            @logger.trace_function(log_args=False)
+            def process_payment(credit_card_details):
+                # payment processing logic
+                pass
+
+            Tracing an asynchronous function:
+            The decorator works with async functions without any extra configuration.
+
+            @logger.trace_function(log_result=True)
+            async def fetch_remote_data(url):
+                # async data fetching
+                return await http_get(url)
         """
 
         def decorator(func):
+            # Determine if the function is async at decoration time
+            is_async = asyncio.iscoroutinefunction(func)
+
             @functools.wraps(func)
             async def async_wrapper(*args, **kwargs):
                 span_name = function_name or f"{func.__module__}.{func.__name__}"
@@ -656,7 +687,7 @@ class AzureLogger:
                         raise
 
             # Return appropriate wrapper based on function type
-            if asyncio.iscoroutinefunction(func):
+            if is_async:
                 return async_wrapper
             return sync_wrapper
 

{azpaddypy-0.3.7.dist-info → azpaddypy-0.3.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: azpaddypy
-Version: 0.3.7
+Version: 0.3.9
 Summary: Comprehensive Python logger for Azure, integrating OpenTelemetry for advanced, structured, and distributed tracing.
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent

{azpaddypy-0.3.7.dist-info → azpaddypy-0.3.9.dist-info}/RECORD

@@ -1,11 +1,11 @@
 azpaddypy/__init__.py,sha256=hrWNAh4OHZOvm3Pbhq5eUjO-pSRYn0h0W0J87tc-lNI,45
 azpaddypy/mgmt/__init__.py,sha256=-jH8Ftx9C8qu4yF5dMVEapVZhNwG7m4QCUjyutesOoY,278
 azpaddypy/mgmt/identity.py,sha256=mA_krQslMsK_sDob-z-QA0B9khK_JUO2way7xwPopR8,12001
-azpaddypy/mgmt/logging.py,sha256=pivPsHeySF1Dyx6HKCSos7HBOYyJMVeRP25wYZu3Sno,35117
+azpaddypy/mgmt/logging.py,sha256=5RTxzQeSDWysVQZ3Wiu0serM42Ba3hMYWza7NoEOR08,36753
 azpaddypy/resources/__init__.py,sha256=Bvt3VK4RqwoxYpoh6EbLXIR18RuFPKaLP6zLL-icyFk,314
 azpaddypy/resources/keyvault.py,sha256=4J08vLqoLFd1_UUDBji2oG2fatZaPkgnRyT_Z6wHAOc,20312
-azpaddypy-0.3.7.dist-info/licenses/LICENSE,sha256=hQ6t0g2QaewGCQICHqTckBFbMVakGmoyTAzDpmEYV4c,1089
-azpaddypy-0.3.7.dist-info/METADATA,sha256=Obf2fuDW1wi4L6HzKOD9l_nr7WAvVLkk0C9LRf7wT_o,665
-azpaddypy-0.3.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-azpaddypy-0.3.7.dist-info/top_level.txt,sha256=hsDuboDhT61320ML8X479ezSTwT3rrlDWz1_Z45B2cs,10
-azpaddypy-0.3.7.dist-info/RECORD,,
+azpaddypy-0.3.9.dist-info/licenses/LICENSE,sha256=hQ6t0g2QaewGCQICHqTckBFbMVakGmoyTAzDpmEYV4c,1089
+azpaddypy-0.3.9.dist-info/METADATA,sha256=hzvsml5CIzufS4mJkK06RdYNXKmC1HiCMUt0ysepJRY,665
+azpaddypy-0.3.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+azpaddypy-0.3.9.dist-info/top_level.txt,sha256=hsDuboDhT61320ML8X479ezSTwT3rrlDWz1_Z45B2cs,10
+azpaddypy-0.3.9.dist-info/RECORD,,