Skip to main content

A common WSGI stack

Project description

Talisker - an opinionated WSGI app platform

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 can 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 gunicorns, 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

  • raven for errors

  • werkzeug for thread locals and wsgi utilities

It is designed sepcifically to be used in both development and production, and aims to provide a default set of features out of the box:

  • standard log format, including ISO/UTC timestamps

  • structured logging with python stdlib

  • improved gunicorn access logs, with ms precision UTC timestamps

  • request id tracing

  • standard set of status endpoints for your app

  • easier statsd endpoint configuration

  • sentry/raven middleware (TODO)

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:

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

  • per-thread requests connection pool managment (WIP)

  • automatic statsd metrics for outgoing HTTP requests (WIP)

  • more efficient statsd client management (WIP)

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

  • grok filters for log parsing (WIP)

  • 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

History

0.5.0 (2016-08-10)

  • add grok filters for logstash

  • slight adjustment to logfmt serialisation: talisker now strips “ from tag values. This is due to a limitation in logstash.

0.4.1 (2016-08-05)

  • publish separate py2/py3 wheels, due to dependency differences

  • some doc changes

0.4.0 (2016-08-05)

  • First public release an PyPI.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

talisker-0.5.0-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

talisker-0.5.0-py2-none-any.whl (23.0 kB view details)

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for talisker-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 19fa5500d56e39f5f903f30014d2c1d68e0e1d0f0da3b2aaed5768723f3ec4d9
MD5 11b75d85d1e93f30a1f8f8eabdd23123
BLAKE2b-256 d50149f6c3155d6851554e152252b2db2e72233c0585508155aa87a9f76ee237

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for talisker-0.5.0-py2-none-any.whl
Algorithm Hash digest
SHA256 178b153ee743293a3e2c13fd31d29307c8901559ea54bd023b2a050bb1a7f691
MD5 14a1ef1b38182ba7b3f820cd0aa91f32
BLAKE2b-256 42022b036fcdb173a132cf31e29892921b8f59bc02daac328e6fe72a8db2e7c5

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