mi_http Module
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. External Libraries or Applications
              1.2.2. OpenSIPS Modules

        1.3. Exported Parameters

              1.3.1. root(string)
              1.3.2. trace_destination (string)
              1.3.3. trace_bwlist (string)

        1.4. Exported Functions
        1.5. Known issues
        1.6. Examples

   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 root parameter
   1.2. Set trace_destination parameter
   1.3. Set trace_destination parameter
   1.4. JSON-RPC request
   1.5. JSON-RPC request with params

Chapter 1. Admin Guide

1.1. Overview

   This module provides a HTTP transport layer implementation for
   OpenSIPS's Management Interface.

1.2. Dependencies

1.2.1. External Libraries or Applications

   None

1.2.2. OpenSIPS Modules

   The following modules must be loaded before this module:
     * httpd module.

1.3. Exported Parameters

1.3.1. root(string)

   Specifies the root path for HTTP requests:
   http://[opensips_IP]:[opensips_httpd_port]/[root]

   The default value is "mi".

   Example 1.1. Set root parameter
...
modparam("mi_http", "root", "opensips_mi")
...

1.3.2. trace_destination (string)

   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.2. Set trace_destination parameter
...
modparam("proto_hep", "trace_destination", "[hep_dest]10.0.0.2;transport
=tcp;version=3")

modparam("mi_http", "trace_destination", "hep_dest")
...

1.3.3. trace_bwlist (string)

   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.3. Set trace_destination parameter
...
## blacklist ps and which mi commands
## all the other commands shall be traced
modparam("mi_http", "trace_bwlist", "b: ps, which")
...
## allow only sip_trace mi command
## all the other commands will not be traced
modparam("mi_http", "trace_bwlist", "w: sip_trace")
...

1.4. Exported Functions

   No function exported to be used from configuration file.

1.5. Known issues

   Commands with large responses (like ul_dump) will fail if the
   configured size of the httpd buffer is to small (or if there
   isn't enough pkg memory configured).

   Future realeases of the httpd module will address this issue.

1.6. Examples

   This is an example showing the JSON-RPC request and reply over
   HTTP for the “ps” MI command.

   Example 1.4. JSON-RPC request

POST /mi HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.net

{"jsonrpc":"2.0","method":"ps","id":10}

HTTP/1.1 200 OK
Content-Length: 317
Content-Type: application/json
Date: Fri, 01 Nov 2013 12:00:00 GMT

{"jsonrpc":"2.0","result":{"Processes":[{"ID":0,"PID":9467,"Type":"atten
dant"},{"ID":1,"PID":9468,"Type":"HTTPD127.0.0.1:8008"},{"ID":3,"PID":94
70,"Type":"time_keeper"},{"ID":4,"PID":9471,"Type":"timer"},{"ID":5,"PID
":9472,"Type":"SIPreceiverudp:127.0.0.1:5060"},{"ID":7,"PID":9483,"Type"
:"Timerhandler"},]},"id":10}


   This is an example showing the JSON-RPC request with params and
   reply over HTTP for the “get_statistics” MI command.

   Example 1.5. JSON-RPC request with params

POST /mi HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.net

{"jsonrpc":"2.0","method":"get_statistics","params":[["dialog:","tm:"]],
"id":10}

HTTP/1.1 200 OK
Content-Length: 317
Content-Type: application/json
Date: Fri, 01 Nov 2013 12:00:00 GMT

{"jsonrpc":"2.0","result":{"dialog:active_dialogs":0,"dialog:early_dialo
gs":0,"dialog:processed_dialogs":2,"dialog:expired_dialogs":0,"dialog:fa
iled_dialogs":2,"dialog:create_sent":0,"dialog:update_sent":0,"dialog:de
lete_sent":0,"dialog:create_recv":0,"dialog:update_recv":0,"dialog:delet
e_recv":0,"tm:received_replies":49252,"tm:relayed_replies":49220,"tm:loc
al_replies":370,"tm:UAS_transactions":49584,"tm:UAC_transactions":0,"tm:
2xx_transactions":12004,"tm:3xx_transactions":0,"tm:4xx_transactions":37
580,"tm:5xx_transactions":0,"tm:6xx_transactions":0,"tm:inuse_transactio
ns":60},"id":10}


Chapter 2. Contributors

2.1. By Commit Statistics

   Table 2.1. Top contributors by DevScore^(1), authored
   commits^(2) and lines added/removed^(3)
     Name DevScore Commits Lines ++ Lines --
   1. Stephane Alnet 20 5 1265 233
   2. Vlad Patrascu (@rvlad-patrascu) 19 3 170 814
   3. Razvan Crainea (@razvancrainea) 15 12 171 34
   4. Ionut Ionita (@ionutrazvanionita) 14 10 273 52
   5. Liviu Chircu (@liviuchircu) 10 8 32 39
   6. Bogdan-Andrei Iancu (@bogdan-iancu) 8 6 102 36
   7. Vlad Paiu (@vladpaiu) 5 3 8 3
   8. Maksym Sobolyev (@sobomax) 4 2 2 3
   9. Peter Lemenkov (@lemenkov) 3 1 1 1
   10. Ovidiu Sas (@ovidiusas) 2 1 24 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. 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

   Table 2.2. Most recently active contributors^(1) to this module
                      Name                   Commit Activity
   1.  Liviu Chircu (@liviuchircu)         Jul 2014 - Mar 2024
   2.  Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
   3.  Ovidiu Sas (@ovidiusas)             Mar 2020 - Mar 2020
   4.  Razvan Crainea (@razvancrainea)     Dec 2013 - Sep 2019
   5.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
   6.  Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2014 - Apr 2019
   7.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
   8.  Ionut Ionita (@ionutrazvanionita)   May 2016 - Feb 2017
   9.  Vlad Paiu (@vladpaiu)               Nov 2013 - Jan 2016
   10. Stephane Alnet                      Oct 2013 - Nov 2013

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

Chapter 3. Documentation

3.1. Contributors

   Last edited by: Ovidiu Sas (@ovidiusas), Vlad Patrascu
   (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Liviu Chircu
   (@liviuchircu), Razvan Crainea (@razvancrainea), Ionut Ionita
   (@ionutrazvanionita), Bogdan-Andrei Iancu (@bogdan-iancu),
   Stephane Alnet.

   Documentation Copyrights:

   Copyright © 2013 shimaore.net
