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

Add configuration docs

Browse source
This commit is contained in:
Robin Klingsberg 2019-03-02 10:41:19 -05:00
parent b614c7136c
commit b04b140330
3 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/configuration.rst Normal file
View file

@ -0,0 +1,16 @@
Configuration
=============
sprockets.mixins.metrics has the ability to be configured via environment variables.
The following environment variables are recognized:
+-----------------+---------------------------------------+----------+---------------+
| Name | Description | Required | Default Value |
+-----------------+---------------------------------------+----------+---------------+
| STATSD_HOST | The StatsD host to connect to | No | 127.0.0.1 |
+-----------------+---------------------------------------+----------+---------------+
| STATSD_PORT | The port on which StatsD is listening | No | 8125 |
+-----------------+---------------------------------------+----------+---------------+
| STATSD_PROTOCOL | The transport-layer protocol to use | No | 8125 |
+-----------------+---------------------------------------+----------+---------------+

4
docs/history.rst
View file

@ -3,6 +3,10 @@
Release History Release History
=============== ===============
`Next Release`_
---------------
- Add configuration documentation
`4.0.0`_ (06-Feb-2019) `4.0.0`_ (06-Feb-2019)
---------------------- ----------------------
- Add support for Tornado 5 - Add support for Tornado 5

1
docs/index.rst
View file

@ -8,6 +8,7 @@ License
:hidden: :hidden:
api api
configuration
examples examples
contributing contributing
history history