https://github.com/rai200890/python-log-sanitizer

Python log sanitizer
https://github.com/rai200890/python-log-sanitizer

logging python3 sanitizer

Last synced: 6 months ago
JSON representation

Python log sanitizer

• Host: GitHub
• URL: https://github.com/rai200890/python-log-sanitizer
• Owner: rai200890
• License: mit
• Created: 2018-11-05T00:39:17.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-05-03T19:39:36.000Z (over 6 years ago)
• Last Synced: 2025-04-04T19:58:50.335Z (6 months ago)
• Topics: logging, python3, sanitizer
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# python_log_sanitizer

[![CircleCI](https://circleci.com/gh/rai200890/python-log-sanitizer.svg?style=svg&circle-token=da7071836f491385a780fb92fc015ebdd1da8569)](https://circleci.com/gh/rai200890/python-log-sanitizer)

[![PyPI version](https://badge.fury.io/py/python-log-sanitizer.svg)](https://badge.fury.io/py/python-log-sanitizer)

[![Maintainability](https://api.codeclimate.com/v1/badges/07aeb29594b05405ddd5/maintainability)](https://codeclimate.com/github/rai200890/python-log-sanitizer/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/07aeb29594b05405ddd5/test_coverage)](https://codeclimate.com/github/rai200890/python-log-sanitizer/test_coverage)

Python log sanitizer

## Instalation

### Pipenv

```

    pipenv install python_log_sanitizer 

```

### Pip

```

    pip install python_log_sanitizer 

```

## Usage

To run this example please install [python-json-logger](https://github.com/madzak/python-json-logger):

```pip

pip install python-json-logger

```

```python

LOG_CONFIG = {

    "version": 1,

    "formatters": {

        "json": {

            "class": "pythonjsonlogger.jsonlogger.JsonFormatter",

            "format": "[%(asctime)s] %(levelname)s in %(module)s: %(message)s"

        }

    },

    "filters": {

        "sanitizer": {

            "()" : "python_log_sanitizer.SanitizerFilter",

            "patterns": ["extra"],

            "placeholder": "*"

        }

    },

    "handlers": {

        "json": {

            "class": "logging.StreamHandler",

            "formatter": "json"

        }

    },

    "loggers": {

        "root": {

            "level": "INFO",

            "handlers": ["json"],

            "filters": ["sanitizer"]

        }

    }

}

import logging

from logging import config

config.dictConfig(LOG_CONFIG) # load log config from dict

logger = logging.getLogger("root") # get root logger instance

logger.info("farofa", extra={"extra": "farofa"}) # log message with extra arguments  

```

Example output:

```json

{"asctime": "2018-11-04 23:01:55,804", "levelname": "INFO", "module": "", "message": "farofa", "extra": "*"}

```