https://github.com/elafarge/django-fluentd-requests-logging

[DEPRECATED] A minimalistic, yet powerful, Django middleware that forwards django request logs to an HTTP fluentd server.
https://github.com/elafarge/django-fluentd-requests-logging

django fluentd fluentd-http http logging middleware

Last synced: 2 months ago
JSON representation

[DEPRECATED] A minimalistic, yet powerful, Django middleware that forwards django request logs to an HTTP fluentd server.

• Host: GitHub
• URL: https://github.com/elafarge/django-fluentd-requests-logging
• Owner: elafarge
• License: mit
• Created: 2017-01-03T00:58:14.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-10-23T00:29:11.000Z (about 5 years ago)
• Last Synced: 2024-10-11T15:09:13.974Z (3 months ago)
• Topics: django, fluentd, fluentd-http, http, logging, middleware
• Language: Python
• Homepage:
• Size: 22.5 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Django Request Logger for FluentD-HTTP

======================================

DEPRECATION NOTICE

------------------

**This project won't be maintained anymore**, you can consider alternatives such

as [django-logging-json](https://github.com/cipriantarta/django-logging). Which

is much better anyways. I won't be writing a single line of code for Django

anymore :)

Logs Django requests and response metadata as well as the request and response

bodies optionally.

Theses logs are formatted as JSON for a better compliance with modern document

indexing and processing solutions (who said Elasticseach ?).

All you have to do is setup a fluentd HTTP receiver and adapt the configuration

in Django accordingly (that simply goes in your traditionnal Django

`settings.py` file):

```shell

 * HOST: fluentd server hostname (default: localhost)

 * PORT: fluentd http server port (default: 24224)

 * ENV : adds a "fluentd_environment" tag to log document (default: None)

 * TAG : tag identifying the source in fluentd pipelines (default

         django.requests)

 * FLUSH_PERIOD: the interval between two flushes of the fluentd push queue

                 (allows for CPU consumption shaping)

 * DROP_SIZE: when there are more logs that DROP_SIZE in the push queue, older

              logs will be flushed

 * RETRY_INTERVAL: time to wait before trying again a failed request

 * IGNORE_REQUESTS: (Python) list of (method, path, response_code) tuples for

                    which not to forward requests (useful for health checks for

                    instance)

 * FIELDS_TO_OBFUSCATE: a Python list of fields (such as

                        "requests.headers.authorization" to obfuscate. Passwords

                        and API keys mostly ;-) The value of these fields will

                        be replaced with "OBFUSCATED" before anything is

                        forwarded to fluentd.

```

License

-------

MIT

Maintainers

-----------

 * Etienne Lafarge