Metadata-Version: 2.1
Name: django-logging-requests
Version: 1.3.5
Summary: A package for logging all requests
Author: J4CK_VVH173
Author-email: i78901234567890@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENCE

# Logging

Middleware для логирования request запросов на endpoint.

## Quick start

1. Add "django_logging" to your INSTALLED_APPS setting like this.

    ```python
        INSTALLED_APPS = [
            ...
            'django_logging',
            ...
        ]
    ```

1. Create `logging` handlers with `LOGGING` name within `settings.py`. The middleware uses handlers with names: `info_logger` and
`error_logger` .

    ```python
    LOGGING = {
        'formatters': {
            ...
        },
        'handlers': {
            ...
        },
        'loggers': {
            'info_logger': {
                'handlers': ['info'],
                'level': 'INFO'
            },
            'error_logger': {
                'handlers': ['error'],
            },
        }
    }
    ```

1. Create `LOGGING_SERVER_NAME` withing `settings.py`. The middleware uses this variable as server name key in every log message.

    ```python
    LOGGING_SERVER_NAME = 'server name'
    ```

1. Create `AUTHENTICATION_HEADER` within `settings.py`. The middleware try to get user information from this header in [jwt](https://jwt.io/) format.

    ```python
    AUTHENTICATION_HEADER = 'Authentication'
    ```

1. Add a middleware class to listen in on responses

    ```python
    MIDDLEWARE = [
        ...,
        "django_logging.middleware.LoggingMiddleware",
        ...,
    ]
    ```

    It's better to set as low as possible.

## Release

Pushing to master branch will run auto build new version and push it to `pypi`. Before pushing to master
branch must update version in `setup.py`.
