Documentation

Documentation.Interface-CoreStatistics-3-3 History

Hide minor edits - Show changes to markup

April 16, 2021, at 11:47 AM by razvancrainea -
Changed lines 156-159 from:

unsupported_methods

Returns the number of non-standard methods encountered by OpenSIPS while parsing SIP methods.

Example of usage through MI FIFO

to:

Example of usage from script

Changed lines 159-160 from:

opensips-cli -x mi get_statistics unsupported_methods

to:

xlog("Total number of unsupported methods detected = $stat(unsupported_methods) \n");

Changed lines 163-167 from:

Example of usage from script

to:

bad_msg_hdr

Returns the number of SIP headers that OpenSIPS failed to parse.

Example of usage through MI FIFO

Changed lines 169-170 from:

xlog("Total number of unsupported methods detected = $stat(unsupported_methods) \n");

to:

opensips-cli -x mi get_statistics bad_msg_hdr

Changed lines 172-176 from:

bad_msg_hdr

Returns the number of SIP headers that OpenSIPS failed to parse.

Example of usage through MI FIFO

to:

Example of usage from script

Changed lines 174-175 from:

opensips-cli -x mi get_statistics bad_msg_hdr

to:

xlog("Total number of headers that failed to parse = $stat(bad_msg_hdr) \n");

Changed lines 178-181 from:

Example of usage from script

to:

timestamp

Returns the number of seconds elapsed from OpenSIPS starting.

Example of usage through MI FIFO

Changed lines 183-184 from:

xlog("Total number of headers that failed to parse = $stat(bad_msg_hdr) \n");

to:

opensips-cli -x mi get_statistics timestamp

Changed lines 186-189 from:

timestamp

Returns the number of seconds elapsed from OpenSIPS starting.

Example of usage through MI FIFO

to:

Example of usage from script

Changed lines 188-189 from:

opensips-cli -x mi get_statistics timestamp

to:

xlog("OpenSIPS has been alive for $stat(timestamp) seconds \n");

Changed lines 192-198 from:

Example of usage from script

xlog("OpenSIPS has been alive for $stat(timestamp) seconds \n");

to:
Changed line 517 from:

@

to:

@]

May 27, 2020, at 01:51 PM by razvancrainea -
Changed lines 15-16 from:

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:)

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. opensips-cli -x mi get_statistics load: core: shmem:)

Changed lines 25-26 from:

opensipsctl fifo get_statistics rcv_requests

to:

opensips-cli -x mi get_statistics rcv_requests

Changed lines 40-41 from:

opensipsctl fifo get_statistics rcv_replies

to:

opensips-cli -x mi get_statistics rcv_replies

Changed lines 55-56 from:

opensipsctl fifo get_statistics fwd_requests

to:

opensips-cli -x mi get_statistics fwd_requests

Changed lines 70-71 from:

opensipsctl fifo get_statistics fwd_replies

to:

opensips-cli -x mi get_statistics fwd_replies

Changed lines 85-86 from:

opensipsctl fifo get_statistics drop_requests

to:

opensips-cli -x mi get_statistics drop_requests

Changed lines 101-102 from:

opensipsctl fifo get_statistics drop_replies

to:

opensips-cli -x mi get_statistics drop_replies

Changed lines 116-117 from:

opensipsctl fifo get_statistics err_requests

to:

opensips-cli -x mi get_statistics err_requests

Changed lines 131-132 from:

opensipsctl fifo get_statistics err_replies

to:

opensips-cli -x mi get_statistics err_replies

Changed lines 146-147 from:

opensipsctl fifo get_statistics bad_URIs_rcvd

to:

opensips-cli -x mi get_statistics bad_URIs_rcvd

Changed lines 161-162 from:

opensipsctl fifo get_statistics unsupported_methods

to:

opensips-cli -x mi get_statistics unsupported_methods

Changed line 177 from:

opensipsctl fifo get_statistics bad_msg_hdr

to:

opensips-cli -x mi get_statistics bad_msg_hdr

Changed line 191 from:

opensipsctl fifo get_statistics timestamp

to:

opensips-cli -x mi get_statistics timestamp

Changed line 218 from:

opensipsctl fifo get_statistics load

to:

opensips-cli -x mi get_statistics load

Changed line 243 from:

opensipsctl fifo get_statistics load-all

to:

opensips-cli -x mi get_statistics load-all

Changed line 268 from:

opensipsctl fifo get_statistics load-proc-5

to:

opensips-cli -x mi get_statistics load-proc-5

Changed lines 297-298 from:

opensipsctl fifo get_statistics waiting_udp

to:

opensips-cli -x mi get_statistics waiting_udp

Changed lines 312-313 from:

opensipsctl fifo get_statistics waiting_tcp

to:

opensips-cli -x mi get_statistics waiting_tcp

Changed lines 327-328 from:

opensipsctl fifo get_statistics waiting_tls

to:

opensips-cli -x mi get_statistics waiting_tls

Changed lines 347-348 from:

