[sr-dev] git:master:6138e52d: modules: readme files regenerated - statsd ...

Module: kamailio Branch: master Commit: 6138e52dfa7f0ab5b7345a5f16ff285068e04d5d URL: https://github.com/kamailio/kamailio/commit/6138e52dfa7f0ab5b7345a5f16ff285… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2017-01-02T15:16:10+01:00 modules: readme files regenerated - statsd ... --- Modified: src/modules/statsd/README --- Diff: https://github.com/kamailio/kamailio/commit/6138e52dfa7f0ab5b7345a5f16ff285… Patch: https://github.com/kamailio/kamailio/commit/6138e52dfa7f0ab5b7345a5f16ff285… --- diff --git a/src/modules/statsd/README b/src/modules/statsd/README index 3d7c836..2428060 100644 --- a/src/modules/statsd/README +++ b/src/modules/statsd/README @@ -35,7 +35,7 @@ Eloy Coto Pereiro List of Examples 1.1. Set ip parameter - 1.2. Set ip parameter + 1.2. Set port parameter 1.3. statsd_set usage 1.4. statsd_set usage 1.5. statsd_start usage @@ -65,7 +65,7 @@ Chapter 1. Admin Guide 1. Overview The module provides the ability to send commands to statsd (you can use - InfluxDB too) with different kind of information. It provides native + InfluxDB too) with different types of information. It provides native integration with statsd (https://github.com/etsy/statsd/) and graphite (http://graphite.wikidot.com/). @@ -79,7 +79,7 @@ Chapter 1. Admin Guide 2.1. ip(string) - Statsd server ip + Statsd server IP address Example 1.1. Set ip parameter ... @@ -88,9 +88,9 @@ modparam("statsd", "ip", "127.0.0.1") 2.2. port(string) - Statsd server ip + Statsd server port number - Example 1.2. Set ip parameter + Example 1.2. Set port parameter ... modparam("statsd", "port", "8125") ... @@ -108,7 +108,7 @@ modparam("statsd", "port", "8125") Sets count the number of unique values passed to a key. - If that method is called multiple times with the same userid in the + If this method is called multiple times with the same userid in the same sample period, that userid will only be counted once. This function can be used in ALL ROUTES. @@ -124,7 +124,7 @@ failure_route[tryagain] { 3.2. statsd_gauge(key, value) - Gauges are a constant data type. They are not subject to averaging, and + 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. @@ -144,16 +144,16 @@ route [gauge_method]{ 3.3. statsd_start(key) - 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. - this function can be used in all routes. + This function can be used in all routes. - 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 + 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). Example 1.5. statsd_start usage @@ -166,8 +166,8 @@ statsd_stop("long_mysql_query"); 3.4. statsd_stop(key) 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. + difference from the start time. When finished the milliseconds used + will be sent to statsd. This function can be used in all routes. @@ -180,7 +180,7 @@ statsd_stop("long_mysql_query"); 3.5. statsd_incr(key) - Increment a counter + Increment a statsd counter This function can be used in all routes.