Documentation

Documentation.Interface-Statistics-1-9 History

Hide minor edits - Show changes to markup

August 05, 2013, at 03:26 PM by 109.99.235.212 -
Changed lines 4-5 from:

Page for other versions: devel 1.9 1.8 old versions: 1.7 1.6 1.5 1.4

to:

(:allVersions Interface-Statistics 1.9:)

Changed line 69 from:

@]

to:

@]

May 29, 2013, at 11:24 AM by 109.99.235.212 -
Changed line 2 from:

(:title Statistics Interface ver 1.9 :)

to:

(:title Statistics Interface - ver 1.9 :)

Changed lines 4-5 from:

Page for other versions devel 1.9 1.8 old versions : 1.7 1.6 1.5 1.4

to:

Page for other versions: devel 1.9 1.8 old versions: 1.7 1.6 1.5 1.4

Changed line 8 from:
Statistics Interface
to:
Statistics Interface v1.9
May 29, 2013, at 11:18 AM by 109.99.235.212 -
Changed line 61 from:
to:
May 28, 2013, at 07:47 PM by 109.99.235.212 -
Added line 2:

(:title Statistics Interface ver 1.9 :)

May 28, 2013, at 07:33 PM by 109.99.235.212 -
Deleted line 9:

May 28, 2013, at 07:05 PM by 109.99.235.212 -
Changed line 5 from:

 \\

to:

\\

May 28, 2013, at 07:05 PM by 109.99.235.212 -
Added lines 4-6:

 

May 28, 2013, at 07:03 PM by 109.99.235.212 -
Changed line 6 from:
to:
May 28, 2013, at 07:02 PM by 109.99.235.212 -
Changed line 6 from:
to:
May 28, 2013, at 07:02 PM by 109.99.235.212 -
Changed lines 3-6 from:

Page for other versions devel 1.9 1.8 old versions : 1.7 1.6 1.5 1.4

Statistics Interface
NextNext
to:

Page for other versions devel 1.9 1.8 old versions : 1.7 1.6 1.5 1.4

Statistics Interface
NextNext
May 28, 2013, at 06:54 PM by 109.99.235.212 -
Changed lines 1-7 from:
Documentation -> Manuals -> Manual 1.9 -> Interface -> Statistics
to:
Documentation -> Manuals -> Manual 1.9 -> Statistics Interface

Page for other versions devel 1.9 1.8 old versions : 1.7 1.6 1.5 1.4

Statistics Interface
NextNext

May 28, 2013, at 06:26 PM by 109.99.235.212 -
Changed lines 51-55 from:

Reseting the value of a statistic variable (to 0 value), but only if it is counter-type variable - otherwise the reset operation will have no effect. The MI reset_statistics command can be used here:

to:

Reseting the value of a statistic variable (to 0 value), but only if it is counter-type variable.

Reseting a computed-value statistic will be ignored and have no effect.

 The MI reset_statistics command can be used here:
May 28, 2013, at 12:16 PM by 109.99.235.212 -
Changed line 4 from:

The Statistics Interface is an OpenSIPS interface that provides access to various internal statistics of OpenSIPS. The statistic provide useful information about what is going on inside OpenSIPS - this can be used by external applications, for monitoring purposes, load evaluation, realtime integration with other services.

to:

The Statistics Interface is an OpenSIPS interface that provides access to various internal statistics of OpenSIPS. The statistic provide useful information about what is going on inside OpenSIPS - this can be used by external applications, for monitoring purposes, load evaluation, realtime integration with other services. The values of statistic variables are exclusively numerical.

May 28, 2013, at 12:15 PM by 109.99.235.212 -
Changed line 50 from:
to:

\\

May 28, 2013, at 12:14 PM by 109.99.235.212 -
Changed lines 22-23 from:

To get access to the statistics you have to use the MI interface which provides (directly from OpenSIPS core) several MI functions for:

  • fetching the value of a statistic variable, of an entire group of variables or of all variables. The MI get_statistics command can be used here:
to:

To get access to the statistics you have to use the MI interface which provides (directly from OpenSIPS core) several MI functions for:

Fetching the value of a statistic variable, of an entire group of variables or of all variables. The MI get_statistics command can be used here:

Changed line 51 from:
  • reseting the value of a statistic variable (to 0 value), but only if it is counter-type variable - otherwise the reset operation will have no effect. The MI reset_statistics command can be used here:
to:

Reseting the value of a statistic variable (to 0 value), but only if it is counter-type variable - otherwise the reset operation will have no effect. The MI reset_statistics command can be used here:

May 28, 2013, at 12:13 PM by 109.99.235.212 -
Added line 6:

Added line 19:

Changed line 23 from:
  • fetching value of a statistic variable, of an entire group of variables or of all variables. The MI get_statistics command can be used here:
to:
  • fetching the value of a statistic variable, of an entire group of variables or of all variables. The MI get_statistics command can be used here:
Changed lines 31-37 from:
   # get multiple stats by group
to:
   # get various statistic variables, by list of names
   > opensipsctl fifo get_statistics rcv_requests inuse_transactions
   > core:rcv_requests = 453
   > tm:inuse_transactions = 10


   # get all stats from a group
Added lines 45-48:
   # get all stats from OpenSIPS
   > opensipsctl fifo get_statistics all
   >...........
Changed lines 50-56 from:
  • reset value
to:
  • reseting the value of a statistic variable (to 0 value), but only if it is counter-type variable - otherwise the reset operation will have no effect. The MI reset_statistics command can be used here:
   # reset one statistic variable, by name
   > opensipsctl fifo reset_statistics rcv_requests
May 28, 2013, at 11:59 AM by 109.99.235.212 -
May 28, 2013, at 11:55 AM by 109.99.235.212 -
May 28, 2013, at 11:53 AM by 109.99.235.212 -
Changed lines 4-6 from:

The Statistics Interface is an OpenSIPS interface that provides you access to various internal statistics of OpenSIPS.

Overview

to:

The Statistics Interface is an OpenSIPS interface that provides access to various internal statistics of OpenSIPS. The statistic provide useful information about what is going on inside OpenSIPS - this can be used by external applications, for monitoring purposes, load evaluation, realtime integration with other services.

Overview

OpenSIPS typically provides two types of statistic variables:

  1. counter like - variables that keep counting things that happened in OpenSIPS, like received requests, processed dialogs, failed DB queries, etc
  2. computed values - variables that are calculated in realtime, like how much memory is used, the current load, active dialogs, active transactions, etc

The statistic variables are not restart persistent, they all start with a 0 value (the counter like variables). The counter like statistics can also be reset (to 0 value) during OpenSIPS runtime.

In OpenSIPS, the statistics variables are grouped in different sets, depending on their purposes or how is providing them. For example, the OpenSIPS core provides the shmem, load, net, etc groups, while each OpenSIPS module provides its own group (typically the group has the same name as the module).

All available statistic variables are listed and documented : statistics provided by OpenSIPS core or by OpenSIPS modules (see the Statistics chapter for each module).

Usage

To get access to the statistics you have to use the MI interface which provides (directly from OpenSIPS core) several MI functions for:

  • fetching value of a statistic variable, of an entire group of variables or of all variables. The MI get_statistics command can be used here:
   # get one statistic variable, by name
   > opensipsctl fifo get_statistics rcv_requests
   > core:rcv_requests = 3428
   > opensipsctl fifo get_statistics real_used_size 
   > shmem:real_used_size = 2951864

   # get multiple stats by group
   > opensipsctl fifo get_statistics shmem:
   > shmem:total_size = 33554432
   > shmem:used_size = 2897024
   > shmem:real_used_size = 2951864
   > shmem:max_used_size = 2952304
   > shmem:free_size = 30602568
   > shmem:fragments = 26
  • reset value
May 28, 2013, at 11:12 AM by 109.99.235.212 -
Added lines 1-6:
Documentation -> Manuals -> Manual 1.9 -> Interface -> Statistics

The Statistics Interface is an OpenSIPS interface that provides you access to various internal statistics of OpenSIPS.

Overview


Page last modified on August 05, 2013, at 03:26 PM