opensipsctl fifo get_statistics total_size

to:

opensips-cli -x mi get_statistics total_size

Changed lines 362-363 from:

opensipsctl fifo get_statistics used_size

to:

opensips-cli -x mi get_statistics used_size

Changed lines 377-378 from:

opensipsctl fifo get_statistics real_used_size

to:

opensips-cli -x mi get_statistics real_used_size

Changed lines 392-393 from:

opensipsctl fifo get_statistics max_used_size

to:

opensips-cli -x mi get_statistics max_used_size

Changed lines 407-408 from:

opensipsctl fifo get_statistics free_size

to:

opensips-cli -x mi get_statistics free_size

Changed lines 422-423 from:

opensipsctl fifo get_statistics fragments

to:

opensips-cli -x mi get_statistics fragments

Changed lines 442-443 from:

opensipsctl fifo get_statistics 0-total_size

to:

opensips-cli -x mi get_statistics 0-total_size

Changed lines 457-458 from:

opensipsctl fifo get_statistics 0-used_size

to:

opensips-cli -x mi get_statistics 0-used_size

Changed lines 472-473 from:

opensipsctl fifo get_statistics 0-real_used_size

to:

opensips-cli -x mi get_statistics 0-real_used_size

Changed lines 487-488 from:

opensipsctl fifo get_statistics 0-max_used_size

to:

opensips-cli -x mi get_statistics 0-max_used_size

Changed lines 502-503 from:

opensipsctl fifo get_statistics 0-free_size

to:

opensips-cli -x mi get_statistics 0-free_size

Changed lines 517-518 from:

opensipsctl fifo get_statistics 0-fragments

to:

opensips-cli -x mi get_statistics 0-fragments

Changed line 525 from:

@]

to:

@

March 27, 2018, at 03:36 PM by 109.99.227.30 -
Changed lines 230-231 from:

