Skip to content

Easy contextual information logging filter, using ContextVars.

License

Notifications You must be signed in to change notification settings

aviramha/contextfilter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

contextfilter

Version License Tests

Small, helper library for logging contextual information using contextvars in Python 3.7.

Installation

Using pip

$ pip install contextfilter

Usage

import logging
from contextvars import ContextVar
from contextfilter import ContextVarFilter, ConstContextFilter

request_id: ContextVar[int] = ContextVar('request_id')
logger = logging.getLogger("test")
cf = ContextFilter(request_id=request_id)
request_id.set(3)
logger.addFilter(cf)
logger.info("test")
# Log record will contain the attribute request_id with value 3

cf = ConstContextFilter(some_const=1)
logger.addFilter(cf)
logger.info("test")
# Log record will contain the attribute some_const with value 1.

Contributing

To work on the contextfilter codebase, you'll want to fork the project and clone it locally and install the required dependencies via poetry:

$ git clone git@github.com:{USER}/contextfilter.git
$ make install

To run tests and linters use command below:

$ make lint && make test

If you want to run only tests or linters you can explicitly specify which test environment you want to run, e.g.:

$ make lint-black

License

contextfilter is licensed under the MIT license. See the license file for details.

Latest changes

0.3.0 (2020-8-14)

  • Renamed ContextFilter to ContextVarFilter - Revamped the API - It now accepts ContextVars created by caller. Suggestion for design by @bentheiii
  • Added ConstContextFilter which adds constant attributes to the log record.
  • Fixed #5

About

Easy contextual information logging filter, using ContextVars.

Resources

License

Stars

Watchers

Forks

Packages

No packages published