telemetry

Class info

Classes

Name	Children	Inherits
PrefixedLogger mkdocs_mknodes.telemetry A logger adapter to prefix log messages.		LoggerAdapter

🛈 DocStrings

PrefixedLogger

Bases: LoggerAdapter

A logger adapter to prefix log messages.

Source code in mkdocs_mknodes/telemetry.py

class PrefixedLogger(logging.LoggerAdapter):
    """A logger adapter to prefix log messages."""

    def __init__(self, prefix: str, logger: logging.Logger) -> None:
        """Initialize the logger adapter.

        Args:
            prefix: The string to insert in front of every message.
            logger: The logger instance.
        """
        super().__init__(logger, {})
        self.prefix = prefix

    def process(self, msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, Any]:
        """Process the message.

        Args:
            msg: The message:
            kwargs: Remaining arguments.

        Returns:
            The processed message.
        """
        return f"{self.prefix}: {msg}", kwargs

__init__

__init__(prefix: str, logger: Logger) -> None

Initialize the logger adapter.

Parameters:

Name	Type	Description	Default
prefix	str	The string to insert in front of every message.	required
logger	Logger	The logger instance.	required

Source code in mkdocs_mknodes/telemetry.py

def __init__(self, prefix: str, logger: logging.Logger) -> None:
    """Initialize the logger adapter.

    Args:
        prefix: The string to insert in front of every message.
        logger: The logger instance.
    """
    super().__init__(logger, {})
    self.prefix = prefix

process

process(msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, Any]

Process the message.

Parameters:

Name	Type	Description	Default
msg	str	The message:	required
kwargs	MutableMapping[str, Any]	Remaining arguments.	required

Returns:

Type	Description
tuple[str, Any]	The processed message.

Source code in mkdocs_mknodes/telemetry.py

def process(self, msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, Any]:
    """Process the message.

    Args:
        msg: The message:
        kwargs: Remaining arguments.

    Returns:
        The processed message.
    """
    return f"{self.prefix}: {msg}", kwargs

get_plugin_logger

get_plugin_logger(name: str) -> PrefixedLogger

Return a logger for plugins.

Parameters:

Name	Type	Description	Default
name	str	The name to use with logging.getLogger.	required

Returns:

Type	Description
PrefixedLogger	A logger configured to work well in MkDocs, prefixing each message with the plugin package name.

Example

from mkdocs.plugins import get_plugin_logger

log = get_plugin_logger(__name__)
log.info("My plugin message")

Source code in mkdocs_mknodes/telemetry.py

def get_plugin_logger(name: str) -> PrefixedLogger:
    """Return a logger for plugins.

    Args:
        name: The name to use with `logging.getLogger`.

    Returns:
        A logger configured to work well in MkDocs,
            prefixing each message with the plugin package name.

    Example:
        ```python
        from mkdocs.plugins import get_plugin_logger

        log = get_plugin_logger(__name__)
        log.info("My plugin message")
        ```
    """
    logger = logging.getLogger(f"mkdocs.plugins.{name}")
    logger.addHandler(logfire.LogfireLoggingHandler())
    return PrefixedLogger(name.split(".", 1)[0], logger)