statsd Fix some typos in README documentation
authorOlle E. Johansson <oej@edvina.net>
Mon, 2 Jan 2017 14:07:10 +0000 (15:07 +0100)
committerOlle E. Johansson <oej@edvina.net>
Mon, 2 Jan 2017 14:07:10 +0000 (15:07 +0100)
src/modules/statsd/doc/statsd_admin.xml

index f31cd05..d3bd888 100644 (file)
@@ -17,7 +17,7 @@
         <title>Overview</title>
                <para>
                        The module provides the ability to send commands to statsd
-                       (you can use InfluxDB too) with different kind of information.
+                       (you can use InfluxDB too) with different types of information.
                        It provides native integration with statsd (https://github.com/etsy/statsd/)
                        and graphite (http://graphite.wikidot.com/).
                </para>
 
     <section>
         <title>Parameters</title>
-        <section id="statsd.p.serverIP">
+        <section id="statsd.p.ip">
             <title><varname>ip</varname>(string)</title>
             <para>
-            Statsd server ip
+            Statsd server IP address
             </para>
             <example>
                 <title>Set ip parameter</title>
@@ -44,13 +44,13 @@ modparam("statsd", "ip", "127.0.0.1")
             </example>
         </section>
 
-        <section id="statsd.p.serverPort">
+        <section id="statsd.p.port">
             <title><varname>port</varname>(string)</title>
             <para>
-            Statsd server ip
+            Statsd server port number
             </para>
             <example>
-                <title>Set ip parameter</title>
+                <title>Set port parameter</title>
                 <programlisting format="linespecific">
 ...
 modparam("statsd", "port", "8125")
@@ -70,7 +70,7 @@ modparam("statsd", "port", "8125")
                 Sets count the number of unique values passed to a key.
             </para>
             <para>
-                If that method is called multiple times with the same userid in the same sample period, that userid will only be counted once.
+                If this method is called multiple times with the same userid in the same sample period, that userid will only be counted once.
             </para>
             <para>
                 This function can be used in ALL ROUTES.
@@ -94,7 +94,9 @@ failure_route[tryagain] {
                 <function moreinfo="none">statsd_gauge(key, value)</function>
             </title>
             <para>
-                Gauges are a constant data type. They are not subject to averaging, and they don’t change unless you change them. That is, once you set a gauge value, it will be a flat line on the graph until you change it again.
+                Gauges are a constant data type. They are not subject to averaging
+               and they don’t change unless you change them. That is, once you set
+               a gauge value, it will be a flat line on the graph until you change it again.
             </para>
             <para>
                 Gauges are useful for things that are already averaged, or don’t need to reset periodically
@@ -121,13 +123,17 @@ route [gauge_method]{
                 <function moreinfo="none">statsd_start(key)</function>
             </title>
             <para>
-statsd start set a avp with the key name, and when you use statsd_stop(key), module will send to statsd the difference in milliseconds. this is useful to know the time of a sql query, or how many time take your replies.
+               statsd_start set an avp with the key name, and when 
+               statsd_stop(key) is used, the module will send statsd the difference in 
+               milliseconds. this is useful to know the time of a SQL query, or how much time your replies take.
             </para>
             <para>
-                this function can be used in all routes.
+                This function can be used in all routes.
             </para>
             <para>
-                the statsd server collects all timers under the stats.timers prefix, and will calculate the lower bound, mean, 90th percentile, upper bound, and count of each timer for each period (by the time you see it in graphite, that’s usually per minute).
+                The statsd server collects all timers under the stats.timers prefix 
+               and will calculate the lower bound, mean, 90th percentile, upper bound, and count of each
+               timer for each period (by the time it can be seen in graphite, that’s usually per minute).
             </para>
             <example>
                 <title><function>statsd_start</function> usage</title>
@@ -147,7 +153,8 @@ statsd_stop("long_mysql_query");
                 <function moreinfo="none">statsd_stop(key)</function>
             </title>
             <para>
-                statsd_stop(key) get the avp string with the key and calculate the difference from the start time. When finish app send the milliseconds to statsd.
+                statsd_stop(key) get the avp string with the key and calculate the
+               difference from the start time. When finished the milliseconds used will be sent to statsd.
             </para>
             <para>
                 This function can be used in all routes.
@@ -169,7 +176,7 @@ statsd_stop("long_mysql_query");
                 <function moreinfo="none">statsd_incr(key)</function>
             </title>
             <para>
-            Increment a counter
+            Increment a statsd counter
             </para>
             <para>
                 This function can be used in all routes.