cellular-infrastructure
/
osmo-gbproxy
mirror of https://gerrit.osmocom.org/osmo-gbproxy
9
0
Fork 0
Code Issues Releases Wiki Activity

manual: Update counters, add proper chapter for counters 

Change-Id: If499ba8f8e26d340e79a42be3fb490e912d507cc
This commit is contained in:
Daniel Willmann 2021-06-15 17:50:49 +02:00
parent 5643836076
commit 9d98e7cc68
3 changed files with 25 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/manuals/chapters/counters.adoc Normal file
View File

@ -0,0 +1,4 @@
[[counters]]
== Counters
include::./counters_generated.adoc[]

41
doc/manuals/chapters/counters_generated.adoc
View File

@ -1,6 +1,6 @@
// autogenerated by show asciidoc counters
These counters and their description are based on OsmoGbProxy UNKNOWN-dirty (OsmoGbProxy).
These counters and their description are based on OsmoGbProxy 0.1.0.21-5643 (OsmoGbProxy).
=== Rate Counters
@ -16,44 +16,46 @@ These counters and their description are based on OsmoGbProxy UNKNOWN-dirty (Osm
| bytes:in | <<ns:nsvc_bytes:in>> | Bytes at NS Level ( In)
| bytes:out | <<ns:nsvc_bytes:out>> | Bytes at NS Level (Out)
| bytes:out:drop | <<ns:nsvc_bytes:out:drop>> | Dropped Bytes (Out)
| blocked | <<ns:nsvc_blocked>> | NS-VC Block count
| unblocked | <<ns:nsvc_unblocked>> | NS-VC Unblock count
| dead | <<ns:nsvc_dead>> | NS-VC gone dead count
| blocked | <<ns:nsvc_blocked>> | NS-VC Block count
| unblocked | <<ns:nsvc_unblocked>> | NS-VC Unblock 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
| 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
|===
// rate_ctr_group table GBProxy Peer Statistics
.gbproxy:peer - GBProxy Peer Statistics
[options="header"]
|===
| Name | Reference | Description
| blocked | <<gbproxy:peer_blocked>> | BVC Block
| unblocked | <<gbproxy:peer_unblocked>> | BVC Unblock
| dropped | <<gbproxy:peer_dropped>> | BVC blocked, dropped packet
| inv-nsei | <<gbproxy:peer_inv-nsei>> | NSEI mismatch
| tx-err | <<gbproxy:peer_tx-err>> | NS Transmission error
| blocked | <<gbproxy:peer_blocked>> | BVC Block
| unblocked | <<gbproxy:peer_unblocked>> | BVC Unblock
| dropped | <<gbproxy:peer_dropped>> | BVC blocked, dropped packet
| inv-nsei | <<gbproxy:peer_inv-nsei>> | NSEI mismatch
| tx-err | <<gbproxy:peer_tx-err>> | NS Transmission error
|===
// rate_ctr_group table GBProxy Global Statistics
.gbproxy:global - GBProxy Global Statistics
[options="header"]
|===
| Name | Reference | Description
| inv-bvci | <<gbproxy:global_inv-bvci>> | Invalid BVC Identifier
| inv-bvci | <<gbproxy:global_inv-bvci>> | Invalid BVC Identifier
| inv-lai | <<gbproxy:global_inv-lai>> | Invalid Location Area Identifier
| inv-rai | <<gbproxy:global_inv-rai>> | Invalid Routing Area Identifier
| inv-nsei | <<gbproxy:global_inv-nsei>> | No BVC established for NSEI
| inv-rai | <<gbproxy:global_inv-rai>> | Invalid Routing Area Identifier
| inv-nsei | <<gbproxy:global_inv-nsei>> | No BVC established for NSEI
| proto-err:bss | <<gbproxy:global_proto-err:bss>> | BSSGP protocol error (BSS )
| proto-err:sgsn | <<gbproxy:global_proto-err:sgsn>> | BSSGP protocol error (SGSN)
| not-supp:bss | <<gbproxy:global_not-supp:bss>> | Feature not supported (BSS )
| not-supp:sgsn | <<gbproxy:global_not-supp:sgsn>> | Feature not supported (SGSN)
| restart:sgsn | <<gbproxy:global_restart:sgsn>> | Restarted RESET procedure (SGSN)
| tx-err:sgsn | <<gbproxy:global_tx-err:sgsn>> | NS Transmission error (SGSN)
| error | <<gbproxy:global_error>> | Other error
| mod-peer-err | <<gbproxy:global_mod-peer-err>> | Patch error: no peer
| error | <<gbproxy:global_error>> | Other error
| mod-peer-err | <<gbproxy:global_mod-peer-err>> | Patch error: no peer
|===
== Osmo Stat Items
=== Osmo Stat Items
// generating tables for osmo_stat_items
NSVC Peer Statistics
@ -72,7 +74,4 @@ NS Bind Statistics
| Name | Reference | Description | Unit
| tx_backlog_length | <<ns.bind_tx_backlog_length>> | Transmit backlog length | packets
|===
== Osmo Counters
// generating tables for osmo_counters
// there are no ungrouped osmo_counters

2
doc/manuals/osmogbproxy-usermanual.adoc
View File

@ -31,7 +31,7 @@ include::./common/chapters/gb-ns2.adoc[]
include::./common/chapters/control_if.adoc[]
include::{srcdir}/chapters/counters_generated.adoc[]
include::{srcdir}/chapters/counters.adoc[]
include::./common/chapters/vty_cpu_sched.adoc[]