jmgilman/loguricorn

A small package for rerouting gunicorn logs to loguru

loguricorn

A small package for rerouting gunicorn logs to loguru

This package provides a compatible interface for automatically routing gunicorn logs to the popular loguru library.

Usage

Install the package:

pip install loguricorn

Then pass the custom interface to gunicorn at runtime:

gunicorn --logger-class loguricorn.Logger tests.app:app

All log records will now be routed through the default loguru.logger.

Configuration

It's possible to customize the loguru.logger instance before gunicorn initializes itself. Simply add your changes in a configuration file and pass it to gunicorn at runtime:

import sys

from loguru import logger

logger.remove()
logger.add(
    sys.stderr,
    colorize=True,
    format="<green>{time}</green> <level>{message}</level>",
)

gunicorn -c conf.py --logger-class loguricorn.Logger tests.app:app

It's recommended to import any customizations from your main application and use them in the configuration in order to obtain a consistent log record format across the entire execution.

Testing

Testing is done by starting gunicorn in a subprocess with the custom logger enabled and validating that the emitted logs match the expected format.

Install dev dependencies:

poetry install

Run test:

poetry run tox .

Contributing

Check out the issues for items needing attention or submit your own and then:

1. Fork the repo
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

loguricorn's Issues

Does not support python3.8?

pip install loguricorn
Looking in indexes: https://pypi.tuna.tsinghua.edu.cn/simple
ERROR: Ignored the following versions that require a different python version: 0.1.0 Requires-Python >=3.10,<4.0
ERROR: Could not find a version that satisfies the requirement loguricorn (from versions: none)
ERROR: No matching distribution found for loguricorn

Examples work with FastAPI?

Hi, really appreciate this project. I would like to ask if you can provide a minimum practice of this project with fastapi in a production environment, thanks.