Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 58 lines (41 sloc) 2.376 kb
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
1 TCP Stats Interface
2 -------------------
3
4 A really simple TCP management interface is available by default on port 8126
5 or overriden in the configuration file. Inspired by the memcache stats approach
6 this can be used to monitor a live statsd server. You can interact with the
7 management server by telnetting to port 8126, the following commands are
8 available:
9
10 * stats - some stats about the running server
11 * counters - a dump of all the current counters
8cd74ba @sreuter Update admin_interface.md
sreuter authored
12 * gauges - a dump of all the current gauges
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
13 * timers - a dump of the current timers
d8ab2fd @draco2003 Update docs to include del* commands
draco2003 authored
14 * delcounters - delete a counter or folder of counters
15 * delgauges - delete a gauge or folder of gauges
16 * deltimers - delete a timer or folder of timers
8dadf9f @draco2003 Add health status functionality
draco2003 authored
17 * health - a way to set the health status of statsd
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
18
19 The stats output currently will give you:
20
21 * uptime: the number of seconds elapsed since statsd started
d8ab2fd @draco2003 Update docs to include del* commands
draco2003 authored
22 * messages.last_msg_seen: the number of elapsed seconds since statsd received a message
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
23 * messages.bad_lines_seen: the number of bad lines seen since startup
24
d8ab2fd @draco2003 Update docs to include del* commands
draco2003 authored
25 You can use the del commands to delete an individual metric like this :
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
26
27 #to delete counter sandbox.test.temporary
d8ab2fd @draco2003 Update docs to include del* commands
draco2003 authored
28 echo "delcounters sandbox.test.temporary" | nc 127.0.0.1 8126
29
30 Or you can use the del command to delete a folder of metrics like this :
31
32 #to delete counters sandbox.test.*
33 echo "delcounters sandbox.test.*" | nc 127.0.0.1 8126
34
35
36 Each backend will also publish a set of statistics, prefixed by its module name.
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
37
38 Graphite:
39
bae1912 @Dieterbe fix description of graphite.{last_flush,last_exception}
Dieterbe authored
40 * graphite.last_flush: unix timestamp of last successful flush to graphite
41 * graphite.last_exception: unix timestamp of last exception thrown whilst flushing to graphite
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
42 * graphite.flush_length: the length of the string sent to graphite
43 * graphite.flush_time: the time it took to send the data to graphite
44
45 Those statistics will also be sent to graphite under the namespaces
46 `stats.statsd.graphiteStats.last_exception` and
47 `stats.statsd.graphiteStats.last_flush`.
48
49 A simple nagios check can be found in the utils/ directory that can be used to
50 check metric thresholds, for example the number of seconds since the last
51 successful flush to graphite.
52
8dadf9f @draco2003 Add health status functionality
draco2003 authored
53 The health output:
54 * the health command alone allows you to see the current health status.
55 * using health up or health down, you can change the current health status.
56 * the healthStatus configuration option allows you to set the default health status at start.
1ea6836 @draco2003 Initial Doc Split starting point
draco2003 authored
57
Something went wrong with that request. Please try again.