github/sprockets.mixins.metrics
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.mixins.metrics.git synced 2024-11-22 03:00:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix documentation.

Browse source
This commit is contained in:
Dave Shawley 2019-09-02 09:11:19 -04:00
parent 72859a6877
commit 08b3cf206b
2 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/api.rst
View file

@ -49,6 +49,9 @@ Statsd Implementation
.. autoclass:: sprockets.mixins.metrics.statsd.StatsdMixin .. autoclass:: sprockets.mixins.metrics.statsd.StatsdMixin
:members: :members:
.. autoclass:: sprockets.mixins.metrics.statsd.StatsDCollector
:members:
Testing Helpers Testing Helpers
--------------- ---------------
*So who actually tests that their metrics are emitted as they expect?* *So who actually tests that their metrics are emitted as they expect?*

13
sprockets/mixins/metrics/statsd.py
View file

@ -86,10 +86,9 @@ class StatsdMixin:
class StatsDCollector: class StatsDCollector:
"""Collects and submits stats to StatsD. """Collects and submits stats to StatsD.
This class should be constructed using the This class should be constructed using the :func:`.install` function.
:meth:`~sprockets.mixins.statsd.install` method. When installed, When installed, it is attached to the :class:`~tornado.web.Application`
it is attached to the :class:`~tornado.web.Application` instance instance for your web application.
for your web application.
:param str host: The StatsD host :param str host: The StatsD host
:param str port: The StatsD port :param str port: The StatsD port
@ -201,16 +200,16 @@ def install(application, **kwargs):
:param tornado.web.Application application: the application to :param tornado.web.Application application: the application to
install the collector into. install the collector into.
:param kwargs: keyword parameters to pass to the :param kwargs: keyword parameters to pass to the
:class:`StatsDCollector` initializer. :class:`.StatsDCollector` initializer.
:returns: :data:`True` if the client was installed successfully, :returns: :data:`True` if the client was installed successfully,
or :data:`False` otherwise. or :data:`False` otherwise.
- **host** The StatsD host. If host is not specified, the - **host** The StatsD host. If host is not specified, the
``STATSD_HOST`` environment variable, or default `127.0.0.1`, ``STATSD_HOST`` environment variable, or default `127.0.0.1`,
will be pass into the :class:`StatsDCollector`. will be pass into the :class:`.StatsDCollector`.
- **port** The StatsD port. If port is not specified, the - **port** The StatsD port. If port is not specified, the
``STATSD_PORT`` environment variable, or default `8125`, ``STATSD_PORT`` environment variable, or default `8125`,
will be pass into the :class:`StatsDCollector`. will be pass into the :class:`.StatsDCollector`.
- **namespace** The StatsD bucket to write metrics into. - **namespace** The StatsD bucket to write metrics into.
""" """