Skip to content

horde_sdk.horde_logging

verbosity module-attribute 

verbosity = 20

error_levels module-attribute 

error_levels = ['ERROR', 'CRITICAL', 'EXCEPTION', 'TRACE']

handler_config module-attribute 

handler_config = [
    {
        "sink": sys.stdout,
        "colorize": True,
        "filter": is_stdout_log,
    },
    {
        "sink": "logs/bridge.log",
        "level": "DEBUG",
        "colorize": False,
        "retention": "2 days",
        "rotation": "3 hours",
    },
    {
        "sink": "logs/trace.log",
        "level": "TRACE",
        "colorize": False,
        "filter": is_trace_log,
        "retention": "3 days",
        "rotation": "1 days",
        "backtrace": True,
        "diagnose": True,
    },
]

PROGRESS_LOGGER_LABEL module-attribute 

PROGRESS_LOGGER_LABEL = 'PROGRESS'

The label for request progress log messages. Less severity than INFO.

COMPLETE_LOGGER_LABEL module-attribute 

COMPLETE_LOGGER_LABEL = 'COMPLETE'

The label for 'request complete' log messages. Less severity than INFO.

HORDE_SDK_LOG_VERBOSITY module-attribute 

HORDE_SDK_LOG_VERBOSITY = os.getenv(
    "HORDE_SDK_LOG_VERBOSITY"
)

parsed_verbosity module-attribute 

parsed_verbosity: int | None = int(HORDE_SDK_LOG_VERBOSITY)

HORDE_SDK_TELEMETRY module-attribute 

HORDE_SDK_TELEMETRY = os.getenv('HORDE_SDK_TELEMETRY')

set_logger_handlers module-attribute 

set_logger_handlers = os.getenv(
    "HORDE_SDK_SET_DEFAULT_LOG_HANDLERS"
)

set_logger_verbosity 

set_logger_verbosity(count: int) -> None

Set the verbosity of the logger.

Source code in horde_sdk/horde_logging.py 
14
15
16
17
18
19
def set_logger_verbosity(count: int) -> None:
    """Set the verbosity of the logger."""
    global verbosity
    # The count comes reversed. So count = 0 means minimum verbosity
    # While count 5 means maximum verbosity
    verbosity = 50 - (count * 10)

is_stdout_log 

is_stdout_log(record: dict[str, Any]) -> bool

Filter for stdout logs levels.

Source code in horde_sdk/horde_logging.py 
22
23
24
25
def is_stdout_log(record: dict[str, Any]) -> bool:
    """Filter for stdout logs levels."""
    global verbosity
    return bool(record["level"].no >= verbosity)

is_msg_log 

is_msg_log(record: dict[str, Any]) -> bool

Filter for stdout logs levels.

Source code in horde_sdk/horde_logging.py 
28
29
30
31
def is_msg_log(record: dict[str, Any]) -> bool:
    """Filter for stdout logs levels."""
    global verbosity
    return bool(record["level"].no >= verbosity)

is_stderr_log 

is_stderr_log(record: dict[str, Any]) -> bool

Filter for stderr logs levels.

Source code in horde_sdk/horde_logging.py 
34
35
36
def is_stderr_log(record: dict[str, Any]) -> bool:
    """Filter for stderr logs levels."""
    return record["level"].name in error_levels

is_trace_log 

is_trace_log(record: dict[str, Any]) -> bool

Filter for trace logs levels.

Source code in horde_sdk/horde_logging.py 
39
40
41
def is_trace_log(record: dict[str, Any]) -> bool:
    """Filter for trace logs levels."""
    return record["level"].name in error_levels

set_default_log_handlers 

set_default_log_handlers(with_telemetry: bool) -> None

Set the default log handlers if not already configured.

Source code in horde_sdk/horde_logging.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def set_default_log_handlers(with_telemetry: bool) -> None:
    """Set the default log handlers if not already configured."""
    if with_telemetry:
        import logfire

        import horde_sdk._version

        logfire.configure(
            send_to_logfire=False,
            service_name="horde-sdk",
            service_version=horde_sdk._version.__version__,
            console=False,
        )

        if HORDE_SDK_TELEMETRY and HORDE_SDK_TELEMETRY.lower() == "full":
            logger.info("Enabling full telemetry instrumentation.")
            logfire.instrument_aiohttp_client()
            logfire.instrument_requests()
        else:
            logger.info("Enabling basic telemetry instrumentation.")

        logfire.instrument_pydantic()

        logger.remove()
        handler_config.append(logfire.loguru_handler())
        logger.configure(handlers=handler_config)  # type: ignore
        logger.info("Telemetry instrumentation enabled.")
    else:
        logger.info("Setting default logger handlers.")
        logger.remove()
        logger.configure(handlers=handler_config)  # type: ignore
        logger.info("Default logger handlers set.")