sprockets.mixins.metrics/docs/api.rst

23 lines
606 B
ReStructuredText
Raw Normal View History

2016-01-19 12:51:09 +00:00
Reference Documentation
=======================
This library defines mix-ins that record application metrics. Each mix-in
implements the same interface:
.. class:: sprockets.mixins.metrics.Mixin
.. data:: SETTINGS_KEY
Key in ``self.application.settings`` that contains this particular
mix-in's configuration data.
.. method:: record_timing(path, milliseconds)
:param str path: timing path to record
:param float milliseconds: number of milliseconds to record
Statsd Implementation
---------------------
.. autoclass:: sprockets.mixins.metrics.StatsdMixin
:members: