diff options
author | James Socol <me@jamessocol.com> | 2015-03-18 08:40:58 -0400 |
---|---|---|
committer | James Socol <me@jamessocol.com> | 2015-03-18 08:40:58 -0400 |
commit | e4b160f2903670d2280bc3d92c2b18651030baf5 (patch) | |
tree | e6490cf8d72691d0e3539a1ddfc84e587401a0e7 | |
parent | 6e79b5d79adb82b6bc5b44598e45a712e32a2629 (diff) | |
download | pystatsd-e4b160f2903670d2280bc3d92c2b18651030baf5.tar.gz |
Clean up new docs a little.
-rw-r--r-- | docs/reference.rst | 48 | ||||
-rw-r--r-- | docs/tcp.rst | 19 |
2 files changed, 37 insertions, 30 deletions
diff --git a/docs/reference.rst b/docs/reference.rst index e4527a7..860b00f 100644 --- a/docs/reference.rst +++ b/docs/reference.rst @@ -9,9 +9,9 @@ statsd_ server supports. .. note:: - Each public API method supports a ``rate`` parameter, but statsd - doesn't always use it the same way. See the :ref:`types-chapter` for - more information. + Each public stats API method supports a ``rate`` parameter, but + statsd doesn't always use it the same way. See the + :ref:`types-chapter` for more information. .. _StatsClient: @@ -21,7 +21,7 @@ statsd_ server supports. :: - StatsClient(host='localhost', port=8125, prefix=None) + StatsClient(host='localhost', port=8125, prefix=None, maxudpsize=512) Create a new ``StatsClient`` instance with the appropriate connection and prefix information. @@ -33,6 +33,10 @@ and prefix information. * ``prefix``: a prefix to distinguish and group stats from an application or environment. +* ``maxudpsize``: the largest safe UDP packet to save. 512 is generally + considered safe for the public internet, but private networks may + support larger packet sizes. + .. _incr: @@ -297,12 +301,13 @@ and prefix information. * ``timeout``: socket timeout for any actions on the connection socket. -``TCPStatsClient`` implements all methods of ``StatsClient``, with the -difference that it is not thread safe and it can raise exceptions on -connection errors. On the contrary to ``StatsClient`` it uses a ``TCP`` -connection to connect to Statsd. -Additionally to the methods of ``StatsClient`` it has a few which are -specific to ``TCP`` connections. +``TCPStatsClient`` implements all methods of ``StatsClient``, including +``pipeline()``, with the difference that it is not thread safe and it +can raise exceptions on connection errors. Unlike ``StatsClient`` it +uses a TCP connection to communicate with StatsD. + +In addition to the stats methods, ``TCPStatsClient`` supports the +following TCP-specific methods. .. _tcp_close: @@ -318,9 +323,9 @@ specific to ``TCP`` connections. statsd.incr('some.event') statsd.close() -Closes a connection that's currently open and deletes it's socket. If this is -called on a ``TCPStatsClient`` which currently has no open connection it is a -non-action. +Closes a connection that's currently open and deletes it's socket. If +this is called on a ``TCPStatsClient`` which currently has no open +connection it is a non-action. .. _tcp_connect: @@ -337,11 +342,11 @@ non-action. statsd.close() statsd.connect() # creates new connection -Creates a connection to Statsd. If there are errors like connection timed out -or connection refused, the according exceptions will be raised. It is usually -not necessary to call this method because sending data to Statsd will call -``connect`` implicitely if the current instance of ``TCPStatsClient`` does not -already hold an open connection. +Creates a connection to StatsD. If there are errors like connection +timed out or connection refused, the according exceptions will be +raised. It is usually not necessary to call this method because sending +data to StatsD will call ``connect`` implicitely if the current instance +of ``TCPStatsClient`` does not already hold an open connection. .. _tcp_reconnect: @@ -357,9 +362,10 @@ already hold an open connection. statsd.incr('some.event') statsd.reconnect() # closes open connection and creates new one -Closes a currently existing connection and replaces it with a new one. If no -connection exists already it will simply create a new one. Internally this -does nothing else than calling ``close()`` and ``connect()``. +Closes a currently existing connection and replaces it with a new one. +If no connection exists already it will simply create a new one. +Internally this does nothing else than calling ``close()`` and +``connect()``. .. _statsd: https://github.com/etsy/statsd diff --git a/docs/tcp.rst b/docs/tcp.rst index 3c81af6..5437ac5 100644 --- a/docs/tcp.rst +++ b/docs/tcp.rst @@ -4,16 +4,17 @@ TCPStatsClient ============== -The ``TCPStatsClient`` class has a very similar interface to ``StatsClient``, -but internally it uses ``TCP`` connections instead of ``UDP``. These are the -main differencies when using ``TCPStatsClient`` compared to ``StatsClient``: +The ``TCPStatsClient`` class has a very similar interface to +``StatsClient``, but internally it uses TCP connections instead of UDP. +These are the main differencies when using ``TCPStatsClient`` compared +to ``StatsClient``: -* The constructor supports a ``timeout`` parameter to set a timeout on all - socket actions. +* The constructor supports a ``timeout`` parameter to set a timeout on + all socket actions. -* The methods ``connect`` and all methods that send data can potentially raise +* ``connect()`` and all methods that send data can potentially raise socket exceptions. -* It is not thread-safe, so it is recommended to not share it across threads - unless a lot of attention is paid to make sure that no two threads ever use - it at once. +* **It is not thread-safe**, so it is recommended to not share it across + threads unless a lot of attention is paid to make sure that no two + threads ever use it at once. |