diff options
| author | James Socol <me@jamessocol.com> | 2015-10-22 18:32:52 -0400 |
|---|---|---|
| committer | James Socol <me@jamessocol.com> | 2015-10-22 18:32:52 -0400 |
| commit | 1c972b3a7ad941556325f6ae69db838b022890d5 (patch) | |
| tree | 5398e9e81de802e39fa1e8b0044073de7fa9284c | |
| parent | 0e5826ce55a132f2090e408429c181b644aa71f8 (diff) | |
| download | pystatsd-1c972b3a7ad941556325f6ae69db838b022890d5.tar.gz | |
Document new client kwargs.
| -rw-r--r-- | docs/configure.rst | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/docs/configure.rst b/docs/configure.rst index bc945e3..ca78012 100644 --- a/docs/configure.rst +++ b/docs/configure.rst @@ -27,7 +27,8 @@ They, and their defaults, are:: statsd = StatsClient(host='localhost', port=8125, prefix=None, - maxudpsize=512) + maxudpsize=512, + ipv6=False) ``host`` is the host running the statsd server. It will support any kind of name or IP address you might use. @@ -60,6 +61,19 @@ 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! +.. versionadded:: 3.2 + +``ipv6`` tells the client explicitly to look up the host using IPv6 (``True``) +or IPv4 (``False``). + + +TCP Clients +----------- + +:ref:`TCP-based clients <tcp-chapter>` have an additional ``timeout`` argument, +which defaults to ``None``, and is passed to `settimeout +<https://docs.python.org/2/library/socket.html#socket.socket.settimeout>`. + In Django ========= |