The last minute average load of core OpenSIPS (covering only core/SIP processes). For more, see [[#load|load].

to:

The last minute average load of core OpenSIPS (covering only core/SIP processes). For more, see load.

Changed lines 234-236 from:

The last 10 minutes average load of core OpenSIPS (covering only core/SIP processes). For more, see [[#load|load].

to:

The last 10 minutes average load of core OpenSIPS (covering only core/SIP processes). For more, see load.

Changed lines 255-256 from:

The last minute average load of entire OpenSIPS (covering all processes). For more, see [[#load-all|load-all].

to:

The last minute average load of entire OpenSIPS (covering all processes). For more, see load-all.

Changed line 259 from:

The last 10 minutes average load of entire OpenSIPS (covering all processes). For more, see [[#load-all|load-all].

to:

The last 10 minutes average load of entire OpenSIPS (covering all processes). For more, see load-all.

March 17, 2018, at 09:43 PM by 89.45.16.83 -
Changed line 212 from:

load

to:

load

Changed line 229 from:

load1m

to:

load1m

Changed line 233 from:

load10m

to:

load10m

Changed line 238 from:

load-all

to:

load-all

Changed line 254 from:

load1m-all

to:

load1m-all

Changed line 258 from:

load10m-all

to:

load10m-all

Changed line 263 from:

load-proc-id

to:

load-proc-id

Changed line 279 from:

load1m-proc-id

to:

load1m-proc-id

Changed line 283 from:

load10m-proc-id

to:

load10m-proc-id

March 02, 2018, at 06:06 PM by 109.99.227.30 -
Changed line 238 from:

load-all

to:

load-all

Changed line 254 from:

load1m

to:

load1m-all

Changed line 258 from:

load10m

to:

load10m-all

March 02, 2018, at 06:05 PM by 109.99.227.30 -
Changed lines 213-214 from:

The realtime load of entire OpenSIPS (covering all processes). Note that this value may be affected (reported a lower value than real) by various additional processes that do not calculate load at all (and recorded as load 0); such processes are timer keepers or per-module additional processes.

to:

The realtime load of entire OpenSIPS - this counts all the core processes of OpenSIPS; the additional processes requested by modules are not counted in this load. Also note that some core processes are not counted as they do not generate any kind of load; such processes are the attendant, the time keeper and the timer trigger. This statistic is actually reflecting the load generated by processing the SIP traffic (as only the core active processes are counted).

Changed lines 224-225 from:

xlog("The overall OpenSIPS load is $stat(load) \n");

to:

xlog("The OpenSIPS processing load is $stat(load) \n");

Changed lines 230-231 from:

The last minute average load of entire OpenSIPS (covering all processes). For more, see [[#load|load].

to:

The last minute average load of core OpenSIPS (covering only core/SIP processes). For more, see [[#load|load].

Changed lines 234-239 from:

The last 10 minutes average load of entire OpenSIPS (covering all processes). For more, see [[#load|load].

load-proc-id

The realtime load of the process ID. To learn the IDs of the OpenSIPS processes (and their types), use the ps MI command.

to:

The last 10 minutes average load of core OpenSIPS (covering only core/SIP processes). For more, see [[#load|load].

load-all

The realtime load of entire OpenSIPS, counting both core and module processes. Similar to [[#load|load], the processes not generating load at all are not counted.

Example of usage through MI FIFO

opensipsctl fifo get_statistics load-all
load:load-all:: 24

Example of usage from script

xlog("The overall OpenSIPS load is $stat(load-all) \n");

load1m

The last minute average load of entire OpenSIPS (covering all processes). For more, see [[#load-all|load-all].

load10m

The last 10 minutes average load of entire OpenSIPS (covering all processes). For more, see [[#load-all|load-all].

February 07, 2018, at 05:41 PM by 109.99.227.30 -
Changed lines 223-224 from:

xlog("The TCP load is $stat(load) \n");

to:

xlog("The overall OpenSIPS load is $stat(load) \n");

Changed line 247 from:

xlog("The TCP load is $stat(load) \n");

to:

xlog("The load of processes 5 is $stat(load-proc-5) \n");

February 07, 2018, at 05:35 PM by liviu -
Changed line 212 from:

load link

to:

load

Changed line 228 from:

load1m link

to:

load1m

Changed line 232 from:

load10m link

to:

load10m

Changed line 236 from:

load-proc-id link

to:

load-proc-id

Changed line 252 from:

load1m-proc-id link

to:

load1m-proc-id

Changed line 256 from:

load10m-proc-id link

to:

load10m-proc-id

February 07, 2018, at 05:28 PM by 109.99.227.30 -
Changed line 218 from:
to:

load:load:: 24

Changed lines 227-230 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:

load1m link

The last minute average load of entire OpenSIPS (covering all processes). For more, see [[#load|load].

load10m link

The last 10 minutes average load of entire OpenSIPS (covering all processes). For more, see [[#load|load].

load-proc-id link

The realtime load of the process ID. To learn the IDs of the OpenSIPS processes (and their types), use the ps MI command.

Example of usage through MI FIFO

Changed lines 241-249 from:

If OpenSIPS has two listen directives : listen=udp:193.368.3.334:5060 listen=udp:193.368.10.13:5090

Then there will be two exported statistics, udp:193.368.3.334:5060-load and udp:193.368.10.13:5090-load, and each will show the percentage of working children on the respective interfaces.

opensipsctl fifo get_statistics udp:193.368.3.334:5060-load

to:

opensipsctl fifo get_statistics load-proc-5 load:load-proc-5:: 79

Changed lines 247-248 from:

xlog("The UDP load on 193.368.3.334:5060 is $stat(udp:193.368.3.334:5060-load) \n");

to:

xlog("The TCP load is $stat(load) \n");

Added lines 250-258:

load1m-proc-id link

The last minute average load of the process ID. For more, see load-proc-id.

load10m-proc-id link

The last 10 minutes average load of the process ID. For more, see load-proc-id.

February 07, 2018, at 05:18 PM by 109.99.227.30 -
Changed line 212 from:

load ^link^

to:

load link

February 07, 2018, at 05:17 PM by 109.99.227.30 -
Changed lines 204-208 from:

Statistics giving information on OpenSIPS load (busy children).

tcp-load

Returns the percentage of TCP children that are awake and processing SIP messages.

to:

Statistics giving information about the OpenSIPS internal load. The load is defined as percentage of time spent in doing processing versus total time. Following the model of "top", there are three load values, calculated over different periods of time:

  • realtime load - calculated over the last 1 second
  • last minute load - calculated over the last 1 minute
  • last 10 minutes load - calculated over the last 10 minutes

All three load values are provided by OpenSIPS in a per-process manner (the load of each process) and globally (covering all processes).

load ^link^

The realtime load of entire OpenSIPS (covering all processes). Note that this value may be affected (reported a lower value than real) by various additional processes that do not calculate load at all (and recorded as load 0); such processes are timer keepers or per-module additional processes.

Changed lines 217-218 from:

opensipsctl fifo get_statistics tcp-load

to:

opensipsctl fifo get_statistics load

Changed line 223 from:

xlog("The TCP load is $stat(tcp-load) \n");

to:

xlog("The TCP load is $stat(load) \n");

July 09, 2014, at 01:51 PM by liviu -
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 liviu -
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 liviu -
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 razvancrainea -
Added lines 1-386:
Documentation -> Manuals -> Manual devel -> Core Statistics

(:title Core Statistics - 3.3:)


(:allVersions Interface-CoreStatistics 3.3:)


Core Statistics v3.3
PrevNext

(: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:193.368.3.334:5060
listen=udp:193.368.10.13:5090

Then there will be two exported statistics, udp:193.368.3.334:5060-load and udp:193.368.10.13:5090-load, and each 
will show the percentage of working children on the respective interfaces.

opensipsctl fifo get_statistics udp:193.368.3.334:5060-load

Example of usage from script

xlog("The UDP load on 193.368.3.334:5060 is $stat(udp:193.368.3.334: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 April 16, 2021, at 11:47 AM