[PATCH] osmo-gsm-manuals[master]: Update rate_ctr description

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

Max gerrit-no-reply at lists.osmocom.org
Thu Nov 23 17:56:57 UTC 2017


Review at  https://gerrit.osmocom.org/5014

Update rate_ctr description

* use example relevant to new counter names with ':' separator
* mention that 'counter' is obsolete
* mention group name and index
* use bold and monospace fonts to improve visibility

Change-Id: Ia962367bb93cb826002db6c950d23ae2102ac713
Related: OS#2550
---
M common/chapters/control_if.adoc
1 file changed, 18 insertions(+), 8 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals refs/changes/14/5014/1

diff --git a/common/chapters/control_if.adoc b/common/chapters/control_if.adoc
index e8379d9..e4558e8 100644
--- a/common/chapters/control_if.adoc
+++ b/common/chapters/control_if.adoc
@@ -150,14 +150,24 @@
 |rate_ctr.*|RO||Get rate counter value.
 |===
 
-Those read-only variables allow to get value of arbitrary counter or rate
-counter using its name e. g. "counter.net.sms.submitted" or
-"rate_ctr.per_hour.nat.bsc.sccp.conn". Of course for that to work the program
-in question have to register corresponding counter names using libosmocore
-functions. Note the difference between counter and rate_ctr access format: in
-case of rate_ctr the counter name have to be prefixed with interval
-specification which can be any of "per_sec", "per_min", "per_hour", "per_day"
-or "abs" for absolute value.
+Those read-only variables allow to get value of arbitrary
+counter using its name.
+
+For example "+rate_ctr.per_hour.bsc.0.handover:timeout+" is the number of handover timeouts per hour.
+
+Of course for that to work the program
+in question have to register corresponding counter names and groups using
+libosmocore functions.
+
+In the example above, "+bsc+" is the rate counter group name and "+0+" is its index. It is possible to
+obtain all the rate counters in a given group by requesting "+rate_ctr.per_sec.bsc.*+" variable.
+
+The rate counter group name have to be prefixed with interval
+specification which can be any of "*per_sec*", "*per_min*", "*per_hour*", "*per_day*"
+or "*abs*" for absolute value.
+
+The "+counter.*+" variables are for backwards compatibility only
+because it's functionality is superceeded by "+rate_ctr.abs+".
 
 === Control Interface python example: `bsc_control.py`
 

-- 
To view, visit https://gerrit.osmocom.org/5014
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia962367bb93cb826002db6c950d23ae2102ac713
Gerrit-PatchSet: 1
Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Owner: Max <msuraev at sysmocom.de>



More information about the gerrit-log mailing list