diff options
author | Daniel Willmann <dwillmann@sysmocom.de> | 2019-06-19 14:23:36 +0200 |
---|---|---|
committer | Daniel Willmann <dwillmann@sysmocom.de> | 2019-07-24 10:41:28 +0200 |
commit | 6daac87bd2aabfca799b8b5929faec1eb3e13f7d (patch) | |
tree | f7a06d8673d9524c0314ff0a1c1dcb35a530f862 /doc | |
parent | 05fee6dbeee0ca3599aa6714b3863824a91c70d8 (diff) |
manuals: Update vty/counter documentation
Change-Id: Id7245eb1011d1f04d5dfa1503a96d100bc98344c
Related: OS#1700
Diffstat (limited to 'doc')
-rw-r--r-- | doc/manuals/chapters/counters_generated.adoc | 83 | ||||
-rw-r--r-- | doc/manuals/vty/sgsn_vty_reference.xml | 8 |
2 files changed, 26 insertions, 65 deletions
diff --git a/doc/manuals/chapters/counters_generated.adoc b/doc/manuals/chapters/counters_generated.adoc index 756a4a54c..dac46aa4f 100644 --- a/doc/manuals/chapters/counters_generated.adoc +++ b/doc/manuals/chapters/counters_generated.adoc @@ -1,5 +1,8 @@ + // autogenerated by show asciidoc counters -These counters and their description based on OsmoSGSN UNKNOWN (OsmoSGSN). +These counters and their description based on OsmoSGSN 1.4.0.31-05fe (OsmoSGSN). + +=== Rate Counters // generating tables for rate_ctr_group // rate_ctr_group table BSSGP Peer Statistics @@ -15,46 +18,15 @@ These counters and their description based on OsmoSGSN UNKNOWN (OsmoSGSN). | 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 +.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) +| llc:ul_bytes | <<sgsn_llc:ul_bytes>> | Count successful received LLC bytes (encrypt & fcs correct) +| llc:dl_packets | <<sgsn_llc:dl_packets>> | Count successful sent LLC packets before giving it to the bssgp layer +| llc:ul_packets | <<sgsn_llc:ul_packets>> | Count successful 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 @@ -76,7 +48,7 @@ These counters and their description based on OsmoSGSN UNKNOWN (OsmoSGSN). | pdp:ul_deactivate_accepted | <<sgsn_pdp:ul_deactivate_accepted>> | Received deactivate accepts |=== // rate_ctr_group table NSVC Peer Statistics -.ns:nsvc - NSVC Peer Statistics +.ns:nsvc - NSVC Peer Statistics [options="header"] |=== | Name | Reference | Description @@ -84,38 +56,27 @@ These counters and their description based on OsmoSGSN UNKNOWN (OsmoSGSN). | 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 +| 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 +| 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 |=== +== Osmo Stat Items + // 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 +.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 -|=== - +== Osmo Counters +// generating tables for osmo_counters +// there are no ungrouped osmo_counters diff --git a/doc/manuals/vty/sgsn_vty_reference.xml b/doc/manuals/vty/sgsn_vty_reference.xml index e9cd32241..c3f91cf70 100644 --- a/doc/manuals/vty/sgsn_vty_reference.xml +++ b/doc/manuals/vty/sgsn_vty_reference.xml @@ -2460,7 +2460,7 @@ <command id='compression rfc1144 active slots <1-256>'> <params> <param name='compression' doc='Configure compression' /> - <param name='rfc1144' doc='RFC1144 Header compresion scheme' /> + <param name='rfc1144' doc='RFC1144 Header compression scheme' /> <param name='active' doc='Compression is actively proposed' /> <param name='slots' doc='Number of compression state slots' /> <param name='<1-256>' doc='Number of compression state slots' /> @@ -2469,7 +2469,7 @@ <command id='compression rfc1144 passive'> <params> <param name='compression' doc='Configure compression' /> - <param name='rfc1144' doc='RFC1144 Header compresion scheme' /> + <param name='rfc1144' doc='RFC1144 Header compression scheme' /> <param name='passive' doc='Compression is available on request' /> </params> </command> @@ -2483,7 +2483,7 @@ <command id='compression v42bis active direction (ms|sgsn|both) codewords <512-65535> strlen <6-250>'> <params> <param name='compression' doc='Configure compression' /> - <param name='v42bis' doc='V.42bis data compresion scheme' /> + <param name='v42bis' doc='V.42bis data compression scheme' /> <param name='active' doc='Compression is actively proposed' /> <param name='direction' doc='Direction in which the compression shall be active (p0)' /> <param name='ms' doc='Compress ms->sgsn direction only' /> @@ -2498,7 +2498,7 @@ <command id='compression v42bis passive'> <params> <param name='compression' doc='Configure compression' /> - <param name='v42bis' doc='V.42bis data compresion scheme' /> + <param name='v42bis' doc='V.42bis data compression scheme' /> <param name='passive' doc='Compression is available on request' /> </params> </command> |