OsmoBSC: add rate counter documentation

Change-Id: Ia8711dd4bc9db36a7121552dc067c7afb1051b0a

3 files changed, 82 insertions, 0 deletions

diff --git a/doc/manuals/chapters/counters.adoc b/doc/manuals/chapters/counters.adoc
new file mode 100644
index 000000000..7fbb10c6f
--- /dev/null
+++ b/doc/manuals/chapters/counters.adoc
@@ -0,0 +1,4 @@
+[[counters]]
+== Counters
+
+include::./counters_generated.adoc[]
diff --git a/doc/manuals/chapters/counters_generated.adoc b/doc/manuals/chapters/counters_generated.adoc
new file mode 100644
index 000000000..d55df072f
--- /dev/null
+++ b/doc/manuals/chapters/counters_generated.adoc
@@ -0,0 +1,76 @@
+// autogenerated by show asciidoc counters
+These counters and their description based on OsmoBSC (OsmoBSC).
+
+// generating tables for rate_ctr_group
+// rate_ctr_group table E1 Input subsystem
+.e1inp - E1 Input subsystem 
+[options="header"]
+|===
+| Name | Reference | Description
+| hdlc:abort | <<e1inp_hdlc:abort>> | HDLC abort
+| hdlc:bad_fcs | <<e1inp_hdlc:bad_fcs>> | HLDC Bad FCS
+| hdlc:overrun | <<e1inp_hdlc:overrun>> | HDLC Overrun
+| alarm | <<e1inp_alarm>> | Alarm
+| removed | <<e1inp_removed>> | Line removed
+|===
+// rate_ctr_group table base station controller
+.bsc - base station controller 
+[options="header"]
+|===
+| Name | Reference | Description
+| chreq:total | <<bsc_chreq:total>> | Received channel requests.
+| chreq:no_channel | <<bsc_chreq:no_channel>> | Sent to MS no channel available.
+| handover:attempted | <<bsc_handover:attempted>> | Received handover attempts.
+| handover:no_channel | <<bsc_handover:no_channel>> | Sent no channel available responses.
+| handover:timeout | <<bsc_handover:timeout>> | Count the amount of timeouts of timer T3103.
+| handover:completed | <<bsc_handover:completed>> | Received handover completed.
+| handover:failed | <<bsc_handover:failed>> | Receive HO FAIL messages.
+| paging:attempted | <<bsc_paging:attempted>> | Paging attempts for a MS.
+| paging:detached | <<bsc_paging:detached>> | Counts the amount of paging attempts which couldn't sent out any paging request because no responsible bts found.
+| paging:completed | <<bsc_paging:completed>> | Paging successful completed.
+| paging:expired | <<bsc_paging:expired>> | Paging Request expired because of timeout T3113.
+| chan:rf_fail | <<bsc_chan:rf_fail>> | Received a RF failure indication from BTS.
+| chan:rll_err | <<bsc_chan:rll_err>> | Received a RLL failure with T200 cause from BTS.
+| bts:oml_fail | <<bsc_bts:oml_fail>> | Received a TEI down on a OML link.
+| bts:rsl_fail | <<bsc_bts:rsl_fail>> | Received a TEI down on a OML link.
+| bts:codec_amr_f | <<bsc_bts:codec_amr_f>> | Count the usage of AMR/F codec by channel mode requested.
+| bts:codec_amr_h | <<bsc_bts:codec_amr_h>> | Count the usage of AMR/H codec by channel mode requested.
+| bts:codec_efr | <<bsc_bts:codec_efr>> | Count the usage of EFR codec by channel mode requested.
+| bts:codec_fr | <<bsc_bts:codec_fr>> | Count the usage of FR codec by channel mode requested.
+| bts:codec_hr | <<bsc_bts:codec_hr>> | Count the usage of HR codec by channel mode requested.
+|===
+// rate_ctr_group table mobile switching center
+.msc - mobile switching center 
+[options="header"]
+|===
+| Name | Reference | Description
+| loc_update_type:attach | <<msc_loc_update_type:attach>> | Received location update imsi attach requests.
+| loc_update_type:normal | <<msc_loc_update_type:normal>> | Received location update normal requests.
+| loc_update_type:periodic | <<msc_loc_update_type:periodic>> | Received location update periodic requests.
+| loc_update_type:detach | <<msc_loc_update_type:detach>> | Received location update detach indication.
+| loc_update_resp:failed | <<msc_loc_update_resp:failed>> | Rejected location updates.
+| loc_update_resp:completed | <<msc_loc_update_resp:completed>> | Successful location updates.
+| sms:submitted | <<msc_sms:submitted>> | Received a RPDU from a MS (MO).
+| sms:no_receiver | <<msc_sms:no_receiver>> | Counts SMS which couldn't routed because no receiver found.
+| sms:delivered | <<msc_sms:delivered>> | Global SMS Deliver attempts.
+| sms:rp_err_mem | <<msc_sms:rp_err_mem>> | CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt.
+| sms:rp_err_other | <<msc_sms:rp_err_other>> | Other error of MS responses on a sms delive attempt.
+| sms:deliver_unknown_error | <<msc_sms:deliver_unknown_error>> | Unknown error occured during sms delivery.
+| call:mo_setup | <<msc_call:mo_setup>> | Received setup requests from a MS to init a MO call.
+| call:mo_connect_ack | <<msc_call:mo_connect_ack>> | Received a connect ack from MS of a MO call. Call is now succesful connected up.
+| call:mt_setup | <<msc_call:mt_setup>> | Sent setup requests to the MS (MT).
+| call:mt_connect | <<msc_call:mt_connect>> | Sent a connect to the MS (MT).
+| call:active | <<msc_call:active>> | Count total amount of calls that ever reached active state.
+| call:complete | <<msc_call:complete>> | Count total amount of calls which got terminated by disconnect req or ind after reaching active state.
+| call:incomplete | <<msc_call:incomplete>> | Count total amount of call which got terminated by any other reason after reaching active state.
+|===
+// generating tables for osmo_stat_items
+// generating tables for osmo_counters
+// ungrouped osmo_counters
+.ungrouped osmo counters
+[options="header"]
+|===
+| Name | Reference | Description
+| msc.active_calls | <<ungroup_counter_msc.active_calls>> | 
+|===
+
diff --git a/doc/manuals/osmobsc-usermanual.adoc b/doc/manuals/osmobsc-usermanual.adoc
index b455897b3..2ff985da0 100644
--- a/doc/manuals/osmobsc-usermanual.adoc
+++ b/doc/manuals/osmobsc-usermanual.adoc
@@ -13,6 +13,8 @@ include::chapters/running.adoc[]
 
 include::chapters/control.adoc[]
 
+include::chapters/counters.adoc[]
+
 include::../common/chapters/vty.adoc[]
 
 include::../common/chapters/logging.adoc[]