Welcome to the Ultimate Guide to `hua-logger`

If you’re a developer looking to implement a powerful and flexible logging system in your application, then hua-logger is the perfect solution. This guide will introduce you to `hua-logger` and provide extensive API explanations alongside practical code snippets to help you integrate it seamlessly into your projects.

Getting Started with hua-logger

Before diving into the APIs, let’s get started with the installation:

  pip install hua-logger

Basic Configuration

Here’s how you can perform basic configuration for `hua-logger`:

  from hua_logger import Logger

  # Create a logger instance
  logger = Logger(name="my_app_logger")

  # Basic logging
  logger.info("This is an info message")
  logger.error("This is an error message")

Advanced Configuration

`hua-logger` allows for customizable settings. Here’s an example of advanced configuration:

  from hua_logger import Logger, LogLevel

  # Create a logger instance with settings
  logger = Logger(
    name="advanced_logger",
    level=LogLevel.DEBUG,
    formatter="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
    handlers=["console", "file"]
  )

  logger.debug("This is a debug message")

Contextual Logging

Keep track of the context in which logs are generated:

  from hua_logger import Logger

  logger = Logger(name="contextual_logger")

  with logger.context(user='alice', action='login'):
      logger.info("User logged in successfully")

Exception Logging

Automatically log exceptions in your application:

  from hua_logger import Logger

  logger = Logger(name="exception_logger")

  try:
      result = 1 / 0
  except ZeroDivisionError:
      logger.exception("An error occurred")

Asynchronous Logging

Efficiently handle logs in an asynchronous environment:

  from hua_logger import AsyncLogger

  async_logger = AsyncLogger(name="async_logger")

  async def log_async():
      async_logger.info("This log is asynchronous")

  # Run the asynchronous logging function
  asyncio.run(log_async())

Log Rotation

Implement log rotation to manage large log files:

  from hua_logger import Logger

  logger = Logger(
    name="rotating_logger",
    handlers=["rotatingfile"],
    rotatingfile={"maxBytes": 1024*1024*5, "backupCount": 5}  # 5MB per file and 5 backups
  )

  for _ in range(10000):
      logger.info("This is a log message for the rotating file handler")

Integrated API Example

Here’s a complete application example bringing together all the introduced APIs:

  from hua_logger import Logger, AsyncLogger, LogLevel

  def main():
      # Basic logger
      basic_logger = Logger(name="basic_app_logger")
      basic_logger.info("Basic logger initialized")

      # Advanced logger
      advanced_logger = Logger(
        name="advanced_app_logger",
        level=LogLevel.DEBUG,
        formatter="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
        handlers=["console", "file"]
      )
      advanced_logger.debug("Advanced logger initialized")

      # Contextual logger
      contextual_logger = Logger(name="contextual_app_logger")
      with contextual_logger.context(user='bob', action='logout'):
          contextual_logger.info("User logged out")

      # Exception logger
      exception_logger = Logger(name="exception_app_logger")
      try:
          result = 1 / 0
      except ZeroDivisionError:
          exception_logger.exception("Exception caught in main function")

      # Asynchronous logger
      async_logger = AsyncLogger(name="async_app_logger")
      asyncio.run(async_logger.info("Asynchronous logger initialized"))

      # Rotating file logger
      rotating_logger = Logger(
        name="rotating_app_logger",
        handlers=["rotatingfile"],
        rotatingfile={"maxBytes": 1024*1024*5, "backupCount": 5}
      )
      rotating_logger.info("Rotating file logger initialized")

  if __name__ == "__main__":
      main()

By following this guide, you will be able to utilize the powerful capabilities of `hua-logger` to ensure your application’s logging is robust, efficient, and scalable.

Hash: f3f80ea22a4b4e198386e390c8bf2ad592c660ef0db1948b34103ffc3d0ada85