great-ai/great_ai/parameters/log_metric.py

31 lines
1 KiB
Python

import inspect
from typing import Any
from ..context import get_context
from ..tracing import TracingContext
def log_metric(argument_name: str, value: Any, disable_logging: bool=False) -> None:
"""Log a key (argument_name)-value pair that is persisted inside the trace.
The name of the function from where this is called is also stored.
Args:
argument_name: The key for storing the value.
value: Value to log. Must be JSON-serialisable.
disable_logging: If True, only persist in trace but don't show in console
"""
tracing_context = TracingContext.get_current_tracing_context()
try:
caller = inspect.stack()[1].function
actual_name = f"metric:{caller}:{argument_name}"
except:
# inspect might not work in notebooks
actual_name = f"metric:{argument_name}"
if tracing_context:
tracing_context.log_value(name=actual_name, value=value)
if not disable_logging:
get_context().logger.info(f"{actual_name}={value}")