Table of Contents
List of Tables
List of Examples
This module provides a minimal web user interface for the OpenSIPS's Management Interface.
Parameters for mi commands must be given in a json array format. For example, to get all statistics, the param is to be given as [["all"]]. To get only dialog and tm statistics, the param is to be given as [["dialog:","tm:"]].
Specifies the root path for the HTTP requests. The link to the mi web interface must be constructed using the following patern: http://[opensips_IP]:[opensips_mi_port]/[root]
The default value is "mi".
Specifies the HTTP request method to be used:
0 - use GET HTTP request
1 - use POST HTTP request
The default value is 0.
Trace destination as defined in the tracing module. Currently the only tracing module is proto_hep. This is where traced mi messages will go.
WARNING: A tracing module must be loaded in order for this parameter to work. (for example proto_hep).
Default value is none(not defined).
Example 1.3. Set trace_destination parameter
...
modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport=tcp;version=3")
modparam("mi_html", "trace_destination", "hep_dest")
...
Filter traced mi commands based on a blacklist or a whitelist. trace_destination must be defined for this parameter to have any purpose. Whitelists can be defined using 'w' or 'W', blacklists using 'b' or 'B'. The type is separate by the actual blacklist by ':'. The mi commands in the list must be separated by ','.
Defining a blacklists means all the commands that are not blacklisted will be traced. Defining a whitelist means all the commands that are not whitelisted will not be traced. WARNING: One can't define both a whitelist and a blacklist. Only one of them is allowed. Defining the parameter a second time will just overwrite the first one.
WARNING: A tracing module must be loaded in order for this parameter to work. (for example proto_hep).
Default value is none(not defined).
Example 1.4. Set trace_destination parameter
...
## blacklist ps and which mi commands
## all the other commands shall be traced
modparam("mi_html", "trace_bwlist", "b: ps, which")
...
## allow only sip_trace mi command
## all the other commands will not be traced
modparam("mi_html", "trace_bwlist", "w: sip_trace")
...
Table 2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| Name | DevScore | Commits | Lines ++ | Lines -- | |
|---|---|---|---|---|---|
| 1. | Ovidiu Sas (@ovidiusas) | 63 | 32 | 2249 | 697 |
| 2. | Vlad Patrascu (@rvlad-patrascu) | 14 | 3 | 167 | 493 |
| 3. | Razvan Crainea (@razvancrainea) | 10 | 8 | 27 | 18 |
| 4. | Liviu Chircu (@liviuchircu) | 9 | 7 | 29 | 41 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | 8 | 6 | 109 | 44 |
| 6. | Ionut Ionita (@ionutrazvanionita) | 8 | 5 | 217 | 10 |
| 7. | Maksym Sobolyev (@sobomax) | 5 | 3 | 3 | 4 |
| 8. | Zero King (@l2dy) | 3 | 1 | 2 | 2 |
| 9. | Peter Lemenkov (@lemenkov) | 3 | 1 | 1 | 1 |
| 10. | Vlad Paiu (@vladpaiu) | 2 | 1 | 0 | 1 |
(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
Table 2.2. Most recently active contributors(1) to this module
| Name | Commit Activity | |
|---|---|---|
| 1. | Maksym Sobolyev (@sobomax) | Oct 2020 - Feb 2023 |
| 2. | Razvan Crainea (@razvancrainea) | Mar 2015 - Jul 2020 |
| 3. | Ovidiu Sas (@ovidiusas) | Oct 2011 - Mar 2020 |
| 4. | Zero King (@l2dy) | Mar 2020 - Mar 2020 |
| 5. | Vlad Patrascu (@rvlad-patrascu) | May 2017 - Apr 2019 |
| 6. | Bogdan-Andrei Iancu (@bogdan-iancu) | Dec 2011 - Apr 2019 |
| 7. | Peter Lemenkov (@lemenkov) | Jun 2018 - Jun 2018 |
| 8. | Liviu Chircu (@liviuchircu) | Jul 2014 - Jun 2018 |
| 9. | Ionut Ionita (@ionutrazvanionita) | Jan 2017 - Feb 2017 |
| 10. | Vlad Paiu (@vladpaiu) | Jan 2016 - Jan 2016 |
(1) including any documentation-related commits, excluding merge commits
Last edited by: Ovidiu Sas (@ovidiusas), Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Ionut Ionita (@ionutrazvanionita), Bogdan-Andrei Iancu (@bogdan-iancu).
Documentation Copyrights:
Copyright © 2011-2013 VoIP Embedded, Inc.