STATISTICS module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”The Statistics module is a wrapper over the internal statistics manager, allowing the script writer to dynamically define and use of statistic variables.
By bringing the statistics support into the script, it takes advantage of the script flexibility in defining logics, making possible implementation of any kind of statistic scenario.
Statistic Groups
Section titled “Statistic Groups”Starting with OpenSIPS 2.3, statistics may be grouped by prefixing their names with the name of the desired group, along with a colon separator (e.g. $stat(method:invite) or update_stat(“packets:$var(ptype)”, “+1”)). In order for this to work, the groups must be defined prior to OpenSIPS startup using the stat groups module parameter.
The module allows easy iteration over the statistics of a group using the stat iter init and stat iter next functions.
By default, all statistics belong to the “dynamic” group.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- No dependencies on other OpenSIPS modules.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- None.
Exported Parameters
Section titled “Exported Parameters”variable (string)
Section titled “variable (string)”Name of a new statistic variable. The name may be followed by additional flag which describe the variable behavior:
- no_reset : variable cannot be reset.
modparam("statistics", "variable", "register_counter")modparam("statistics", "variable", "active_calls/no_reset")stat_groups (string)
Section titled “stat_groups (string)”A comma-separated values string, specifying the statistic groups that may be used throughout the OpenSIPS script. Groups cannot contain leading or trailing whitespace characters.
modparam("statistics", "stat_groups", "method, packet, response")Exported Functions
Section titled “Exported Functions”update_stat(variable, value)
Section titled “update_stat(variable, value)”Updates the value of the statistic variable with the new value.
Meaning of the parameters is as follows:
- variable - variable to be updated (it can be a string or a pseudovariable);
- value - value to update with; it may be also negative; variables (holding integer values) are also allowed.
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, FAILURE_ROUTE and ONREPLY_ROUTE.
...update_stat("register_counter", "+1");...$var(a_calls) = "active_calls";update_stat("$var(a_calls)", "-1");...reset_stat(variable)
Section titled “reset_stat(variable)”Resets to zero the value of the statistic variable.
Meaning of the parameters is as follows:
- variable - variable to be reset-ed (it can be a string or a pseudovariable).
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, FAILURE_ROUTE and ONREPLY_ROUTE.
...reset_stat("register_counter");...$var(reg_counter) = "register_counter";update_stat("$var(reg_counter)");...stat_iter_init(group, iter)
Section titled “stat_iter_init(group, iter)”Re-initializes “iter” in order to begin iterating through all statistics belonging to the given “group”.
Meaning of the parameters is as follows:
- group - string
- iter - string (internally matched to a corresponding iterator)
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, FAILURE_ROUTE and ONREPLY_ROUTE.
...stat_iter_init("packet", "iter");...stat_iter_next(name, val, iter)
Section titled “stat_iter_next(name, val, iter)”Attempts to fetch the current statistic to which “iter” points. If successful, the relevant data will be written to “name” and “val”, while also advancing “iter”. Returns negative when reaching the end of iteration.
Meaning of the parameters is as follows:
- name - script variable
- val - script variable
- iter - string (internally matched to a corresponding iterator)
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, FAILURE_ROUTE and ONREPLY_ROUTE.
...# periodically clear packet-related datatimer_route [clear_packet_stats, 7200] { stat_iter_init("packet", "iter"); while (stat_iter_next("$var(stat)", "$var(val)", "iter")) reset_stat("packet:$var(stat)");}...Exported Pseudo-Variables
Section titled “Exported Pseudo-Variables”Allows “get” or “reset” operations on the given statistics.
The name of a statistic may be optionally prefixed with a searching group, along with a colon separator.
If a searching group is not provided, the statistic is first searched for in the core groups. If not found, search continues with the “dynamic” group which, by default, holds all non-explicitly grouped statistics which are not exported by the OpenSIPS core.
...xlog("SHM used size = $stat(used_size), no_invites = $stat(method:invite)\n");...$stat(err_requests) = 0;...doc copyrights:
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 34 | 20 | 1061 | 252 |
| 2. | Liviu Chircu (@liviuchircu) | 25 | 17 | 534 | 178 |
| 3. | Razvan Crainea (@razvancrainea) | 12 | 10 | 19 | 13 |
| 4. | Daniel-Constantin Mierla (@miconda) | 11 | 9 | 22 | 18 |
| 5. | Stefan Darius (@dariusstefan) | 7 | 3 | 290 | 40 |
| 6. | Vlad Paiu (@vladpaiu) | 5 | 2 | 156 | 13 |
| 7. | Anca Vamanu | 4 | 2 | 14 | 16 |
| 8. | Henning Westerholt (@henningw) | 4 | 2 | 4 | 4 |
| 9. | Ionut Ionita (@ionutrazvanionita) | 3 | 1 | 17 | 1 |
| 10. | Ovidiu Sas (@ovidiusas) | 3 | 1 | 15 | 2 |
All remaining contributors: Konstantin Bokarius, Julián Moreno Patiño, Edson Gellert Schubert, Vlad Patrascu (@rvlad-patrascu).
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Feb 2012 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | Mar 2014 - Nov 2020 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Mar 2006 - Jun 2018 |
| 5. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - May 2017 |
| 6. | Ionut Ionita (@ionutrazvanionita) | Apr 2017 - Apr 2017 |
| 7. | Julián Moreno Patiño | Feb 2016 - Feb 2016 |
| 8. | Vlad Paiu (@vladpaiu) | Jul 2010 - Feb 2011 |
| 9. | Anca Vamanu | Oct 2007 - Sep 2009 |
| 10. | Ovidiu Sas (@ovidiusas) | Jun 2008 - Jun 2008 |
All remaining contributors: Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Henning Westerholt (@henningw).
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Liviu Chircu (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Vlad Paiu (@vladpaiu), Ovidiu Sas (@ovidiusas), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert.
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0