From b4045a0c69caa616a469b36bc6df31878570c12d Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 5 Dec 2017 15:22:05 +0100 Subject: OsmoBSC: add rate counter documentation Change-Id: Ia8711dd4bc9db36a7121552dc067c7afb1051b0a --- doc/manuals/chapters/counters.adoc | 4 ++ doc/manuals/chapters/counters_generated.adoc | 76 ++++++++++++++++++++++++++++ doc/manuals/osmobsc-usermanual.adoc | 2 + 3 files changed, 82 insertions(+) create mode 100644 doc/manuals/chapters/counters.adoc create mode 100644 doc/manuals/chapters/counters_generated.adoc (limited to 'doc/manuals') 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 | <> | HDLC abort +| hdlc:bad_fcs | <> | HLDC Bad FCS +| hdlc:overrun | <> | HDLC Overrun +| alarm | <> | Alarm +| removed | <> | Line removed +|=== +// rate_ctr_group table base station controller +.bsc - base station controller +[options="header"] +|=== +| Name | Reference | Description +| chreq:total | <> | Received channel requests. +| chreq:no_channel | <> | Sent to MS no channel available. +| handover:attempted | <> | Received handover attempts. +| handover:no_channel | <> | Sent no channel available responses. +| handover:timeout | <> | Count the amount of timeouts of timer T3103. +| handover:completed | <> | Received handover completed. +| handover:failed | <> | Receive HO FAIL messages. +| paging:attempted | <> | Paging attempts for a MS. +| paging:detached | <> | Counts the amount of paging attempts which couldn't sent out any paging request because no responsible bts found. +| paging:completed | <> | Paging successful completed. +| paging:expired | <> | Paging Request expired because of timeout T3113. +| chan:rf_fail | <> | Received a RF failure indication from BTS. +| chan:rll_err | <> | Received a RLL failure with T200 cause from BTS. +| bts:oml_fail | <> | Received a TEI down on a OML link. +| bts:rsl_fail | <> | Received a TEI down on a OML link. +| bts:codec_amr_f | <> | Count the usage of AMR/F codec by channel mode requested. +| bts:codec_amr_h | <> | Count the usage of AMR/H codec by channel mode requested. +| bts:codec_efr | <> | Count the usage of EFR codec by channel mode requested. +| bts:codec_fr | <> | Count the usage of FR codec by channel mode requested. +| 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 | <> | Received location update imsi attach requests. +| loc_update_type:normal | <> | Received location update normal requests. +| loc_update_type:periodic | <> | Received location update periodic requests. +| loc_update_type:detach | <> | Received location update detach indication. +| loc_update_resp:failed | <> | Rejected location updates. +| loc_update_resp:completed | <> | Successful location updates. +| sms:submitted | <> | Received a RPDU from a MS (MO). +| sms:no_receiver | <> | Counts SMS which couldn't routed because no receiver found. +| sms:delivered | <> | Global SMS Deliver attempts. +| sms:rp_err_mem | <> | CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt. +| sms:rp_err_other | <> | Other error of MS responses on a sms delive attempt. +| sms:deliver_unknown_error | <> | Unknown error occured during sms delivery. +| call:mo_setup | <> | Received setup requests from a MS to init a MO call. +| call:mo_connect_ack | <> | Received a connect ack from MS of a MO call. Call is now succesful connected up. +| call:mt_setup | <> | Sent setup requests to the MS (MT). +| call:mt_connect | <> | Sent a connect to the MS (MT). +| call:active | <> | Count total amount of calls that ever reached active state. +| call:complete | <> | Count total amount of calls which got terminated by disconnect req or ind after reaching active state. +| 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 | <> | +|=== + 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[] -- cgit v1.2.3