Welcome to the Ultimate Guide on mkdocs-logger

In this comprehensive guide, we will dive deep into mkdocs-logger, a powerful logging extension for MkDocs. This guide covers dozens of useful API explanations with illustrative code snippets to get you started quickly.

Introduction to mkdocs-logger

mkdocs-logger simplifies your logging setup and allows you to manage logs with various levels of detail. Whether you need to debug an issue or simply monitor the app’s behavior, mkdocs-logger has you covered.

Key Features and API Examples

Logging Levels

mkdocs-logger provides support for multiple logging levels which can be easily configured.

  import mkdocs_logger

  logger = mkdocs_logger.getLogger("my_logger")

  # Set logging level
  logger.setLevel(mkdocs_logger.DEBUG)

  # Log messages with different levels
  logger.debug("This is a debug message")
  logger.info("This is an info message")
  logger.warning("This is a warning message")
  logger.error("This is an error message")
  logger.critical("This is a critical message")

Configuration Settings

Logging configuration allows fine-tuning of the logger’s behavior and output format.

  mkdocs_logger.configure({
      "level": "INFO",
      "format": "%(asctime)s - %(levelname)s - %(message)s",
      "datefmt": "%Y-%m-%d %H:%M:%S",
      "handlers": ["console", "file"],
      "file_handler": {
          "filename": "app.log",
          "mode": "a",
          "encoding": "utf-8"
      }
  })

Example App with mkdocs-logger

Let’s explore a simple example that demonstrates the usage of mkdocs-logger in an application.

  import mkdocs_logger

  def main():
      logger = mkdocs_logger.getLogger("app_logger")
      logger.info("Application started")
      try:
          result = perform_critical_function()
          logger.info(f"Function succeeded with result: {result}")
      except Exception as e:
          logger.error("An error occurred", exc_info=True)
      logger.info("Application finished")

  def perform_critical_function():
      # Simulated function logic
      return "Success"

  if __name__ == "__main__":
      mkdocs_logger.configure({
          "level": "INFO",
          "format": "%(asctime)s - %(levelname)s - %(message)s",
          "datefmt": "%Y-%m-%d %H:%M:%S",
          "handlers": ["console"]
      })
      main()

By incorporating mkdocs-logger into your application, you can ensure thorough and customizable logging for all your needs.

Hash: ced7a9f1902cedfcbb0462c7cf7524e80c495b8fc7dc05cb40e6be9fef108632