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.
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")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.
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)");...Exported Pseudo-Variables
Section titled “Exported Pseudo-Variables”Allows to get and reset core and modules exported statistics. The pseudo-variable receives as parameter the name of the statistic that it want to get or reset.
...xlog("SHM used size = $stat(used_size) \n");...$stat(err_requests) = 0;...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) | 32 | 19 | 1046 | 227 |
| 2. | Daniel-Constantin Mierla (@miconda) | 11 | 9 | 22 | 18 |
| 3. | Razvan Crainea (@razvancrainea) | 8 | 6 | 11 | 12 |
| 4. | Liviu Chircu (@liviuchircu) | 7 | 5 | 14 | 17 |
| 5. | Stefan Darius (@dariusstefan) | 6 | 3 | 162 | 17 |
| 6. | Vlad Paiu (@vladpaiu) | 5 | 2 | 156 | 13 |
| 7. | Anca Vamanu | 4 | 2 | 14 | 16 |
| 8. | Henning Westerholt (@henningw) | 4 | 2 | 4 | 4 |
| 9. | Ovidiu Sas (@ovidiusas) | 3 | 1 | 15 | 2 |
| 10. | Konstantin Bokarius | 3 | 1 | 2 | 5 |
All remaining contributors: Julián Moreno Patiño, Edson Gellert Schubert.
(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. | Bogdan-Andrei Iancu (@bogdan-iancu) | Mar 2006 - Oct 2016 |
| 4. | Julián Moreno Patiño | Feb 2016 - Feb 2016 |
| 5. | Liviu Chircu (@liviuchircu) | Mar 2014 - Apr 2015 |
| 6. | Vlad Paiu (@vladpaiu) | Jul 2010 - Feb 2011 |
| 7. | Anca Vamanu | Oct 2007 - Sep 2009 |
| 8. | Ovidiu Sas (@ovidiusas) | Jun 2008 - Jun 2008 |
| 9. | Daniel-Constantin Mierla (@miconda) | Nov 2006 - Mar 2008 |
| 10. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
All remaining contributors: 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), 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