From 57d91ea7857697131c65984a331312aa472fd018 Mon Sep 17 00:00:00 2001 From: Alexander Couzens Date: Tue, 5 Dec 2017 14:54:05 +0000 Subject: OsmoPCU: add rate counter documentation Change-Id: Ieb4e1dab415a70ded5c65c21752dca497856e96f --- doc/manuals/chapters/counters.adoc | 4 + doc/manuals/chapters/counters_generated.adoc | 178 +++++++++++++++++++++++++++ doc/manuals/osmopcu-usermanual.adoc | 2 + 3 files changed, 184 insertions(+) create mode 100644 doc/manuals/chapters/counters.adoc create mode 100644 doc/manuals/chapters/counters_generated.adoc 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..2ee425e7 --- /dev/null +++ b/doc/manuals/chapters/counters_generated.adoc @@ -0,0 +1,178 @@ +// autogenerated by show asciidoc counters +These counters and their description based on Osmo-PCU 0.4.0.4-8d55 (Osmo-PCU). + +// generating tables for rate_ctr_group +// rate_ctr_group table BSSGP Peer Statistics +.bssgp:bss_ctx - BSSGP Peer Statistics +[options="header"] +|=== +| Name | Reference | Description +| packets:in | <> | Packets at BSSGP Level ( In) +| packets:out | <> | Packets at BSSGP Level (Out) +| bytes:in | <> | Bytes at BSSGP Level ( In) +| bytes:out | <> | Bytes at BSSGP Level (Out) +| blocked | <> | BVC Blocking count +| discarded | <> | BVC LLC Discarded count +| status | <> | BVC Status count +|=== +// rate_ctr_group table NSVC Peer Statistics +.ns:nsvc - NSVC Peer Statistics +[options="header"] +|=== +| Name | Reference | Description +| packets:in | <> | Packets at NS Level ( In) +| packets:out | <> | Packets at NS Level (Out) +| bytes:in | <> | Bytes at NS Level ( In) +| bytes:out | <> | Bytes at NS Level (Out) +| blocked | <> | NS-VC Block count +| dead | <> | NS-VC gone dead count +| replaced | <> | NS-VC replaced other count +| nsei-chg | <> | NS-VC changed NSEI count +| inv-nsvci | <> | NS-VCI was invalid count +| inv-nsei | <> | NSEI was invalid count +| lost:alive | <> | ALIVE ACK missing count +| lost:reset | <> | RESET ACK missing count +|=== +// rate_ctr_group table NSVC Peer Statistics +.ns:nsvc - NSVC Peer Statistics +[options="header"] +|=== +| Name | Reference | Description +| packets:in | <> | Packets at NS Level ( In) +| packets:out | <> | Packets at NS Level (Out) +| bytes:in | <> | Bytes at NS Level ( In) +| bytes:out | <> | Bytes at NS Level (Out) +| blocked | <> | NS-VC Block count +| dead | <> | NS-VC gone dead count +| replaced | <> | NS-VC replaced other count +| nsei-chg | <> | NS-VC changed NSEI count +| inv-nsvci | <> | NS-VCI was invalid count +| inv-nsei | <> | NSEI was invalid count +| lost:alive | <> | ALIVE ACK missing count +| lost:reset | <> | RESET ACK missing count +|=== +// rate_ctr_group table BTS Statistics +.bts - BTS Statistics +[options="header"] +|=== +| Name | Reference | Description +| tbf:dl:alloc | <> | TBF DL Allocated +| tbf:dl:freed | <> | TBF DL Freed +| tbf:dl:aborted | <> | TBF DL Aborted +| tbf:ul:alloc | <> | TBF UL Allocated +| tbf:ul:freed | <> | TBF UL Freed +| tbf:ul:aborted | <> | TBF UL Aborted +| tbf:reused | <> | TBF Reused +| tbf:alloc:algo-a | <> | TBF Alloc Algo A +| tbf:alloc:algo-b | <> | TBF Alloc Algo B +| tbf:failed:egprs-only | <> | TBF Failed EGPRS-only +| rlc:sent | <> | RLC Sent +| rlc:resent | <> | RLC Resent +| rlc:restarted | <> | RLC Restarted +| rlc:stalled | <> | RLC Stalled +| rlc:nacked | <> | RLC Nacked +| rlc:final_block_resent | <> | RLC Final Blk resent +| rlc:ass:timedout | <> | RLC Assign Timeout +| rlc:ass:failed | <> | RLC Assign Failed +| rlc:ack:timedout | <> | RLC Ack Timeout +| rlc:ack:failed | <> | RLC Ack Failed +| rlc:rel:timedout | <> | RLC Release Timeout +| rlc:late-block | <> | RLC Late Block +| rlc:sent-dummy | <> | RLC Sent Dummy +| rlc:sent-control | <> | RLC Sent Control +| rlc:dl_bytes | <> | RLC DL Bytes +| rlc:dl_payload_bytes | <> | RLC DL Payload Bytes +| rlc:ul_bytes | <> | RLC UL Bytes +| rlc:ul_payload_bytes | <> | RLC UL Payload Bytes +| decode:errors | <> | Decode Errors +| sba:allocated | <> | SBA Allocated +| sba:freed | <> | SBA Freed +| sba:timedout | <> | SBA Timeout +| llc:timeout | <> | Timedout Frames +| llc:dropped | <> | Dropped Frames +| llc:scheduled | <> | Scheduled Frames +| llc:dl_bytes | <> | RLC encapsulated PDUs +| llc:ul_bytes | <> | full PDUs received +| rach:requests | <> | RACH requests +| 11bit_rach:requests | <> | 11BIT_RACH requests +| spb:uplink_first_segment | <> | First seg of UL SPB +| spb:uplink_second_segment | <> | Second seg of UL SPB +| spb:downlink_first_segment | <> | First seg of DL SPB +| spb:downlink_second_segment | <> | Second seg of DL SPB +| immediate:assignment_UL | <> | Immediate Assign UL +| immediate:assignment_rej | <> | Immediate Assign Rej +| immediate:assignment_DL | <> | Immediate Assign DL +| channel:request_description | <> | Channel Request Desc +| pkt:ul_assignment | <> | Packet UL Assignment +| pkt:access_reject | <> | Packet Access Reject +| pkt:dl_assignment | <> | Packet DL Assignment +| ul:control | <> | UL control Block +| ul:assignment_poll_timeout | <> | UL Assign Timeout +| ul:assignment_failed | <> | UL Assign Failed +| dl:assignment_timeout | <> | DL Assign Timeout +| dl:assignment_failed | <> | DL Assign Failed +| pkt:ul_ack_nack_timeout | <> | PUAN Poll Timeout +| pkt:ul_ack_nack_failed | <> | PUAN poll Failed +| pkt:dl_ack_nack_timeout | <> | PDAN poll Timeout +| pkt:dl_ack_nack_failed | <> | PDAN poll Failed +| gprs:downlink_cs1 | <> | CS1 downlink +| gprs:downlink_cs2 | <> | CS2 downlink +| gprs:downlink_cs3 | <> | CS3 downlink +| gprs:downlink_cs4 | <> | CS4 downlink +| egprs:downlink_mcs1 | <> | MCS1 downlink +| egprs:downlink_mcs2 | <> | MCS2 downlink +| egprs:downlink_mcs3 | <> | MCS3 downlink +| egprs:downlink_mcs4 | <> | MCS4 downlink +| egprs:downlink_mcs5 | <> | MCS5 downlink +| egprs:downlink_mcs6 | <> | MCS6 downlink +| egprs:downlink_mcs7 | <> | MCS7 downlink +| egprs:downlink_mcs8 | <> | MCS8 downlink +| egprs:downlink_mcs9 | <> | MCS9 downlink +| gprs:uplink_cs1 | <> | CS1 Uplink +| gprs:uplink_cs2 | <> | CS2 Uplink +| gprs:uplink_cs3 | <> | CS3 Uplink +| gprs:uplink_cs4 | <> | CS4 Uplink +| egprs:uplink_mcs1 | <> | MCS1 Uplink +| egprs:uplink_mcs2 | <> | MCS2 Uplink +| egprs:uplink_mcs3 | <> | MCS3 Uplink +| egprs:uplink_mcs4 | <> | MCS4 Uplink +| egprs:uplink_mcs5 | <> | MCS5 Uplink +| egprs:uplink_mcs6 | <> | MCS6 Uplink +| egprs:uplink_mcs7 | <> | MCS7 Uplink +| egprs:uplink_mcs8 | <> | MCS8 Uplink +| egprs:uplink_mcs9 | <> | MCS9 Uplink +|=== +// generating tables for osmo_stat_items +NSVC Peer Statistics +// osmo_stat_item_group table NSVC Peer Statistics +.ns.nsvc - NSVC Peer Statistics +[options="header"] +|=== +| Name | Reference | Description | Unit +| alive.delay | <> | ALIVE response time | ms +|=== +NSVC Peer Statistics +// osmo_stat_item_group table NSVC Peer Statistics +.ns.nsvc - NSVC Peer Statistics +[options="header"] +|=== +| Name | Reference | Description | Unit +| alive.delay | <> | ALIVE response time | ms +|=== +BTS Statistics +// osmo_stat_item_group table BTS Statistics +.bts - BTS Statistics +[options="header"] +|=== +| Name | Reference | Description | Unit +| ms.present | <> | MS Present | +|=== +// generating tables for osmo_counters +// ungrouped osmo_counters +.ungrouped osmo counters +[options="header"] +|=== +| Name | Reference | Description +|=== + + diff --git a/doc/manuals/osmopcu-usermanual.adoc b/doc/manuals/osmopcu-usermanual.adoc index f47a0a9e..a72e947a 100644 --- a/doc/manuals/osmopcu-usermanual.adoc +++ b/doc/manuals/osmopcu-usermanual.adoc @@ -17,6 +17,8 @@ include::../common/chapters/logging.adoc[] include::chapters/configuration.adoc[] +include::chapters/counters.adoc[] + include::../common/chapters/gb.adoc[] include::../common/chapters/port_numbers.adoc[] -- cgit v1.2.3