Module: kamailio
Branch: master
Commit: 5aaea015c320423f08a92f60fb8b2bae59b40936
URL: https://github.com/kamailio/kamailio/commit/5aaea015c320423f08a92f60fb8b2ba…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2017-02-06T11:16:13+01:00
modules: readme files regenerated - cfgt ... [skip ci]
---
Modified: src/modules/cfgt/README
---
Diff: https://github.com/kamailio/kamailio/commit/5aaea015c320423f08a92f60fb8b2ba…
Patch: https://github.com/kamailio/kamailio/commit/5aaea015c320423f08a92f60fb8b2ba…
---
diff --git a/src/modules/cfgt/README b/src/modules/cfgt/README
index d65d560..8a098a6 100644
--- a/src/modules/cfgt/README
+++ b/src/modules/cfgt/README
@@ -30,6 +30,7 @@ Victor Seva
3.3. callid_prefix (string)
4. Usage
+ 5. Report format
List of Examples
@@ -54,6 +55,7 @@ Chapter 1. Admin Guide
3.3. callid_prefix (string)
4. Usage
+ 5. Report format
1. Overview
@@ -157,3 +159,36 @@ modparam("debugger", "log_level_name", "exec")
modparam("debugger", "cfgtest", 1)
#!endif
...
+
+5. Report format
+
+ cfgt generates a json file per request processed. The files are created
+ at <basedir>/<prefix>/<message_id>.json. The “message_id” is a sequence
+ starting with 1 per scenario defined by “prefix” module parameter.
+
+ The json report has three top members, “flow”, “sip_in” and “sip_out”
+ describing, the flow of the configuration routes, the SIP message
+ processed and the SIP messages sent during that process execution.
+
+ The flow of the configuration routes is defined by an array of routes
+ with the content of the variables controled by “mask” module parameter.
+
+ Each routename has a prefix as “start|”, “return|”, when the route
+ finish its execution and “exit|” or “drop|” if the route finish its
+ execution with exit or drop.
+{
+ "flow": [{
+ "start|DEFAULT_ROUTE": {
+ "$var(userprov_domain)": "spce.test",
+ "$fU": "testuser1002",
+ [...]},
+ "start|ROUTE_NET_INFO": {[...]},
+ "return|ROUTE_NET_INFO": {[...]},
+ [...]
+ "start|ROUTE_AUTH": {[...]},
+ "exit|ROUTE_AUTH": {[...]},
+ },
+ "sip_in": ["INVITE sip:4311001@spce.test SIP/2.0\r\nRecord-Route: [...]\r\n"],
+ "sip_out": ["SIP/2.0 100 Trying\r\nVia: SIP/2.0/UDP 127.0.0.1[...]\r\n", "SIP/2
+.0 407 Proxy Authentication Required[...]\r\n"]
+}
Module: kamailio
Branch: master
Commit: f5a9d74b321f6d05092750939286ea615252943d
URL: https://github.com/kamailio/kamailio/commit/f5a9d74b321f6d05092750939286ea6…
Author: Victor Seva <linuxmaniac(a)torreviejawireless.org>
Committer: Victor Seva <linuxmaniac(a)torreviejawireless.org>
Date: 2017-02-06T11:03:57+01:00
cfgt: add format documentation
Fix #970
---
Modified: src/modules/cfgt/doc/cfgt_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/f5a9d74b321f6d05092750939286ea6…
Patch: https://github.com/kamailio/kamailio/commit/f5a9d74b321f6d05092750939286ea6…
---
diff --git a/src/modules/cfgt/doc/cfgt_admin.xml b/src/modules/cfgt/doc/cfgt_admin.xml
index 39fc85b..38490d3 100644
--- a/src/modules/cfgt/doc/cfgt_admin.xml
+++ b/src/modules/cfgt/doc/cfgt_admin.xml
@@ -179,5 +179,45 @@ modparam("debugger", "cfgtest", 1)
#!endif
...
</programlisting>
- </section>
+ </section>
+ <section>
+ <title>Report format</title>
+ <para>
+ <emphasis>cfgt</emphasis> generates a json file per request processed.
+ The files are created at <basedir>/<prefix>/<message_id>.json.
+ The <quote>message_id</quote> is a sequence starting with 1 per scenario
+ defined by <quote>prefix</quote> module parameter.
+ </para>
+ <para>
+ The json report has three top members, <quote>flow</quote>,
+ <quote>sip_in</quote> and <quote>sip_out</quote> describing, the flow of
+ the configuration routes, the SIP message processed and the SIP messages
+ sent during that process execution.
+ </para>
+ <para>
+ The flow of the configuration routes is defined by an array of routes with
+ the content of the variables controled by <quote>mask</quote> module parameter.
+ </para>
+ <para>Each routename has a prefix as <quote>start|</quote>,
+ <quote>return|</quote>, when the route finish its execution and <quote>exit|</quote> or
+ <quote>drop|</quote> if the route finish its execution with exit or drop.
+ </para>
+<programlisting format="linespecific">
+{
+ "flow": [{
+ "start|DEFAULT_ROUTE": {
+ "$var(userprov_domain)": "spce.test",
+ "$fU": "testuser1002",
+ [...]},
+ "start|ROUTE_NET_INFO": {[...]},
+ "return|ROUTE_NET_INFO": {[...]},
+ [...]
+ "start|ROUTE_AUTH": {[...]},
+ "exit|ROUTE_AUTH": {[...]},
+ },
+ "sip_in": ["INVITE sip:4311001@spce.test SIP/2.0\r\nRecord-Route: [...]\r\n"],
+ "sip_out": ["SIP/2.0 100 Trying\r\nVia: SIP/2.0/UDP 127.0.0.1[...]\r\n", "SIP/2.0 407 Proxy Authentication Required[...]\r\n"]
+}
+</programlisting>
+ </section>
</chapter>
The test report needs to be included as well as better (more clear) information about where and when they are stored. One file per execution? One file per request? Tell us!
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/issues/970
Hello,
another edition of FOSDEM is approaching, about 2 weeks left:
- https://fosdem.org/2017/
Couple of devs and many Kamailio friends will be around.
Like past year, there is a Realtime Communications devroom, this edition
on Sunday. Very interesting presentation for our ecosystem: Olle giving
a presentation about IPv4/IPv6, Inaki introducing its SFU media server
project, Jose talking about JsSIP, Daniel debating about fundraising
FreeRTC, Lorenzo with Janus SIP-WebRTC gateway, the other Lorenzo with
Homer Sipcature, Saul with Jitsi, Dan with cgrates, Matt with Asterisk,
Giovanni with FreeSwitch... Schedule at:
- https://fosdem.org/2017/schedule/track/real_time_communications/
On Sunday morning, part of Lua devroom, I will present about using Lua
for building RTC services with Kamailio:
- https://fosdem.org/2017/schedule/track/lua/
- https://fosdem.org/2017/schedule/event/luartcserviceskamailio/
During the past editions we organized a dinner on Saturday evening.
Shall we attempt to do it again in advance this year? Or should we do it
on spot based on the weather and mood at the end of Saturday?
Cheers,
Daniel
--
Daniel-Constantin Mierla
www.twitter.com/miconda -- www.linkedin.com/in/miconda
Kamailio Advanced Training - Mar 6-8 (Europe) and Mar 20-22 (USA) - www.asipto.com
Kamailio World Conference - May 8-10, 2017 - www.kamailioworld.com