event_flatstore Module


Table of Contents

1. Admin Guide
1.1. Overview
1.2. Flatstore socket syntax
1.3. Dependencies
1.3.1. OpenSIPS Modules
1.4. External Libraries or Applications
1.5. Exported Parameters
1.5.1. max_open_sockets (integer)
1.5.2. delimiter (string)
1.5.3. file_permissions (string)
1.5.4. suppress_event_name (int)
1.6. Exported Functions
1.7. Exported MI Functions
1.7.1. evi_flat_rotate
2. Contributors
2.1. By Commit Statistics
2.2. By Commit Activity
3. Documentation
3.1. Contributors

List of Tables

2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
2.2. Most recently active contributors(1) to this module

List of Examples

1.1. Set max_open_sockets parameter
1.2. Set delimiter parameter
1.3. Set file_permissions parameter
1.4. Set suppress_event_name parameter

Chapter1.Admin Guide

1.1.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.

1.2.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.

1.3.Dependencies

1.3.1.OpenSIPS Modules

The following modules must be loaded before this module:

  • No dependencies on other OpenSIPS modules.

1.4.External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

  • none

1.5.Exported Parameters

1.5.1.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.

Example1.1.Set max_open_sockets parameter

...
modparam("event_flatstore", "max_open_sockets", 200)
...

1.5.2.delimiter (string)

Sets the separator between the parameters of the event in the logging file.

Default value is ,.

Example1.2.Set delimiter parameter

...
modparam("event_flatstore", "delimiter", ";")
...

1.5.3.file_permissions (string)

Sets the permissions for the newly created logs. It expects a string representation of a octal value.

Default value is 644.

Example1.3.Set file_permissions parameter

...
modparam("event_flatstore", "file_permissions", "664")
...

1.5.4.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).

Example1.4.Set suppress_event_name parameter

...
modparam("event_flatstore", "suppress_event_name", 1)
...

1.6.Exported Functions

No exported functions to be used in the configuration file.

1.7.Exported MI Functions

1.7.1. 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_
		

Chapter2.Contributors

2.1.By Commit Statistics

Table2.1.Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)

NameDevScoreCommitsLines ++Lines --
1. Vlad Patrascu (@rvlad-patrascu)2516482303
2. Ionel Cerghit (@ionel-cerghit)2313770135
3. Liviu Chircu (@liviuchircu)1293162
4. Razvan Crainea (@razvancrainea)97365
5. Eseanu Marius Cristian (@eseanucristian)732549
6. Bogdan-Andrei Iancu (@bogdan-iancu)5374
7. Peter Lemenkov (@lemenkov)3111
8. Maksym Sobolyev (@sobomax)2110

(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. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".

(3) ignoring whitespace edits, renamed files and auto-generated files

2.2.By Commit Activity

Table2.2.Most recently active contributors(1) to this module

NameCommit Activity
1. Liviu Chircu (@liviuchircu)Jan 2016 - Dec 2021
2. Vlad Patrascu (@rvlad-patrascu)Jun 2015 - Jul 2020
3. Razvan Crainea (@razvancrainea)Aug 2015 - Sep 2019
4. Bogdan-Andrei Iancu (@bogdan-iancu)Jun 2018 - Apr 2019
5. Peter Lemenkov (@lemenkov)Jun 2018 - Jun 2018
6. Maksym Sobolyev (@sobomax)Feb 2017 - Feb 2017
7. Ionel Cerghit (@ionel-cerghit)Jun 2015 - Jul 2015
8. Eseanu Marius Cristian (@eseanucristian)Jun 2015 - Jul 2015

(1) including any documentation-related commits, excluding merge commits

Chapter3.Documentation

3.1.Contributors

Last edited by: Razvan Crainea (@razvancrainea), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Vlad Patrascu (@rvlad-patrascu), Ionel Cerghit (@ionel-cerghit).

Documentation Copyrights:

Copyright 2015 www.opensips-solutions.com