Resources.DocsCoreStats HistoryHide minor edits - Show changes to output April 24, 2013, at 10:39 PM
by -
Changed lines 1-377 from:
!!Resources -> [[Resources.Documentation | Documentation]] -> [[Resources.DocsCookbooks | CookBooks]] -> Core Statistics (:toc-float Table of Content:) Statistics which are exported by the '''OpenSIPS''' core. This document is for '''OpenSIPS 1.9.x/devel''' ---- !!! "CORE" Class !!!!rcv_requests Returns the total number of received requests by OpenSIPS. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics rcv_requests @] Example of usage from script [@ xlog("Total number of received requests = $stat(rcv_requests) \n"); @] !!!!rcv_replies Returns the total number of received replies by OpenSIPS. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics rcv_replies @] Example of usage from script [@ xlog("Total number of received replies = $stat(rcv_replies) \n"); @] !!!!fwd_requests Returns the number of stateless forwarded requests by OpenSIPS. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics fwd_requests @] Example of usage from script [@ xlog("Total number of forwarded requests = $stat(fwd_requests) \n"); @] !!!!fwd_replies Returns the number of stateless forwarded replies by OpenSIPS. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics fwd_replies @] Example of usage from script [@ xlog("Total number of forwarded replies = $stat(fwd_replies) \n"); @] !!!!drop_requests Returns the number of requests dropped even before entering the script routing logic. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics drop_requests @] Example of usage from script [@ xlog("Total number of dropped requests = $stat(drop_requests) \n"); @] !!!!drop_replies Returns the number of replies dropped even before entering the script routing logic, or explicitly dropped in the onreply_route. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics drop_replies @] Example of usage from script [@ xlog("Total number of dropped replies = $stat(drop_replies) \n"); @] !!!!err_requests Returns the number of bogus requests from SIP point of view ( eg. : No VIA header found ) Example of usage through MI FIFO [@ opensipsctl fifo get_statistics err_requests @] Example of usage from script [@ xlog("Total number of error requests = $stat(err_requests) \n"); @] !!!!err_replies Returns the number of bogus replies from SIP point of view ( eg. : No VIA header found ) Example of usage through MI FIFO [@ opensipsctl fifo get_statistics err_replies @] Example of usage from script [@ xlog("Total number of error replies = $stat(err_replies) \n"); @] !!!!bad_URIs_rcvd Returns the number of URIs that OpenSIPS failed to parse. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics bad_URIs_rcvd @] Example of usage from script [@ xlog("Total number of bad URIs detected = $stat(bad_URIs_rcvd) \n"); @] !!!!unsupported_methods Returns the number of non-standard methods encountered by OpenSIPS while parsing SIP methods. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics unsupported_methods @] Example of usage from script [@ xlog("Total number of unsupported methods detected = $stat(unsupported_methods) \n"); @] !!!!bad_msg_hdr Returns the number of SIP headers that OpenSIPS failed to parse. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics bad_msg_hdr @] Example of usage from script [@ xlog("Total number of headers that failed to parse = $stat(bad_msg_hdr) \n"); @] !!!!timestamp Returns the number of seconds elapsed from OpenSIPS starting. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics timestamp @] Example of usage from script [@ xlog("OpenSIPS has been alive for $stat(timestamp) seconds \n"); @] ---- !!! "LOAD" class Statistics giving information on OpenSIPS load (busy children). !!!!tcp-load Returns the percentage of TCP children that are awake and processing SIP messages. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics tcp-load @] Example of usage from script [@ xlog("The TCP load is $stat(tcp-load) \n"); @] !!!!udp:int_ip:int_port-load Returns the percentage of UDP children that are awake and processing SIP messages on the specific UDP interface Example of usage through MI FIFO: [@ If OpenSIPS has two listen directives : listen=udp:192.168.2.134:5060 listen=udp:192.168.10.13:5090 Then there will be two exported statistics, udp:192.168.2.134:5060-load and udp:192.168.10.13:5090-load, and each will show the percentage of working children on the respective interfaces. opensipsctl fifo get_statistics udp:192.168.2.134:5060-load @] Example of usage from script [@ xlog("The UDP load on 192.168.2.134:5060 is $stat(udp:192.168.2.134:5060-load) \n"); @] ----- !!! "NET" Class Statistics giving information about UDP, TCP and TLS buffers on interfaces that OpenSIPS is listening on. !!!!waiting_udp Returns the number of bytes waiting to be consumed on UDP interfaces that OpenSIPS is listening on. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics waiting_udp @] Example of usage from script [@ xlog("The UDP waiting buffer size is $stat(waiting_udp) \n"); @] !!!!waiting_tcp Returns the number of bytes waiting to be consumed on TCP interfaces that OpenSIPS is listening on. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics waiting_tcp @] Example of usage from script [@ xlog("The TCP waiting buffer size is $stat(waiting_tcp) \n"); @] !!!!waiting_tls Returns the number of bytes waiting to be consumed on TLS interfaces that OpenSIPS is listening on. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics waiting_tls @] Example of usage from script [@ xlog("The TLS waiting buffer size is $stat(waiting_tls) \n"); @] ---- !!! "SHMEM" Class Statistics giving information on the shared memory that OpenSIPS is using. !!!!total_size Returns the total size of shared memory available to OpenSIPS processes. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics total_size @] Example of usage from script [@ xlog("Total size of SHMEM available is $stat(total_size) \n"); @] !!!!used_size Returns the amount of shared memory requested and used by OpenSIPS processes. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics used_size @] Example of usage from script [@ xlog("SHMEM in use = $stat(used_size) \n"); @] !!!!real_used_size Returns the amount of shared memory requested by OpenSIPS processes + malloc overhead Example of usage through MI FIFO [@ opensipsctl fifo get_statistics real_used_size @] Example of usage from script [@ xlog("Real SHMEM used size is $stat(real_used_size) \n"); @] !!!!max_used_size Returns the maximum amount of shared memory ever used by OpenSIPS processes. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics max_used_size @] Example of usage from script [@ xlog("The max SHMEM ever used is $stat(max_used_size) \n"); @] !!!!free_size Returns the free memory available. Computed as total_size - real_used_size Example of usage through MI FIFO [@ opensipsctl fifo get_statistics free_size @] Example of usage from script [@ xlog("Free SHMEM available is $stat(free_size) \n"); @] !!!!fragments Returns the total number of fragments in the shared memory. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics fragments @] Example of usage from script [@ xlog("The total number of SHMEM fragments is $stat(fragments) \n"); @] to:
(:redirect Documentation/Interface-CoreStatistics quiet=1:) March 22, 2012, at 01:54 PM
by -
Changed line 6 from:
This document is for '''OpenSIPS 1.8.x/devel''' to:
This document is for '''OpenSIPS 1.9.x/devel''' July 12, 2011, at 07:53 PM
by -
Changed lines 1-2 from:
!!Resources -> [[Resources.Documentation | Documentation]] -> [[Resources.DocsCookbooks | CookBooks]] -> Core Statistics v1.7/devel to:
!!Resources -> [[Resources.Documentation | Documentation]] -> [[Resources.DocsCookbooks | CookBooks]] -> Core Statistics Changed line 6 from:
This document is for '''OpenSIPS 1.7.x/devel''' to:
This document is for '''OpenSIPS 1.8.x/devel''' February 22, 2011, at 01:45 PM
by -
Changed lines 37-38 from:
xlog("Total number of received requests = $stat(rcv_replies) \n"); to:
xlog("Total number of received replies = $stat(rcv_replies) \n"); Changed lines 52-53 from:
xlog("Total number of received requests = $stat(fwd_requests) \n"); to:
xlog("Total number of forwarded requests = $stat(fwd_requests) \n"); Changed lines 67-68 from:
xlog("Total number of received requests = $stat(fwd_replies) \n"); to:
xlog("Total number of forwarded replies = $stat(fwd_replies) \n"); Changed lines 82-83 from:
xlog("Total number of received requests = $stat(drop_requests) \n"); to:
xlog("Total number of dropped requests = $stat(drop_requests) \n"); Changed lines 98-99 from:
xlog("Total number of received requests = $stat(drop_replies) \n"); to:
xlog("Total number of dropped replies = $stat(drop_replies) \n"); Changed lines 113-114 from:
xlog("Total number of received requests = $stat(err_requests) \n"); to:
xlog("Total number of error requests = $stat(err_requests) \n"); Changed lines 128-129 from:
xlog("Total number of received requests = $stat(err_replies) \n"); to:
xlog("Total number of error replies = $stat(err_replies) \n"); Changed lines 143-144 from:
xlog("Total number of received requests = $stat(bad_URIs_rcvd) \n"); to:
xlog("Total number of bad URIs detected = $stat(bad_URIs_rcvd) \n"); Changed lines 158-159 from:
xlog("Total number of received requests = $stat(unsupported_methods) \n"); to:
xlog("Total number of unsupported methods detected = $stat(unsupported_methods) \n"); Changed lines 173-174 from:
xlog("Total number of received requests = $stat(bad_msg_hdr) \n"); to:
xlog("Total number of headers that failed to parse = $stat(bad_msg_hdr) \n"); Changed lines 187-188 from:
xlog("Total number of received requests = $stat(timestamp) \n"); to:
xlog("OpenSIPS has been alive for $stat(timestamp) seconds \n"); Changed lines 208-209 from:
xlog("Total number of received requests = $stat(tcp-load) \n"); to:
xlog("The TCP load is $stat(tcp-load) \n"); Changed lines 230-231 from:
xlog("Total number of received requests = $stat(udp:192.168.2.134:5060-load) \n"); to:
xlog("The UDP load on 192.168.2.134:5060 is $stat(udp:192.168.2.134:5060-load) \n"); Changed lines 250-251 from:
xlog("Total number of received requests = $stat(waiting_udp) \n"); to:
xlog("The UDP waiting buffer size is $stat(waiting_udp) \n"); Changed lines 265-266 from:
xlog("Total number of received requests = $stat(waiting_tcp) \n"); to:
xlog("The TCP waiting buffer size is $stat(waiting_tcp) \n"); Changed lines 280-281 from:
xlog("Total number of received requests = $stat(waiting_tls) \n"); to:
xlog("The TLS waiting buffer size is $stat(waiting_tls) \n"); Changed lines 300-301 from:
xlog("Total number of received requests = $stat(total_size) \n"); to:
xlog("Total size of SHMEM available is $stat(total_size) \n"); Changed lines 315-316 from:
xlog("Total number of received requests = $stat(used_size) \n"); to:
xlog("SHMEM in use = $stat(used_size) \n"); Changed lines 330-331 from:
xlog("Total number of received requests = $stat(real_used_size) \n"); to:
xlog("Real SHMEM used size is $stat(real_used_size) \n"); Changed lines 345-346 from:
xlog("Total number of received requests = $stat(max_used_size) \n"); to:
xlog("The max SHMEM ever used is $stat(max_used_size) \n"); Changed lines 360-361 from:
xlog("Total number of received requests = $stat(free_size) \n"); to:
xlog("Free SHMEM available is $stat(free_size) \n"); Changed line 375 from:
xlog("Total number of received requests = $stat(fragments) \n"); to:
xlog("The total number of SHMEM fragments is $stat(fragments) \n"); February 22, 2011, at 01:40 PM
by -
Changed lines 199-200 from:
Example of usage through MI FIFO: to:
Example of usage through MI FIFO Changed lines 206-209 from:
!!!!udp:int_ip:int_port-load Returns the percentage of UDP children that are awake and processing SIP messages on the specific UDP interface Example of usage through MI FIFO: to:
Example of usage from script Added lines 208-216:
xlog("Total number of received requests = $stat(tcp-load) \n"); @] !!!!udp:int_ip:int_port-load Returns the percentage of UDP children that are awake and processing SIP messages on the specific UDP interface Example of usage through MI FIFO: [@ Added lines 228-233:
Example of usage from script [@ xlog("Total number of received requests = $stat(udp:192.168.2.134:5060-load) \n"); @] Added lines 242-253:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics waiting_udp @] Example of usage from script [@ xlog("Total number of received requests = $stat(waiting_udp) \n"); @] Added lines 257-268:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics waiting_tcp @] Example of usage from script [@ xlog("Total number of received requests = $stat(waiting_tcp) \n"); @] Added lines 272-283:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics waiting_tls @] Example of usage from script [@ xlog("Total number of received requests = $stat(waiting_tls) \n"); @] Added lines 292-303:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics total_size @] Example of usage from script [@ xlog("Total number of received requests = $stat(total_size) \n"); @] Added lines 307-318:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics used_size @] Example of usage from script [@ xlog("Total number of received requests = $stat(used_size) \n"); @] Added lines 322-333:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics real_used_size @] Example of usage from script [@ xlog("Total number of received requests = $stat(real_used_size) \n"); @] Added lines 337-348:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics max_used_size @] Example of usage from script [@ xlog("Total number of received requests = $stat(max_used_size) \n"); @] Added lines 352-363:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics free_size @] Example of usage from script [@ xlog("Total number of received requests = $stat(free_size) \n"); @] Changed lines 365-377 from:
Returns the total number of fragments in the shared memory. to:
Returns the total number of fragments in the shared memory. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics fragments @] Example of usage from script [@ xlog("Total number of received requests = $stat(fragments) \n"); @] February 22, 2011, at 01:36 PM
by -
Changed lines 22-23 from:
xlog("Total number of received requests = $stat("rcv_requests") to:
xlog("Total number of received requests = $stat(rcv_requests) \n"); Changed lines 37-38 from:
xlog("Total number of received requests = $stat("rcv_replies") to:
xlog("Total number of received requests = $stat(rcv_replies) \n"); Changed lines 52-53 from:
xlog("Total number of received requests = $stat("fwd_requests") to:
xlog("Total number of received requests = $stat(fwd_requests) \n"); Changed lines 67-68 from:
xlog("Total number of received requests = $stat("fwd_replies") to:
xlog("Total number of received requests = $stat(fwd_replies) \n"); Changed lines 82-83 from:
xlog("Total number of received requests = $stat("drop_requests") to:
xlog("Total number of received requests = $stat(drop_requests) \n"); Changed lines 98-99 from:
xlog("Total number of received requests = $stat("drop_replies") to:
xlog("Total number of received requests = $stat(drop_replies) \n"); Added lines 105-116:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics err_requests @] Example of usage from script [@ xlog("Total number of received requests = $stat(err_requests) \n"); @] Added lines 120-131:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics err_replies @] Example of usage from script [@ xlog("Total number of received requests = $stat(err_replies) \n"); @] Added lines 135-146:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics bad_URIs_rcvd @] Example of usage from script [@ xlog("Total number of received requests = $stat(bad_URIs_rcvd) \n"); @] Added lines 150-162:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics unsupported_methods @] Example of usage from script [@ xlog("Total number of received requests = $stat(unsupported_methods) \n"); @] Added lines 166-176:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics bad_msg_hdr @] Example of usage from script [@ xlog("Total number of received requests = $stat(bad_msg_hdr) \n"); @] Added lines 179-189:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics timestamp @] Example of usage from script [@ xlog("Total number of received requests = $stat(timestamp) \n"); @] February 22, 2011, at 01:31 PM
by -
Added line 13:
Added lines 29-40:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics rcv_replies @] Example of usage from script [@ xlog("Total number of received requests = $stat("rcv_replies") @] Added lines 44-55:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics fwd_requests @] Example of usage from script [@ xlog("Total number of received requests = $stat("fwd_requests") @] Added lines 59-70:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics fwd_replies @] Example of usage from script [@ xlog("Total number of received requests = $stat("fwd_replies") @] Added lines 74-85:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics drop_requests @] Example of usage from script [@ xlog("Total number of received requests = $stat("drop_requests") @] Added lines 89-100:
Example of usage through MI FIFO [@ opensipsctl fifo get_statistics drop_replies @] Example of usage from script [@ xlog("Total number of received requests = $stat("drop_replies") @] February 22, 2011, at 01:29 PM
by -
Changed lines 12-13 from:
Returns the number of received requests by OpenSIPS. to:
Returns the total number of received requests by OpenSIPS. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics rcv_requests @] Example of usage from script [@ xlog("Total number of received requests = $stat("rcv_requests") @] Changed lines 26-27 from:
Returns the number of received replies by OpenSIPS. to:
Returns the total number of received replies by OpenSIPS. Changed lines 29-30 from:
Returns the number of forwarded requests by OpenSIPS. to:
Returns the number of stateless forwarded requests by OpenSIPS. Changed lines 32-33 from:
Returns the number of forwarded replies by OpenSIPS. to:
Returns the number of stateless forwarded replies by OpenSIPS. Changed lines 35-36 from:
TODO to:
Returns the number of requests dropped even before entering the script routing logic. Changed lines 38-39 from:
TODO to:
Returns the number of replies dropped even before entering the script routing logic, or explicitly dropped in the onreply_route. Changed lines 42-43 from:
TODO to:
Returns the number of bogus requests from SIP point of view ( eg. : No VIA header found ) Changed lines 45-46 from:
TODO to:
Returns the number of bogus replies from SIP point of view ( eg. : No VIA header found ) Changed lines 51-52 from:
TODO to:
Returns the number of non-standard methods encountered by OpenSIPS while parsing SIP methods. Changed lines 57-59 from:
TODO to:
Returns the number of seconds elapsed from OpenSIPS starting. Changed line 118 from:
TODO to:
Returns the maximum amount of shared memory ever used by OpenSIPS processes. February 21, 2011, at 07:13 PM
by - February 21, 2011, at 07:12 PM
by -
Added lines 11-23:
!!!!rcv_requests Returns the number of received requests by OpenSIPS. !!!!rcv_replies Returns the number of received replies by OpenSIPS. !!!!fwd_requests Returns the number of forwarded requests by OpenSIPS. !!!!fwd_replies Returns the number of forwarded replies by OpenSIPS. !!!!drop_requests Added lines 25-46:
!!!!drop_replies TODO !!!!err_requests TODO !!!!err_replies TODO !!!!bad_URIs_rcvd Returns the number of URIs that OpenSIPS failed to parse. !!!!unsupported_methods TODO !!!!bad_msg_hdr Returns the number of SIP headers that OpenSIPS failed to parse. !!!!timestamp TODO February 21, 2011, at 07:05 PM
by -
Changed lines 57-58 from:
!!! "MEM" Class TODO to:
!!! "SHMEM" Class Statistics giving information on the shared memory that OpenSIPS is using. !!!!total_size Returns the total size of shared memory available to OpenSIPS processes. !!!!used_size Returns the amount of shared memory requested and used by OpenSIPS processes. !!!!real_used_size Returns the amount of shared memory requested by OpenSIPS processes + malloc overhead !!!!max_used_size TODO !!!!free_size Returns the free memory available. Computed as total_size - real_used_size !!!!fragments Returns the total number of fragments in the shared memory. February 21, 2011, at 06:56 PM
by -
Changed lines 44-45 from:
TODO to:
Statistics giving information about UDP, TCP and TLS buffers on interfaces that OpenSIPS is listening on. !!!!waiting_udp Returns the number of bytes waiting to be consumed on UDP interfaces that OpenSIPS is listening on. !!!!waiting_tcp Returns the number of bytes waiting to be consumed on TCP interfaces that OpenSIPS is listening on. !!!!waiting_tls Returns the number of bytes waiting to be consumed on TLS interfaces that OpenSIPS is listening on. February 21, 2011, at 06:45 PM
by -
Added lines 8-17:
---- !!! "CORE" Class TODO ---- !!! "LOAD" class Statistics giving information on OpenSIPS load (busy children). Changed lines 42-43 from:
!!!!TODO Add the rest of the OpenSIPS core statistics to:
----- !!! "NET" Class TODO ---- !!! "MEM" Class TODO February 21, 2011, at 06:23 PM
by -
Changed line 12 from:
opensipsctl fifo get_statistics tcp_load to:
opensipsctl fifo get_statistics tcp-load February 21, 2011, at 06:22 PM
by -
Changed lines 10-14 from:
!!!!udp:int_ip:int_port-load Returns the percentage of UDP children that are awake and processing SIP messages on the specific UDP interface Example of usage: to:
Example of usage through MI FIFO: Added lines 12-20:
opensipsctl fifo get_statistics tcp_load @] !!!!udp:int_ip:int_port-load Returns the percentage of UDP children that are awake and processing SIP messages on the specific UDP interface Example of usage through MI FIFO: [@ Added lines 27-28:
opensipsctl fifo get_statistics udp:192.168.2.134:5060-load February 21, 2011, at 06:13 PM
by - February 21, 2011, at 06:13 PM
by -
Changed lines 23-26 from:
@] to:
@] !!!!TODO Add the rest of the OpenSIPS core statistics February 21, 2011, at 06:12 PM
by -
Changed lines 20-21 from:
Then there will be two exported statistics, udp:192.168.2.134:5060-load and udp:192.168.10.13:5090-load, and each will show the percentage of working children on the respective interfaces. to:
Then there will be two exported statistics, udp:192.168.2.134:5060-load and udp:192.168.10.13:5090-load, and each will show the percentage of working children on the respective interfaces. February 21, 2011, at 06:11 PM
by -
Added line 13:
February 21, 2011, at 06:11 PM
by -
Changed lines 9-21 from:
TEST to:
Returns the percentage of TCP children that are awake and processing SIP messages. !!!!udp:int_ip:int_port-load Returns the percentage of UDP children that are awake and processing SIP messages on the specific UDP interface Example of usage: [@ If OpenSIPS has two listen directives : listen=udp:192.168.2.134:5060 listen=udp:192.168.10.13:5090 Then there will be two exported statistics, udp:192.168.2.134:5060-load and udp:192.168.10.13:5090-load, and each will show the percentage of working children on the respective interfaces. @] February 21, 2011, at 06:07 PM
by -
Added lines 1-9:
!!Resources -> [[Resources.Documentation | Documentation]] -> [[Resources.DocsCookbooks | CookBooks]] -> Core Statistics v1.7/devel (:toc-float Table of Content:) Statistics which are exported by the '''OpenSIPS''' core. This document is for '''OpenSIPS 1.7.x/devel''' !!!!tcp-load TEST |