EVENT_FLATSTORE module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”The event_flatstore module provides a logging facility for different events, triggered through the OpenSIPS Event Interface, directly from the OpenSIPS script. The module logs the events along with their parameters in plain text files.
Flatstore socket syntax
Section titled “Flatstore socket syntax”flatstore:path_to_file
Meanings:
- flatstore: - informs the Event Interface that the events sent to this subscriber should be handled by the event_flatstore module.
- path_to_file - path to the file where the logged events will be appended to. The file will be created if it does not exist. It must be a valid path and not a directory.
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”max_open_sockets (integer)
Section titled “max_open_sockets (integer)”Defines the maximum number of simultaneously opened files by the module. If the maximum limit is reached, an error message will be thrown, and further subscriptions will only be possible after at least one of the current subscriptions will expire.
Default value is “100”.
...modparam("event_flatstore", "max_open_sockets", 200)...delimiter (string)
Section titled “delimiter (string)”Sets the separator between the parameters of the event in the logging file.
Default value is ”,“.
...modparam("event_flatstore", "delimiter", ";")...file_permissions (string)
Section titled “file_permissions (string)”Sets the permissions for the newly created logs. It expects a string representation of a octal value.
Default value is “644”.
...modparam("event_flatstore", "file_permissions", "664")...suppress_event_name (int)
Section titled “suppress_event_name (int)”Suppresses the name of the event in the log file.
Default value is “0/OFF” (the event’s name is printed).
...modparam("event_flatstore", "suppress_event_name", 1)...Exported Functions
Section titled “Exported Functions”No exported functions to be used in the configuration file.
Exported MI Functions
Section titled “Exported MI Functions”evi_flat_rotate
Section titled “evi_flat_rotate”It makes the processes reopen the file specified as a parameter to the command in order to be compatible with a logrotate command. If the function is not called after the mv command is executed, the module will continue to write in the renamed file.
Name: evi_flat_rotate
Parameters: path_to_file
MI FIFO Command Format:
opensips-cli -x mi evi_flat_rotate _path_to_log_file_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. | Vlad Patrascu (@rvlad-patrascu) | 31 | 16 | 687 | 508 |
| 2. | Ionel Cerghit (@ionel-cerghit) | 23 | 13 | 774 | 139 |
| 3. | Liviu Chircu (@liviuchircu) | 12 | 9 | 36 | 67 |
| 4. | Razvan Crainea (@razvancrainea) | 10 | 8 | 48 | 17 |
| 5. | Stefan Darius (@dariusstefan) | 8 | 5 | 177 | 19 |
| 6. | Eseanu Marius Cristian (@eseanucristian) | 7 | 3 | 273 | 28 |
| 7. | Bogdan-Andrei Iancu (@bogdan-iancu) | 5 | 3 | 7 | 4 |
| 8. | Peter Lemenkov (@lemenkov) | 3 | 1 | 1 | 1 |
| 9. | Maksym Sobolyev (@sobomax) | 2 | 1 | 1 | 0 |
(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) | Aug 2015 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | Jan 2016 - Dec 2021 |
| 4. | Vlad Patrascu (@rvlad-patrascu) | Jun 2015 - Jul 2020 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jun 2018 - Apr 2019 |
| 6. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 7. | Maksym Sobolyev (@sobomax) | Feb 2017 - Feb 2017 |
| 8. | Ionel Cerghit (@ionel-cerghit) | Jun 2015 - Jul 2015 |
| 9. | Eseanu Marius Cristian (@eseanucristian) | Jun 2015 - Jul 2015 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Vlad Patrascu (@rvlad-patrascu), Ionel Cerghit (@ionel-cerghit).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0