From 37ea11e072e095f64cffd3784eb7ab5c191fbaf3 Mon Sep 17 00:00:00 2001
From: Daniel Willmann <dwillmann@sysmocom.de>
Date: Wed, 19 Jun 2019 12:47:26 +0200
Subject: manuals: Add counter documentation

Change-Id: I994ad6aae7f409e0f15ff1d388127e16243b378a
Related: OS#1700
---
 doc/manuals/chapters/counters.adoc           |  4 ++
 doc/manuals/chapters/counters_generated.adoc | 64 ++++++++++++++++++++++++++++
 doc/manuals/osmobts-usermanual.adoc          |  4 ++
 3 files changed, 72 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 00000000..7fbb10c6
--- /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 00000000..6a37ffa5
--- /dev/null
+++ b/doc/manuals/chapters/counters_generated.adoc
@@ -0,0 +1,64 @@
+
+// autogenerated by show asciidoc counters
+These counters and their description based on OsmoBTS 0.8.1.346-33ed (OsmoBTS).
+
+=== Rate Counters
+
+// 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 cell broadcast channel
+.cbch - cell broadcast channel
+[options="header"]
+|===
+| Name | Reference | Description
+| cbch:rcvd_queued | <<cbch_cbch:rcvd_queued>> | Received + queued CBCH messages (Abis)
+| cbch:rcvd_dropped | <<cbch_cbch:rcvd_dropped>> | Received + dropped CBCH messages (Abis)
+| cbch:sent_single | <<cbch_cbch:sent_single>> | Sent single CBCH messages (Um)
+| cbch:sent_default | <<cbch_cbch:sent_default>> | Sent default CBCH messages (Um)
+| cbch:sent_null | <<cbch_cbch:sent_null>> | Sent NULL CBCH messages (Um)
+|===
+// rate_ctr_group table cell broadcast channel
+.cbch - cell broadcast channel
+[options="header"]
+|===
+| Name | Reference | Description
+| cbch:rcvd_queued | <<cbch_cbch:rcvd_queued>> | Received + queued CBCH messages (Abis)
+| cbch:rcvd_dropped | <<cbch_cbch:rcvd_dropped>> | Received + dropped CBCH messages (Abis)
+| cbch:sent_single | <<cbch_cbch:sent_single>> | Sent single CBCH messages (Um)
+| cbch:sent_default | <<cbch_cbch:sent_default>> | Sent default CBCH messages (Um)
+| cbch:sent_null | <<cbch_cbch:sent_null>> | Sent NULL CBCH messages (Um)
+|===
+// rate_ctr_group table base transceiver station
+.bts - base transceiver station
+[options="header"]
+|===
+| Name | Reference | Description
+| paging:rcvd | <<bts_paging:rcvd>> | Received paging requests (Abis)
+| paging:drop | <<bts_paging:drop>> | Dropped paging requests (Abis)
+| paging:sent | <<bts_paging:sent>> | Sent paging requests (Um)
+| rach:rcvd | <<bts_rach:rcvd>> | Received RACH requests (Um)
+| rach:drop | <<bts_rach:drop>> | Dropped RACH requests (Um)
+| rach:handover | <<bts_rach:handover>> | Received RACH requests (Handover)
+| rach:cs | <<bts_rach:cs>> | Received RACH requests (CS/Abis)
+| rach:ps | <<bts_rach:ps>> | Received RACH requests (PS/PCU)
+| agch:rcvd | <<bts_agch:rcvd>> | Received AGCH requests (Abis)
+| agch:sent | <<bts_agch:sent>> | Sent AGCH requests (Abis)
+| agch:delete | <<bts_agch:delete>> | Sent AGCH DELETE IND (Abis)
+|===
+== Osmo Stat Items
+
+// generating tables for osmo_stat_items
+== Osmo Counters
+
+// generating tables for osmo_counters
+// there are no ungrouped osmo_counters
diff --git a/doc/manuals/osmobts-usermanual.adoc b/doc/manuals/osmobts-usermanual.adoc
index 40db72b8..55087b23 100644
--- a/doc/manuals/osmobts-usermanual.adoc
+++ b/doc/manuals/osmobts-usermanual.adoc
@@ -14,6 +14,10 @@ include::{srcdir}/chapters/interfaces.adoc[]
 
 include::{srcdir}/chapters/control.adoc[]
 
+include::./common/chapters/counters-overview.adoc[]
+
+include::{srcdir}/chapters/counters.adoc[]
+
 include::./common/chapters/vty.adoc[]
 
 include::./common/chapters/logging.adoc[]
-- 
cgit v1.2.3