daniel has submitted this change and it was merged. (
https://gerrit.osmocom.org/c/osmo-mgw/+/14533 )
Change subject: manuals: Update vty/counter documentation
......................................................................
manuals: Update vty/counter documentation
Change-Id: Icc86ef7ddd8a30984f91b025157e11fc0df9631e
Depends: OS#1700
---
M doc/manuals/chapters/counters_generated.adoc
M doc/manuals/vty/mgw_vty_reference.xml
2 files changed, 111 insertions(+), 10 deletions(-)
Approvals:
Jenkins Builder: Verified
pespin: Looks good to me, approved
diff --git a/doc/manuals/chapters/counters_generated.adoc
b/doc/manuals/chapters/counters_generated.adoc
index 20a4dec..22c321d 100644
--- a/doc/manuals/chapters/counters_generated.adoc
+++ b/doc/manuals/chapters/counters_generated.adoc
@@ -1,10 +1,79 @@
// autogenerated by show asciidoc counters
-These counters and their description based on OsmoMGW 1.3.0.34-9cd52 (OsmoMGW).
+These counters and their description based on OsmoMGW 1.5.0.60-f638 (OsmoMGW).
=== Rate Counters
// generating tables for rate_ctr_group
+// rate_ctr_group table aggregated statistics for all rtp connections
+.all_rtp_conn - aggregated statistics for all rtp connections
+[options="header"]
+|===
+| Name | Reference | Description
+| all_rtp:err_tstmp_in | <<all_rtp_conn_all_rtp:err_tstmp_in>> | Total inbound
rtp-stream timestamp errors.
+| all_rtp:err_tstmp_out | <<all_rtp_conn_all_rtp:err_tstmp_out>> | Total
outbound rtp-stream timestamp errors.
+| all_rtp:packets_rx | <<all_rtp_conn_all_rtp:packets_rx>> | Total inbound rtp
packets.
+| all_rtp:octets_rx | <<all_rtp_conn_all_rtp:octets_rx>> | Total inbound rtp
octets.
+| all_rtp:packets_tx | <<all_rtp_conn_all_rtp:packets_tx>> | Total outbound
rtp packets.
+| all_rtp:octets_tx | <<all_rtp_conn_all_rtp:octets_tx>> | Total outbound rtp
octets.
+| all_rtp:dropped | <<all_rtp_conn_all_rtp:dropped>> | Total dropped rtp
packets.
+| all_rtp:num_closed_conns | <<all_rtp_conn_all_rtp:num_closed_conns>> | Total
number of rtp connections closed.
+|===
+// rate_ctr_group table dlcx statistics
+.dlcx - dlcx statistics
+[options="header"]
+|===
+| Name | Reference | Description
+| dlcx:success | <<dlcx_dlcx:success>> | DLCX command processed successfully.
+| dlcx:wildcard | <<dlcx_dlcx:wildcard>> | wildcard names in DLCX commands are
unsupported.
+| dlcx:no_conn | <<dlcx_dlcx:no_conn>> | endpoint specified in DLCX command
has no active connections.
+| dlcx:callid | <<dlcx_dlcx:callid>> | CallId specified in DLCX command
mismatches endpoint's CallId .
+| dlcx:connid | <<dlcx_dlcx:connid>> | connection ID specified in DLCX command
does not exist on endpoint.
+| dlcx:unhandled_param | <<dlcx_dlcx:unhandled_param>> | unhandled parameter
in DLCX command.
+| dlcx:rejected | <<dlcx_dlcx:rejected>> | connection deletion rejected by
policy.
+| dlcx:deferred | <<dlcx_dlcx:deferred>> | connection deletion deferred by
policy.
+|===
+// rate_ctr_group table mdcx statistics
+.mdcx - mdcx statistics
+[options="header"]
+|===
+| Name | Reference | Description
+| mdcx:success | <<mdcx_mdcx:success>> | MDCX command processed successfully.
+| mdcx:wildcard | <<mdcx_mdcx:wildcard>> | wildcard endpoint names in MDCX
commands are unsupported.
+| mdcx:no_conn | <<mdcx_mdcx:no_conn>> | endpoint specified in MDCX command
has no active connections.
+| mdcx:callid | <<mdcx_mdcx:callid>> | invalid CallId specified in MDCX
command.
+| mdcx:connid | <<mdcx_mdcx:connid>> | invalid connection ID specified in MDCX
command.
+| crcx:unhandled_param | <<mdcx_crcx:unhandled_param>> | unhandled parameter
in MDCX command.
+| mdcx:no_connid | <<mdcx_mdcx:no_connid>> | no connection ID specified in
MDCX command.
+| mdcx:conn_not_found | <<mdcx_mdcx:conn_not_found>> | connection specified in
MDCX command does not exist.
+| mdcx:invalid_mode | <<mdcx_mdcx:invalid_mode>> | invalid connection mode in
MDCX command.
+| mdcx:conn_opt | <<mdcx_mdcx:conn_opt>> | connection options invalid.
+| mdcx:no_remote_conn_desc | <<mdcx_mdcx:no_remote_conn_desc>> | no opposite
end specified for connection.
+| mdcx:start_rtp_failure | <<mdcx_mdcx:start_rtp_failure>> | failure to start
RTP processing.
+| mdcx:conn_rejected | <<mdcx_mdcx:conn_rejected>> | connection rejected by
policy.
+| mdcx:conn_deferred | <<mdcx_mdcx:conn_deferred>> | connection deferred by
policy.
+|===
+// rate_ctr_group table crxc statistics
+.crcx - crxc statistics
+[options="header"]
+|===
+| Name | Reference | Description
+| crcx:success | <<crcx_crcx:success>> | CRCX command processed successfully.
+| crcx:bad_action | <<crcx_crcx:bad_action>> | bad action in CRCX command.
+| crcx:unhandled_param | <<crcx_crcx:unhandled_param>> | unhandled parameter
in CRCX command.
+| crcx:missing_callid | <<crcx_crcx:missing_callid>> | missing CallId in CRCX
command.
+| crcx:invalid_mode | <<crcx_crcx:invalid_mode>> | invalid connection mode in
CRCX command.
+| crcx:limit_exceeded | <<crcx_crcx:limit_exceeded>> | limit of concurrent
connections was reached.
+| crcx:unkown_callid | <<crcx_crcx:unkown_callid>> | unknown CallId in CRCX
command.
+| crcx:alloc_conn_fail | <<crcx_crcx:alloc_conn_fail>> | connection allocation
failure.
+| crcx:no_remote_conn_desc | <<crcx_crcx:no_remote_conn_desc>> | no opposite
end specified for connection.
+| crcx:start_rtp_failure | <<crcx_crcx:start_rtp_failure>> | failure to start
RTP processing.
+| crcx:conn_rejected | <<crcx_crcx:conn_rejected>> | connection rejected by
policy.
+| crcx:no_osmux | <<crcx_crcx:no_osmux>> | no osmux offered by peer.
+| crcx:conn_opt | <<crcx_crcx:conn_opt>> | connection options invalid.
+| crcx:codec_nego | <<crcx_crcx:codec_nego>> | codec negotiation failure.
+| crcx:bind_port | <<crcx_crcx:bind_port>> | port bind failure.
+|===
== Osmo Stat Items
// generating tables for osmo_stat_items
diff --git a/doc/manuals/vty/mgw_vty_reference.xml
b/doc/manuals/vty/mgw_vty_reference.xml
index 834db04..1770dab 100644
--- a/doc/manuals/vty/mgw_vty_reference.xml
+++ b/doc/manuals/vty/mgw_vty_reference.xml
@@ -187,12 +187,11 @@
<param name='MASK' doc='List of logging categories to log, e.g.
'abc:mno:xyz'. Available log categories depend on the specific
application, refer to the 'logging level' command. Optionally add
individual log levels like 'abc,1:mno,3:xyz,5', where the level
numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
</params>
</command>
- <command id='logging level
(rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf)
(debug|info|notice|error|fatal)'>
+ <command id='logging level
(rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro)
(debug|info|notice|error|fatal)'>
<params>
<param name='logging' doc='Configure logging' />
<param name='level' doc='Set the log level for a specified category' />
<param name='rtp' doc='RTP stream handling' />
- <param name='iuup' doc='IuUP within RTP stream handling' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -211,6 +210,7 @@
<param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
<param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol'
/>
<param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
+ <param name='lrspro' doc='Remote SIM protocol' />
<param name='debug' doc='Log debug messages and higher levels' />
<param name='info' doc='Log informational messages and higher levels'
/>
<param name='notice' doc='Log noticeable messages and higher levels' />
@@ -522,12 +522,11 @@
<param name='MASK' doc='List of logging categories to log, e.g.
'abc:mno:xyz'. Available log categories depend on the specific
application, refer to the 'logging level' command. Optionally add
individual log levels like 'abc,1:mno,3:xyz,5', where the level
numbers are LOGL_DEBUG=1 LOGL_INFO=3 LOGL_NOTICE=5 LOGL_ERROR=7 LOGL_FATAL=8' />
</params>
</command>
- <command id='logging level
(rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf)
(debug|info|notice|error|fatal)'>
+ <command id='logging level
(rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro)
(debug|info|notice|error|fatal)'>
<params>
<param name='logging' doc='Configure logging' />
<param name='level' doc='Set the log level for a specified category' />
<param name='rtp' doc='RTP stream handling' />
- <param name='iuup' doc='IuUP within RTP stream handling' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -546,6 +545,7 @@
<param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
<param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol'
/>
<param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
+ <param name='lrspro' doc='Remote SIM protocol' />
<param name='debug' doc='Log debug messages and higher levels' />
<param name='info' doc='Log informational messages and higher levels'
/>
<param name='notice' doc='Log noticeable messages and higher levels' />
@@ -561,8 +561,7 @@
<param name='debug' doc='Log debug messages and higher levels' />
<param name='info' doc='Log informational messages and higher levels'
/>
<param name='notice' doc='Log noticeable messages and higher levels' />
- <param name='error' doc='Log error messages and higher levels' />
- <param name='fatal' doc='Log only fatal messages' />
+ <param name='error' doc='Log error messages and higher levels' />
<param name='fatal' doc='Log only fatal messages' />
</params>
</command>
<command id='logging level force-all (debug|info|notice|error|fatal)'>
@@ -1040,12 +1039,11 @@
<param name='[last]' doc='Log source file info at the end of a log
line. If omitted, log source file info just before the log text.' />
</params>
</command>
- <command id='logging level
(rtp|iuup|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf)
(debug|info|notice|error|fatal)'>
+ <command id='logging level
(rtp|lglobal|llapd|linp|lmux|lmi|lmib|lsms|lctrl|lgtp|lstats|lgsup|loap|lss7|lsccp|lsua|lm3ua|lmgcp|ljibuf|lrspro)
(debug|info|notice|error|fatal)'>
<params>
<param name='logging' doc='Configure logging' />
<param name='level' doc='Set the log level for a specified category' />
<param name='rtp' doc='RTP stream handling' />
- <param name='iuup' doc='IuUP within RTP stream handling' />
<param name='lglobal' doc='Library-internal global log family' />
<param name='llapd' doc='LAPD in libosmogsm' />
<param name='linp' doc='A-bis Intput Subsystem' />
@@ -1064,6 +1062,7 @@
<param name='lm3ua' doc='libosmo-sigtran MTP3 User Adaptation' />
<param name='lmgcp' doc='libosmo-mgcp Media Gateway Control Protocol'
/>
<param name='ljibuf' doc='libosmo-netif Jitter Buffer' />
+ <param name='lrspro' doc='Remote SIM protocol' />
<param name='debug' doc='Log debug messages and higher levels' />
<param name='info' doc='Log informational messages and higher levels'
/>
<param name='notice' doc='Log noticeable messages and higher levels' />
@@ -1186,10 +1185,11 @@
<param name='login' doc='Enable password checking' />
</params>
</command>
- <command id='bind A.B.C.D'>
+ <command id='bind A.B.C.D [<0-65535>]'>
<params>
<param name='bind' doc='Accept VTY telnet connections on local
interface' />
<param name='A.B.C.D' doc='Local interface IP address (default:
127.0.0.1)' />
+ <param name='[<0-65535>]' doc='Local TCP port number' />
</params>
</command>
</node>
@@ -1397,6 +1397,19 @@
<param name='rtp-patch' doc='Modify RTP packet header in both
directions' />
</params>
</command>
+ <command id='rtp-patch rfc5993hr'>
+ <params>
+ <param name='rtp-patch' doc='Modify RTP packet header in both
directions' />
+ <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993
and vice versa' />
+ </params>
+ </command>
+ <command id='no rtp-patch rfc5993hr'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='rtp-patch' doc='Modify RTP packet header in both
directions' />
+ <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993
and vice versa' />
+ </params>
+ </command>
<command id='sdp audio fmtp-extra .NAME'>
<params>
<param name='sdp' doc='Add extra fmtp for the SDP file' />
@@ -1496,6 +1509,12 @@
<param name='NAME' doc='Qualified domain name expected in MGCP
endpoint names, or '*' to accept any domain' />
</params>
</command>
+ <command id='conn-timeout <1-65534>'>
+ <params>
+ <param name='conn-timeout' doc='Set a time after which inactive
connections (CIs) are closed. This can be used to work around interoperability
problems causing connections to stay open forever, and slowly exhausting all
available ports. Do not enable when LCLS is used (connections in LCLS state
appear to be inactive)!' />
+ <param name='<1-65534>' doc='Timeout value (sec.)' />
+ </params>
+ </command>
<command id='trunk <1-64>'>
<params>
<param name='trunk' doc='Configure a SS7 trunk' />
@@ -1579,6 +1598,19 @@
<param name='timestamp' doc='Adjust RTP timestamp' />
</params>
</command>
+ <command id='rtp-patch rfc5993hr'>
+ <params>
+ <param name='rtp-patch' doc='Modify RTP packet header in both
directions' />
+ <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993
and vice versa' />
+ </params>
+ </command>
+ <command id='no rtp-patch rfc5993hr'>
+ <params>
+ <param name='no' doc='Negate a command or set its defaults' />
+ <param name='rtp-patch' doc='Modify RTP packet header in both
directions' />
+ <param name='rfc5993hr' doc='Convert GSM-HR from TS101318 to RFC5993
and vice versa' />
+ </params>
+ </command>
<command id='no rtp-patch timestamp'>
<params>
<param name='no' doc='Negate a command or set its defaults' />
--
To view, visit https://gerrit.osmocom.org/c/osmo-mgw/+/14533
To unsubscribe, or for help writing mail filters, visit
https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-mgw
Gerrit-Branch: master
Gerrit-Change-Id: Icc86ef7ddd8a30984f91b025157e11fc0df9631e
Gerrit-Change-Number: 14533
Gerrit-PatchSet: 1
Gerrit-Owner: daniel <[email protected]>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: daniel <[email protected]>
Gerrit-Reviewer: pespin <[email protected]>
Gerrit-MessageType: merged
