Skip to main content

Handler mixins for automated metric reporting

Project description

The RequestMetricsMixin mixin will automatically instrument requests by sending statsd increment and timing values as each request finishes.

Version Downloads Status Coverage License

Installation

sprockets.mixins.statsd is available on the Python Package Index and can be installed via pip or easy_install:

pip install sprockets.mixins.statsd

Example

The following RequestHandler will automatically increment a request counter and add a request duration timing value to statsd when the request finishes.

from sprockets.mixins import statsd
from tornado import web

class MyRequestHandler(statsd.RequestMetricsMixin,
                       web.RequestHandler):

    def prepare(self):
        self.statsd_prefix = 'some.overriden.value'
        super(MyRequestHandler, self).prepare()

    def get(self, *args, **kwargs):
        self.finish({'hello': 'world'})

    def on_finish(self):
        super(MyRequestHandler, self).on_finish()
        self.do_cleanup_things()

When the request has finished, the following keys would be used:

  • Counter: sprockets.counter.example.RequestHandler.GET.200
  • Timing: sprockets.timers.example.RequestHandler.GET.200

Mixin Behavior

Whenever you mix in a class in Python always ensure that the mixins, which should inherit from object, are the first ones in the inheritance list. The concrete class, in this case web.RequestHandler should be the final class inherited.

Should your Request Handler extend the finish or the prepare methods ensure that your call super otherwise you may run into strange behavior.

Project details


Release history Release notifications

This version
History Node

1.3.1

History Node

1.3.0

History Node

1.2.1

History Node

1.1.0

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sprockets.mixins.statsd-1.3.1-py2.py3-none-any.whl (8.6 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jun 26, 2015
sprockets.mixins.statsd-1.3.1.tar.gz (5.0 kB) Copy SHA256 hash SHA256 Source None Jun 26, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page