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 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

0.6.0 (2016-09-09)

  • Propagate gunicorn.error log, and remove its default handler.

This allows consistant logging, making the choice in all cases that your gunicorn logs go to the same stream as your other application loglogging, making the choice in all cases that your gunicorn logs go to the same stream as your other application logs.

We issue a warning if the user tries to configure errorlog manually, as it won’t work as expected.

0.5.7 (2016-09-02)

  • Update publishing workflow

  • Add make changelog target

0.5.6 (2016-09-02)

  • more testing release process in prepartion for 0.6

0.5.5 (2016-09-02)

  • testing release process in prepartion for 0.6

0.5.4 (2016-08-10)

  • series of point release to fix various small bugs

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 Distribution

talisker-0.6.0.tar.gz (53.0 kB view details)

Uploaded Source

Built Distributions

talisker-0.6.0-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

talisker-0.6.0-py2-none-any.whl (24.0 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for talisker-0.6.0.tar.gz
Algorithm Hash digest
SHA256 f96a9e67407c90d93b7600c59112cf21ec7b2f9f698061a28978959ee33e8b85
MD5 465664c77cac944bee7f5038d3827d9d
BLAKE2b-256 0e19dd770ec581f863097426b1bb6f6c449965b18edf1a4099d5e41d0f9245d3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for talisker-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d95f064c7db3d01f925e72c75f59a81c1e216c1e1d108116223ed19e41add10
MD5 4fdeee4d7264c7c5a1d1fe097cd693e4
BLAKE2b-256 6c3e4f62a721638457ec202582be6a39e98bf60b02a743227f9ab1e79bf2aacb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for talisker-0.6.0-py2-none-any.whl
Algorithm Hash digest
SHA256 f5cbd5c0e34381c54be1603ebc738db22a598250563f9278ce141efb7c3d9210
MD5 730d8d6d72fbf9da34b1b151868b4d3d
BLAKE2b-256 918c7d46a4fdaf037500e7971e6794578de2e1314555f07343f3617179ee494a

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