Django Statsd Client

Contents:

Introduction

django_statsd is a middleware that uses python-statsd to log query and view durations to statsd.

• Documentation

  • http://django-stats.readthedocs.org/en/latest/

• Source

  • https://github.com/WoLpH/django-statsd

• Bug reports

  • https://github.com/WoLpH/django-statsd/issues

• Package homepage

  • https://pypi.python.org/pypi/django-statsd

• Python Statsd

  • https://github.com/WoLpH/python-statsd

• Graphite

  • http://graphite.wikidot.com

• Statsd

  • code: https://github.com/etsy/statsd
  • blog post: http://codeascraft.etsy.com/2011/02/15/measure-anything-measure-everything/

Install

To install simply execute python setup.py install. If you want to run the tests first, run python setup.py test

Usage

To install, add the following to your settings.py:

1. django_statsd to the INSTALLED_APPS setting.

2. django_statsd.middleware.StatsdMiddleware to the top of your

   MIDDLEWARE_CLASSES

3. django_statsd.middleware.StatsdMiddlewareTimer to the bottom of your

   MIDDLEWARE_CLASSES

Advanced Usage

>>> def some_view(request):
...     with request.timings('something_to_time'):
...         # do something here
...         pass
>>>
>>> def some_view(request):
...     request.timings.start('something_to_time')
...     # do something here
...     request.timings.stop('something_to_time')

django_statsd Package

django_statsd Package

django_statsd.__init__.decr(key, value=1)

django_statsd.__init__.incr(key, value=1)

django_statsd.__init__.start(key)

django_statsd.__init__.stop(key)

django_statsd.__init__.with_(key)

django_statsd.__init__.wrapper(prefix, f)

django_statsd.__init__.named_wrapper(name, f)

django_statsd.__init__.decorator(prefix)

settings Module

django_statsd.settings.STATSD_DEBUG = True

Enable warnings such as timers which are started but not finished. Defaults to DEBUG if not configured

django_statsd.settings.STATSD_HOST = '127.0.0.1'

Statsd host, defaults to 127.0.0.1

django_statsd.settings.STATSD_PORT = '8125'

Statsd port, defaults to 8125

django_statsd.settings.STATSD_PREFIX = 'some_key_prefix'

Set the global statsd prefix if needed. Otherwise use the root

django_statsd.settings.STATSD_SAMPLE_RATE = 1.0

Statsd sample rate, lowering this decreases the (random) odds of actually submitting the data. Between 0 and 1 where 1 means always

django_statsd.settings.STATSD_TAGS_LIKE = None

Enable creating tags as well as the bare version. This causes an ajax view to be stored both as the regular view name and as the ajax tag. Supported separators are _is_ and =

django_statsd.settings.STATSD_TRACK_MIDDLEWARE = True

Enable tracking all requests using the middleware

django_statsd.settings.get_setting(key, default=None)

celery Module

database Module

class django_statsd.database.TimingCursorWrapper

Bases: object

execute(*args, **kwargs)

executemany(*args, **kwargs)

json Module

middleware Module

class django_statsd.middleware.Client(prefix='view')

Bases: object

class_

alias of statsd.client.Client

get_client(*args)

submit(*args)

class django_statsd.middleware.Counter(prefix='view')

Bases: django_statsd.middleware.Client

class_

alias of statsd.counter.Counter

decrement(key, delta=1)

increment(key, delta=1)

submit(*args)

class django_statsd.middleware.DummyWith

Bases: object

class django_statsd.middleware.StatsdMiddleware(get_response)

Bases: django.utils.deprecation.MiddlewareMixin

cleanup(request)

process_exception(request, exception)

process_request(request)

process_response(request, response)

process_template_response(request, response)

process_view(request, view_func, view_args, view_kwargs)

scope = <thread._local object>

classmethod start(prefix='view')

classmethod stop(*key)

class django_statsd.middleware.StatsdMiddlewareTimer(get_response=None)

Bases: django.utils.deprecation.MiddlewareMixin

process_exception(request, exception)

process_request(request)

process_response(request, response)

process_template_response(request, response)

process_view(request, view_func, view_args, view_kwargs)

class django_statsd.middleware.Timer(prefix='view')

Bases: django_statsd.middleware.Client

class_

alias of statsd.timer.Timer

start(key)

stop(key)

submit(*args)

class django_statsd.middleware.WithTimer(timer, key)

Bases: object

django_statsd.middleware.decorator(prefix)

django_statsd.middleware.decr(key, value=1)

django_statsd.middleware.incr(key, value=1)

django_statsd.middleware.named_wrapper(name, f)

django_statsd.middleware.start(key)

django_statsd.middleware.stop(key)

django_statsd.middleware.with_(key)

django_statsd.middleware.wrapper(prefix, f)

redis Module

templates Module

urls Module

class django_statsd.urls.StatsdHTTPConnection(*args, **kwargs)

Bases: httplib.HTTPConnection

close(*args, **kwargs)

connect(*args, **kwargs)

utils Module

django_statsd.utils.get_client(name, connection=None, class_=<class 'statsd.client.Client'>)

django_statsd.utils.get_connection(host=None, port=None, sample_rate=None)

django_statsd.utils.get_counter(name, connection=None)

django_statsd.utils.get_timer(name, connection=None)

Indices and tables

• Index
• Search Page