diff options
author | Daniel Willmann <dwillmann@sysmocom.de> | 2019-04-04 11:28:33 +0200 |
---|---|---|
committer | Daniel Willmann <dwillmann@sysmocom.de> | 2019-04-15 14:06:32 +0000 |
commit | 95be64fc37ccdbe3ed16893fd2971d00e967b034 (patch) | |
tree | 209cf5add6d6d63e4a2785655a8f5e173219a58a | |
parent | a7b4d1b48f2634df7fdc392a819fc99cc2760719 (diff) |
Add a chapter to explain our different counters
Change-Id: I01b8529136450cb50e48b0fb5c17cb2daa5e24c3
-rw-r--r-- | common/chapters/counters-overview.adoc | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/common/chapters/counters-overview.adoc b/common/chapters/counters-overview.adoc new file mode 100644 index 0000000..fbdef30 --- /dev/null +++ b/common/chapters/counters-overview.adoc @@ -0,0 +1,50 @@ +[[common-counters]] +== Osmocom Counters + +The following gives an overview of all the types of counters available: + +=== Osmo Counters + +Osmo counters are the oldest type of counters added to Osmocom projects. +They are not grouped. + +* Printed as part of VTY show stats +* Increment, Decrement +* Accessible through the control interface: counter.<counter_name> + +=== Rate Counters + +Rate counters count rates of events. + +* Printed as part of VTY show stats +* Intervals: per second, minute, hour, day or absolute value +* Increment only +* Accessible through the control interface +* Rate counters are grouped and different instances per group can exist + +The control interface command to get a counter (group) is: + +rate_ctr.per_{sec,min,hour,day,abs}.<group_name>.<idx>.[counter_name] + +It is possible to get all counters from a group by omitting the counter name + +=== Stat Item + +Stat items are a grouped replacement for osmo counters, but not many stat +items are available yet. + +* Printed as part of VTY show stats +* Replacement for osmo counters +* Not yet available through the control interface +* Grouped and indexed like rate counters +* Items have a unit +* Keeps a list of the last values measured, so could return an average, min, + max, std. deviation + +=== Stats Reporter + +Statsd stats reporter can send osmo counter, rate counter and stats item values to statsd + +See the stats reporter command of the VTY reference for details on how to +setup the connection to statsd. + |