diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configure.rst | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/configure.rst b/docs/configure.rst index bc945e3..1201c7c 100644 --- a/docs/configure.rst +++ b/docs/configure.rst @@ -26,15 +26,20 @@ They, and their defaults, are:: statsd = StatsClient(host='localhost', port=8125, + ipv6=False, prefix=None, maxudpsize=512) -``host`` is the host running the statsd server. It will support any kind -of name or IP address you might use. +``host`` is the host running the statsd server. If a hostname is given, +will lookup an IP v4 or v6 address based on the value of ``ipv6``. If an +address is given, the family should match ``ipv6``. ``port`` is the statsd server port. The default for both server and client is ``8125``. +``ipv6`` enables the use of IPv6. Since the Etsy server defaults to v4 +only, the default is ``False``. + ``prefix`` helps distinguish multiple applications or environments using the same statsd server. It will be prepended to all stats, automatically. For example:: @@ -60,6 +65,10 @@ on the internet. On a controlled local network or when the statsd server is running on 127.0.0.1 larger values can decrease the number of UDP packets when pipelining many metrics. Use with care! +.. versionchanged:: 3.2 + +``ipv6`` and + In Django ========= @@ -108,4 +117,5 @@ and then in your Python application, you can simply do:: environment. .. _statsd: https://github.com/etsy/statsd +.. _StatsD: https://github.com/etsy/statsd .. _Django: https://www.djangoproject.com/ |