diff options
author | Alexander Couzens <lynxis@fe80.eu> | 2017-12-05 15:16:46 +0000 |
---|---|---|
committer | Neels Hofmeyr <neels@hofmeyr.de> | 2018-11-27 18:10:00 +0100 |
commit | a6e189f639850eccae20fe8ea4d1c556c508819e (patch) | |
tree | 1441e4f405913041b4e8a1a0f6145ae475f01988 | |
parent | 54828cdd79d2298b512c2be5ceabd2dcc4588292 (diff) |
OsmoSGSN: add rate counter documentation
Change-Id: I4c5d5744f961a92bc7c8888ca739d1e8a8a0be9c
-rw-r--r-- | doc/manuals/chapters/counters.adoc | 4 | ||||
-rw-r--r-- | doc/manuals/chapters/counters_generated.adoc | 121 | ||||
-rw-r--r-- | doc/manuals/osmosgsn-usermanual.adoc | 2 |
3 files changed, 127 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..756a4a54c --- /dev/null +++ b/doc/manuals/chapters/counters_generated.adoc @@ -0,0 +1,121 @@ +// autogenerated by show asciidoc counters +These counters and their description based on OsmoSGSN UNKNOWN (OsmoSGSN). + +// 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 | <<bssgp:bss_ctx_packets:in>> | Packets at BSSGP Level ( In) +| packets:out | <<bssgp:bss_ctx_packets:out>> | Packets at BSSGP Level (Out) +| bytes:in | <<bssgp:bss_ctx_bytes:in>> | Bytes at BSSGP Level ( In) +| bytes:out | <<bssgp:bss_ctx_bytes:out>> | Bytes at BSSGP Level (Out) +| blocked | <<bssgp:bss_ctx_blocked>> | BVC Blocking count +| discarded | <<bssgp:bss_ctx_discarded>> | BVC LLC Discarded count +| status | <<bssgp:bss_ctx_status>> | BVC Status count +|=== +// rate_ctr_group table BSSGP Peer Statistics +.bssgp:bss_ctx - BSSGP Peer Statistics +[options="header"] +|=== +| Name | Reference | Description +| packets:in | <<bssgp:bss_ctx_packets:in>> | Packets at BSSGP Level ( In) +| packets:out | <<bssgp:bss_ctx_packets:out>> | Packets at BSSGP Level (Out) +| bytes:in | <<bssgp:bss_ctx_bytes:in>> | Bytes at BSSGP Level ( In) +| bytes:out | <<bssgp:bss_ctx_bytes:out>> | Bytes at BSSGP Level (Out) +| blocked | <<bssgp:bss_ctx_blocked>> | BVC Blocking count +| discarded | <<bssgp:bss_ctx_discarded>> | BVC LLC Discarded count +| status | <<bssgp:bss_ctx_status>> | BVC Status count +|=== +// rate_ctr_group table NSVC Peer Statistics +.ns:nsvc - NSVC Peer Statistics +[options="header"] +|=== +| Name | Reference | Description +| packets:in | <<ns:nsvc_packets:in>> | Packets at NS Level ( In) +| packets:out | <<ns:nsvc_packets:out>> | Packets at NS Level (Out) +| bytes:in | <<ns:nsvc_bytes:in>> | Bytes at NS Level ( In) +| bytes:out | <<ns:nsvc_bytes:out>> | Bytes at NS Level (Out) +| blocked | <<ns:nsvc_blocked>> | NS-VC Block count +| dead | <<ns:nsvc_dead>> | NS-VC gone dead count +| replaced | <<ns:nsvc_replaced>> | NS-VC replaced other count +| nsei-chg | <<ns:nsvc_nsei-chg>> | NS-VC changed NSEI count +| inv-nsvci | <<ns:nsvc_inv-nsvci>> | NS-VCI was invalid count +| inv-nsei | <<ns:nsvc_inv-nsei>> | NSEI was invalid count +| lost:alive | <<ns:nsvc_lost:alive>> | ALIVE ACK missing count +| lost:reset | <<ns:nsvc_lost:reset>> | RESET ACK missing count +|=== +// rate_ctr_group table SGSN Overall Statistics +.sgsn - SGSN Overall Statistics +[options="header"] +|=== +| Name | Reference | Description +| llc:dl_bytes | <<sgsn_llc:dl_bytes>> | Count sent LLC bytes before giving it to the bssgp layer +| llc:ul_bytes | <<sgsn_llc:ul_bytes>> | Count sucessful received LLC bytes (encrypt & fcs correct) +| llc:dl_packets | <<sgsn_llc:dl_packets>> | Count sucessful sent LLC packets before giving it to the bssgp layer +| llc:ul_packets | <<sgsn_llc:ul_packets>> | Count sucessful received LLC packets (encrypt & fcs correct) +| gprs:attach_requested | <<sgsn_gprs:attach_requested>> | Received attach requests +| gprs:attach_accepted | <<sgsn_gprs:attach_accepted>> | Sent attach accepts +| gprs:attach_rejected | <<sgsn_gprs:attach_rejected>> | Sent attach rejects +| gprs:detach_requested | <<sgsn_gprs:detach_requested>> | Received detach requests +| gprs:detach_acked | <<sgsn_gprs:detach_acked>> | Sent detach acks +| gprs:routing_area_requested | <<sgsn_gprs:routing_area_requested>> | Received routing area requests +| gprs:routing_area_requested | <<sgsn_gprs:routing_area_requested>> | Sent routing area acks +| gprs:routing_area_requested | <<sgsn_gprs:routing_area_requested>> | Sent routing area rejects +| pdp:activate_requested | <<sgsn_pdp:activate_requested>> | Received activate requests +| pdp:activate_rejected | <<sgsn_pdp:activate_rejected>> | Sent activate rejects +| pdp:activate_accepted | <<sgsn_pdp:activate_accepted>> | Sent activate accepts +| pdp:request_activated | <<sgsn_pdp:request_activated>> | unused +| pdp:request_activate_rejected | <<sgsn_pdp:request_activate_rejected>> | unused +| pdp:modify_requested | <<sgsn_pdp:modify_requested>> | unused +| pdp:modify_accepted | <<sgsn_pdp:modify_accepted>> | unused +| pdp:dl_deactivate_requested | <<sgsn_pdp:dl_deactivate_requested>> | Sent deactivate requests +| pdp:dl_deactivate_accepted | <<sgsn_pdp:dl_deactivate_accepted>> | Sent deactivate accepted +| pdp:ul_deactivate_requested | <<sgsn_pdp:ul_deactivate_requested>> | Received deactivate requests +| pdp:ul_deactivate_accepted | <<sgsn_pdp:ul_deactivate_accepted>> | Received deactivate accepts +|=== +// rate_ctr_group table NSVC Peer Statistics +.ns:nsvc - NSVC Peer Statistics +[options="header"] +|=== +| Name | Reference | Description +| packets:in | <<ns:nsvc_packets:in>> | Packets at NS Level ( In) +| packets:out | <<ns:nsvc_packets:out>> | Packets at NS Level (Out) +| bytes:in | <<ns:nsvc_bytes:in>> | Bytes at NS Level ( In) +| bytes:out | <<ns:nsvc_bytes:out>> | Bytes at NS Level (Out) +| blocked | <<ns:nsvc_blocked>> | NS-VC Block count +| dead | <<ns:nsvc_dead>> | NS-VC gone dead count +| replaced | <<ns:nsvc_replaced>> | NS-VC replaced other count +| nsei-chg | <<ns:nsvc_nsei-chg>> | NS-VC changed NSEI count +| inv-nsvci | <<ns:nsvc_inv-nsvci>> | NS-VCI was invalid count +| inv-nsei | <<ns:nsvc_inv-nsei>> | NSEI was invalid count +| lost:alive | <<ns:nsvc_lost:alive>> | ALIVE ACK missing count +| lost:reset | <<ns:nsvc_lost:reset>> | RESET ACK missing count +|=== +// 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 | <<ns.nsvc_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 | <<ns.nsvc_alive.delay>> | ALIVE response time | ms +|=== +// generating tables for osmo_counters +// ungrouped osmo_counters +.ungrouped osmo counters +[options="header"] +|=== +| Name | Reference | Description +|=== + + diff --git a/doc/manuals/osmosgsn-usermanual.adoc b/doc/manuals/osmosgsn-usermanual.adoc index 79c94f698..a6a77099e 100644 --- a/doc/manuals/osmosgsn-usermanual.adoc +++ b/doc/manuals/osmosgsn-usermanual.adoc @@ -27,6 +27,8 @@ include::../common/chapters/oap.adoc[] include::chapters/gsup.adoc[] +include::chapters/counters.adoc[] + include::../common/chapters/port_numbers.adoc[] include::../common/chapters/bibliography.adoc[] |