Skip to main content

Asyncio task context with logging support

Project description

asyncio-context

Tool for store data within asyncio task (for example, in all coroutines across handling aiohttp request) and enrich logging record with this data.
Small, nice-looking and with annotations.

Install

pip install asyncio-context

Example

It can be used for logging trace id and other info about request:

...
    'formatters': {
        'standard': {
            'format': '[trace_id:%(trace_id)s] [user_id:%(user_id)s]:%(message)s'
        },
    },
    'filters': {
        'context2record': {
            '()': 'asyncio_context.logging.Context2Record',
            'ctx_name': 'ViewsCtx'
        },
    },
...
from asyncio_context import Context

class ViewsCtx(Context):
    user_id: str = 'UNKNOWN'
    trace_id: str = 'NO_TRACE'
    
ctx = ViewsCtx()
log = logging.getLogger()

class MyView(web.View):
    async def get(self):
        
        ctx.trace_id = self.request.headers.get('X-Trace-Id', str(uuid.uuid4()))
        # or
        ViewsCtx().user_id = self.request.match_info.get('user_id')
        
        log.info('Test request')
        # GET http://localhost:8080/user/123
        # [trace_id:ea38e89d-fba1-40a3-899e-297c6cd76732] [user_id:123]:Test request

Context can be copied to another asyncio task:

task = asyncio.get_running_loop().create_task(another_task())
ViewsCtx.copy_to_task(task)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asyncio-context-0.0.1.tar.gz (4.2 kB view details)

Uploaded Source

File details

Details for the file asyncio-context-0.0.1.tar.gz.

File metadata

  • Download URL: asyncio-context-0.0.1.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.6

File hashes

Hashes for asyncio-context-0.0.1.tar.gz
Algorithm Hash digest
SHA256 0e3895535ee71dc6873ba74037cdbf9d1dbd998a0dc74a2a5cb65d128d63c829
MD5 75d648ee230d6da3eae8eadd4f8d9512
BLAKE2b-256 9b1393d878a590bb6536923b9afb5ad8bdd3dfeb7db10bfb438a8c288791af52

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page