Skip to main content

A common WSGI stack

Project description

https://img.shields.io/pypi/v/talisker.svg https://img.shields.io/travis/canonical-ols/talisker.svg Documentation Status

Talisker is a runtime for your wsgi app that aims to provide a common platform for your python services.

tl;dr

Simply run your wsgi app with talisker as if it was gunicorn.:

talisker app:wsgi -c config.py ...

Talisker will wrap your app in a some simple WSGI middleware, and configure logging to output structured logging like so:

logger = logging.getLogger('app')
logger.info('something happened', extra={'context': 'I haz it'})

will output:

2016-01-13 10:24:07.357Z INFO app "something happened" svc.context="I haz it" request_id=...

It also exposes some status endpoints you can use, go to the /_status/ url on your app to see them.

This all works out of the box by using the talisker runner instead of gunicorn’s, and there are many more features you can use too.

Elevator Pitch

Talisker is based on a number of standard python tools:

  • stdlib logging for logs

  • gunicorn for a wsgi runner

  • requests for http requests

  • statsd for metrics (and optionally, prometheus_client)

  • sentry for errors

  • werkzeug for thread locals and wsgi utilities

It also supports additionaly optional tools:

  • celery for async tasks

  • prometheus as an alternate metrics tool

It’s main job is to integrate and configure all the above in a single tool, for use in both dev and production, which provides a standard set of features out of the box:

  • drop-in replacement for gunicorn as a wsgi runner

  • standardised structured logging on top of python stdlib logging

  • request id tracing

  • standard set of status endpoints for your app

  • easier configuration via env vars

  • metrics for everything

  • deep sentry integration (WIP)

All the above are available by just using the talisker entry point script, rather than gunicorn.

In addition, with a small amount of effort, your app can benefit from additional features:

  • add structured logging tags to your application logs

  • simple deeper nagios checks - just implement a /_status/check url in your app

  • per-thread requests connection pool management

Additionally, talisker provides additional tools for integrating with your infrastructure:

  • grok filters for log parsing

  • rsyslog templates and config for log shipping (TODO)

Talisker is opinionated, and derived directly from the authors’ needs and as such not currently very configurable. However, PR’s are very welcome!

For more information, see The Documentation, which should be found at:

https://talisker.readthedocs.io

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

talisker-0.9.2.tar.gz (20.6 kB view details)

Uploaded Source

Built Distributions

talisker-0.9.2-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

talisker-0.9.2-py2-none-any.whl (36.4 kB view details)

Uploaded Python 2

File details

Details for the file talisker-0.9.2.tar.gz.

File metadata

  • Download URL: talisker-0.9.2.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for talisker-0.9.2.tar.gz
Algorithm Hash digest
SHA256 a52284fe89f54ac19a0d2eb968a0c04a9fe008d1a279c1f56e90c018c289583e
MD5 ad98f4d1291adbc731a30a03ccdc7ddc
BLAKE2b-256 162cdf1ba996440a20997beb917dc2eef461bc0668a9b6396eb855cbfbe8fa65

See more details on using hashes here.

File details

Details for the file talisker-0.9.2-py3-none-any.whl.

File metadata

File hashes

Hashes for talisker-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4ee1b2b6b8ee8cf20f622a2beaa9b705e5ee6aff086fdc384fd93e15a78b8337
MD5 4b5316d95ba92bbc7dc0ec6f837c8e73
BLAKE2b-256 091e2cd2200e36d29e52f09f1c2ab1d39cd4df9ae9ac664f70f68746689a07a0

See more details on using hashes here.

File details

Details for the file talisker-0.9.2-py2-none-any.whl.

File metadata

File hashes

Hashes for talisker-0.9.2-py2-none-any.whl
Algorithm Hash digest
SHA256 715bcf2e9630af5d472e966e94b154cf4e11f96b78ac39096fee469f4671c6b2
MD5 960103eefc6d796370869c646c5cdf1a
BLAKE2b-256 535b646cc79c3884a2258f44c338ba1ae315fb25c1d1ca983671f00e7d06ff03

See more details on using hashes here.

Supported by

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