|
Documentation |
Documentation.Interface-CoreStatistics-2-2 HistoryShow minor edits - Show changes to output November 28, 2016, at 11:32 AM
by -
Changed line 1 from:
!!!!!Documentation -> [[Documentation.Manuals|Manuals]] -> [[Documentation.Manual-2-2|Manual devel]] -> Core Statistics to:
!!!!!Documentation -> [[Documentation.Manuals|Manuals]] -> [[Documentation.Manual-2-2|Manual 2.2]] -> Core Statistics July 09, 2014, at 01:51 PM
by -
Changed line 454 from:
Returns the free private memory available. Computed as total_size - real_used_size to:
Returns the free private memory available for OpenSIPS process #N. Computed as total_size - real_used_size July 09, 2014, at 01:50 PM
by -
Changed lines 468-469 from:
!!!!0-fragments Returns the currently available number of free fragments in the private memory. to:
!!!!N-fragments Returns the currently available number of free fragments in the private memory for OpenSIPS process #N. July 09, 2014, at 01:50 PM
by -
Changed lines 15-16 from:
Statistics which are exported by the '''OpenSIPS''' core. to:
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:''') Changed lines 18-19 from:
!!! "CORE" Class to:
!!! "CORE" class Changed lines 244-245 from:
!!! "NET" Class to:
!!! "NET" class Changed lines 294-295 from:
!!! "SHMEM" Class to:
!!! "SHMEM" class Added lines 385-479:
@] ---- !!! "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 Returns the total size of private memory available to OpenSIPS process #N. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics 0-total_size @] Example of usage from script [@ xlog("Total size of PKG memory available for process #0 is $stat(0-total_size) \n"); @] !!!!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_size @] Example of usage from script [@ xlog("PKG mem in use for process #1 = $stat(1-used_size) \n"); @] !!!!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_size @] Example of usage from script [@ xlog("Process #0 actually uses $stat(0-real_used_size) bytes of private memory\n"); @] !!!!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_size @] Example of usage from script [@ xlog("The max PKG memory ever used for process #0 is $stat(0-max_used_size) \n"); @] !!!!N-free_size Returns the free private memory available. Computed as total_size - real_used_size Example of usage through MI FIFO [@ opensipsctl fifo get_statistics 0-free_size @] Example of usage from script [@ xlog("Free PKG memory available for process #0 is $stat(0-free_size) \n"); @] !!!!0-fragments Returns the currently available number of free fragments in the private memory. Example of usage through MI FIFO [@ opensipsctl fifo get_statistics 0-fragments @] Example of usage from script [@ xlog("The total number of PKG fragments is $stat(0-fragments) \n"); March 20, 2014, at 08:59 PM
by -
Added lines 1-386:
!!!!!Documentation -> [[Documentation.Manuals|Manuals]] -> [[Documentation.Manual-2-2|Manual devel]] -> Core Statistics (:title Core Statistics - 2.2:) ---- (:allVersions Interface-CoreStatistics 2.2:) \\ || %color=#185662%[+'''Core Statistics v2.2 '''+]%% || ||[[Interface-Statistics-2-2|Prev]] || [[Interface-Binary-2-2|Next]]|| ---- (:toc-float Table of Content:) Statistics which are exported by the '''OpenSIPS''' core. ---- !!! "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.268.2.234:5060 listen=udp:192.268.10.13:5090 Then there will be two exported statistics, udp:192.268.2.234:5060-load and udp:192.268.10.13:5090-load, and each will show the percentage of working children on the respective interfaces. opensipsctl fifo get_statistics udp:192.268.2.234:5060-load @] Example of usage from script [@ xlog("The UDP load on 192.268.2.234:5060 is $stat(udp:192.268.2.234: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"); @] |
Page last modified on November 28, 2016, at 11:32 AM