Core Statistics
The OpenSIPS core exports several statistics, which are grouped into classes. To view all statistics which correspond to a class, fetch the “class:” statistic (e.g. opensipsctl fifo get_statistic load: core: shmem:)
“CORE” class
Section titled ““CORE” class”rcv_requests
Section titled “rcv_requests”Returns the total number of received requests by OpenSIPS.
Example of usage through MI FIFO
opensipsctl fifo get_statistics rcv_requestsExample of usage from script
xlog("Total number of received requests = $stat(rcv_requests) \n");rcv_replies
Section titled “rcv_replies”Returns the total number of received replies by OpenSIPS.
Example of usage through MI FIFO
opensipsctl fifo get_statistics rcv_repliesExample of usage from script
xlog("Total number of received replies = $stat(rcv_replies) \n");fwd_requests
Section titled “fwd_requests”Returns the number of stateless forwarded requests by OpenSIPS.
Example of usage through MI FIFO
opensipsctl fifo get_statistics fwd_requestsExample of usage from script
xlog("Total number of forwarded requests = $stat(fwd_requests) \n");fwd_replies
Section titled “fwd_replies”Returns the number of stateless forwarded replies by OpenSIPS.
Example of usage through MI FIFO
opensipsctl fifo get_statistics fwd_repliesExample of usage from script
xlog("Total number of forwarded replies = $stat(fwd_replies) \n");drop_requests
Section titled “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_requestsExample of usage from script
xlog("Total number of dropped requests = $stat(drop_requests) \n");drop_replies
Section titled “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_repliesExample of usage from script
xlog("Total number of dropped replies = $stat(drop_replies) \n");err_requests
Section titled “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_requestsExample of usage from script
xlog("Total number of error requests = $stat(err_requests) \n");err_replies
Section titled “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_repliesExample of usage from script
xlog("Total number of error replies = $stat(err_replies) \n");bad_URIs_rcvd
Section titled “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_rcvdExample of usage from script
xlog("Total number of bad URIs detected = $stat(bad_URIs_rcvd) \n");unsupported_methods
Section titled “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_methodsExample of usage from script
xlog("Total number of unsupported methods detected = $stat(unsupported_methods) \n");bad_msg_hdr
Section titled “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_hdrExample of usage from script
xlog("Total number of headers that failed to parse = $stat(bad_msg_hdr) \n");timestamp
Section titled “timestamp”Returns the number of seconds elapsed from OpenSIPS starting.
Example of usage through MI FIFO
opensipsctl fifo get_statistics timestampExample of usage from script
xlog("OpenSIPS has been alive for $stat(timestamp) seconds \n");”LOAD” class
Section titled “”LOAD” class”Statistics giving information on OpenSIPS load (busy children).
tcp-load
Section titled “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-loadExample of usage from script
xlog("The TCP load is $stat(tcp-load) \n");udp:int_ip:int_port-load
Section titled “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.368.2.334:5060listen=udp:192.368.10.13:5090
Then there will be two exported statistics, udp:192.368.2.334:5060-load and udp:192.368.10.13:5090-load, and eachwill show the percentage of working children on the respective interfaces.
opensipsctl fifo get_statistics udp:192.368.2.334:5060-loadExample of usage from script
xlog("The UDP load on 192.368.2.334:5060 is $stat(udp:192.368.2.334:5060-load) \n");”NET” class
Section titled “”NET” class”Statistics giving information about UDP, TCP and TLS buffers on interfaces that OpenSIPS is listening on.
waiting_udp
Section titled “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_udpExample of usage from script
xlog("The UDP waiting buffer size is $stat(waiting_udp) \n");waiting_tcp
Section titled “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_tcpExample of usage from script
xlog("The TCP waiting buffer size is $stat(waiting_tcp) \n");waiting_tls
Section titled “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_tlsExample of usage from script
xlog("The TLS waiting buffer size is $stat(waiting_tls) \n");”SHMEM” class
Section titled “”SHMEM” class”Statistics giving information on the shared memory that OpenSIPS is using.
total_size
Section titled “total_size”Returns the total size of shared memory available to OpenSIPS processes.
Example of usage through MI FIFO
opensipsctl fifo get_statistics total_sizeExample of usage from script
xlog("Total size of SHMEM available is $stat(total_size) \n");used_size
Section titled “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_sizeExample of usage from script
xlog("SHMEM in use = $stat(used_size) \n");real_used_size
Section titled “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_sizeExample of usage from script
xlog("Real SHMEM used size is $stat(real_used_size) \n");max_used_size
Section titled “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_sizeExample of usage from script
xlog("The max SHMEM ever used is $stat(max_used_size) \n");free_size
Section titled “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_sizeExample of usage from script
xlog("Free SHMEM available is $stat(free_size) \n");fragments
Section titled “fragments”Returns the total number of fragments in the shared memory.
Example of usage through MI FIFO
opensipsctl fifo get_statistics fragmentsExample of usage from script
xlog("The total number of SHMEM fragments is $stat(fragments) \n");”PKMEM” class
Section titled “”PKMEM” class”Various private memory related statistics for each OpenSIPS process. Each “PKMEM” statistic is prefixed by a number, representing the index of an OpenSIPS process (0, 1, …).
N-total_size
Section titled “N-total_size”Returns the total size of private memory available to OpenSIPS process #N.
Example of usage through MI FIFO
opensipsctl fifo get_statistics 0-total_sizeExample of usage from script
xlog("Total size of PKG memory available for process #0 is $stat(0-total_size) \n");N-used_size
Section titled “N-used_size”Returns the amount of private memory requested and used by OpenSIPS process #N.
Example of usage through MI FIFO
opensipsctl fifo get_statistics 0-used_sizeExample of usage from script
xlog("PKG mem in use for process #1 = $stat(1-used_size) \n");N-real_used_size
Section titled “N-real_used_size”Returns the amount of private memory requested by OpenSIPS process #N, including allocator-specific metadata
Example of usage through MI FIFO
opensipsctl fifo get_statistics 0-real_used_sizeExample of usage from script
xlog("Process #0 actually uses $stat(0-real_used_size) bytes of private memory\n");N-max_used_size
Section titled “N-max_used_size”Returns the maximum amount of private memory ever used by OpenSIPS process #N.
Example of usage through MI FIFO
opensipsctl fifo get_statistics 0-max_used_sizeExample of usage from script
xlog("The max PKG memory ever used for process #0 is $stat(0-max_used_size) \n");N-free_size
Section titled “N-free_size”Returns the free private memory available for OpenSIPS process #N. Computed as total_size - real_used_size
Example of usage through MI FIFO
opensipsctl fifo get_statistics 0-free_sizeExample of usage from script
xlog("Free PKG memory available for process #0 is $stat(0-free_size) \n");N-fragments
Section titled “N-fragments”Returns the currently available number of free fragments in the private memory for OpenSIPS process #N.
Example of usage through MI FIFO
opensipsctl fifo get_statistics 0-fragmentsExample of usage from script
xlog("The total number of PKG fragments is $stat(0-fragments) \n");