STATUS/REPORTS module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”The Status/Report module is a wrapper over the internal status/report framework, allowing the script writer to dynamically define and use of SR groups.
By bringing the Status/Report support into the script, it opens the possibility to create custom reports from script, depending on the logic you have there.
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”script_sr_group (string)
Section titled “script_sr_group (string)”Name of a new Status/Report group to be created and later used from script level.
This parameter may be defined multiple times, in order to define multiple groups.
modparam("status_report", "script_sr_group", "security")modparam("status_report", "script_sr_group", "alarms")Exported Functions
Section titled “Exported Functions”sr_set_status( group, status, [details])
Section titled “sr_set_status( group, status, [details])”Sets a new status (and details) for a Status/Report group.
Meaning of the parameters is as follows:
- group (string) - the name of the SR group; you can change the status only for the groups defined via this module (as parameter).
- status (int) - the new status value ( strict positive meaning OK, strict negative meaning NOT OK, 0 is not accepts, it is converted to 1 automatically).
- details (string, optional) - a descripting text to detail the status value
This function can be used from any route.
...sr_set_status( "script_caching", 1, "completed");...sr_add_report( group, report)
Section titled “sr_add_report( group, report)”Adds a new report/log to a Status/Report group.This must have been defined via this module too.
Meaning of the parameters is as follows:
- group (string) - the name of the SR group; you can change the status only for the groups defined via this module (as parameter). report (string) - the log to be added.
This function can be used from any route.
...sr_add_report("security","IP $si detected as attacker");...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) | 7 | 3 | 339 | 7 |
| 2. | Stefan Darius (@dariusstefan) | 6 | 3 | 142 | 18 |
| 3. | Liviu Chircu (@liviuchircu) | 5 | 3 | 8 | 6 |
| 4. | Maksym Sobolyev (@sobomax) | 4 | 2 | 2 | 3 |
| 5. | Razvan Crainea (@razvancrainea) | 3 | 1 | 2 | 2 |
(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) | Jun 2026 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | May 2024 - May 2024 |
| 4. | Maksym Sobolyev (@sobomax) | Feb 2023 - Feb 2023 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | Feb 2022 - Feb 2022 |
(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).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0