File: statsd.rst

package info (click to toggle)
hypercorn 0.17.3-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 908 kB
  • sloc: python: 7,839; makefile: 24; sh: 6
file content (34 lines) | stat: -rw-r--r-- 1,240 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.. _using_statsd:

Statsd Logging
==============

Hypercorn can optionally log metrics using the `StatsD
<https://github.com/etsy/statsd>`_ or `DogStatsD
<https://docs.datadoghq.com/developers/dogstatsd/>`_ protocols. The
metrics logged are,

- ``hypercorn.requests``: rate of requests
- ``hypercorn.request.duration``: request duration in milliseconds
- ``hypercorn.request.status.[#code]``: rate of responses by status
  code
- ``hypercorn.log.critical``: rate of critical log messages
- ``hypercorn.log.error``: rate of error log messages
- ``hypercorn.log.warning``: rate of warning log messages
- ``hypercorn.log.exception``: rate of exceptional log messages

Usage
-----

Setting the config ``statsd_host`` to ``[host]:[port]`` will result in
these metrics being set to that host, port combination. The config
``statsd_prefix`` can be used to prefix all metrics and
``dogstatsd_tags`` can be used to add tags to each metric.

Customising the statsd logger
-----------------------------

The statsd logger class can be customised by calling
``set_statsd_logger_class`` method of the ``Config`` class. This is
only possible when using the python based configuration file. The
``hypercorn.statsd.StatsdLogger`` class is used by default.