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.1.tar.gz (20.4 kB view details)

Uploaded Source

Built Distributions

talisker-0.9.1-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

talisker-0.9.1-py2-none-any.whl (36.1 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for talisker-0.9.1.tar.gz
Algorithm Hash digest
SHA256 2b58fc0d352fdff41710f35c2fd56a6f9b026af2b04f9b390e1bc170ddd939b9
MD5 31335309f1e00686098b2d6966d601ec
BLAKE2b-256 c20858cfc6771ec56e6b9262acce8b40d02b3af5adf083156107690efe2933a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for talisker-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1e33bbd1d488a3a2849d1b7da477ea3a337c5d502166f7d78f54e9fdd162e748
MD5 41c7e8c971f7f6ce7b96f53d1c67859d
BLAKE2b-256 4a13109e04a64ba08d98f7aa433e77b38ca7e03f130c76b53c942e0035fc8f6d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for talisker-0.9.1-py2-none-any.whl
Algorithm Hash digest
SHA256 f261131907956d285bf46e76ab76e68a6de996725c7b088170bd06a028ffca7f
MD5 f42f8584eb8051ff44b379db24c49942
BLAKE2b-256 63114a5aa94c702d3fde7377cee0516604a25ca1dec5a30501fe628951098a13

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