Module: kamailio
Branch: 5.3
Commit: fca18567f458fd3860a63ab37a9e7e2fe89f0019
URL: https://github.com/kamailio/kamailio/commit/fca18567f458fd3860a63ab37a9e7e2…
Author: Jose Luis Verdeguer <pepeluxx(a)gmail.com>
Committer: Victor Seva <linuxmaniac(a)torreviejawireless.org>
Date: 2020-06-05T14:19:48+02:00
cnxcc: updated readme file [skip ci]
(cherry picked from commit cea7fa14b0aefc647d28eb1bf56faaec89d90d67)
---
Modified: src/modules/cnxcc/doc/cnxcc_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/fca18567f458fd3860a63ab37a9e7e2…
Patch: https://github.com/kamailio/kamailio/commit/fca18567f458fd3860a63ab37a9e7e2…
---
diff --git a/src/modules/cnxcc/doc/cnxcc_admin.xml b/src/modules/cnxcc/doc/cnxcc_admin.xml
index 4284437a8b..0c26cb0a58 100644
--- a/src/modules/cnxcc/doc/cnxcc_admin.xml
+++ b/src/modules/cnxcc/doc/cnxcc_admin.xml
@@ -128,21 +128,37 @@ modparam("cnxcc", "credit_check_period", 1)
<para>
Associates the call with a customer id and sets the max credit,
connect cost, cost per second, initial pulse and final pulse. The discount
- is calculated in pulses (30/6, 1/1, etc) and subtracted from the pool
+ is calculated in pulses (1/1, 60/1, etc) and subtracted from the pool
of credit.
</para>
<para>
The customer value can be provided as a string or a variable holding
- a string.
+ a string. This value identifies all calls from the same customer.
+ </para>
+ <para>
+ The maxcredit (float) value is the maximum credit available for the current call.
+ </para>
+ <para>
+ The connect (float) value is the connect cost for the current call.
+ </para>
+ <para>
+ The cps (float) value is the cost per second for the current call.
+ </para>
+ <para>
+ The ipuse (integer) value is the initial pulse and establishes the minimum
+ time to be charged. For example, value 1 establishes a charge per second
+ and value 60 sets a charge per minute. If it is taken as value 60, even
+ if the duration is 5 seconds, 1 minute will be charged.
</para>
<para>
- The maxcredit, connect and cps can be double (float) or integer values, they
- have to be provided as static string values of variables holding string
- values.
+ The fpulse (integer) value is the final pulse and establishes, from the initial
+ pulse, the time range to be charged. For example, the value 1 establishes a charge
+ per second, 5 sets a charge in blocks of 5 seconds, 60 sets a full minute charge.
</para>
<para>
- The ipulse and fpulse values are integer values, they can be also
- given via variables holding integers.
+ 1/1 will make a charge per seconds for the entire call. 60/1 will make a
+ charge per seconds with the first full minute. 60/60 always perform
+ a full minute charge.
</para>
<para>
<emphasis>Return code:</emphasis>
@@ -173,12 +189,15 @@ modparam("cnxcc", "credit_check_period", 1)
...
cnxcc_set_max_credit("john-doe", "100", "3.0", "0.5", 60, 1);
...
-$var(customer) = "john-doe-premium"; # customer id
-$var(credit) = "100"; # max credit
-$var(connect) = "3.0"; # connect const
-$var(cps) = "0.5"; # cost per second
-$var(initial_p) = 60; # initial pulse
-$var(final_p) = 1; # final pulse
+$var(customer) = "john-doe"; # customer id
+$var(credit) = "100"; # max credit for all calls with the same
+ # customer id
+$var(connect) = "3.0"; # connect cost or initial cost for the call
+$var(cps) = "0.5"; # cost per second
+$var(initial_p) = 60; # initial pulse (60 = the first minute will be
+ # charged even if the call is shorter)
+$var(final_p) = 1; # final pulse (after the first minute, it will
+ # be charge in ranges of 1 second)
cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(connect)",
"$var(cps)", "$var(initial_p)", "$var(final_p)");
...
Module: kamailio
Branch: 5.3
Commit: a41dcf3259d72dfecf4cd34638d885734dc7a5ea
URL: https://github.com/kamailio/kamailio/commit/a41dcf3259d72dfecf4cd34638d8857…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-06-05T12:31:49+02:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/siptrace/README
---
Diff: https://github.com/kamailio/kamailio/commit/a41dcf3259d72dfecf4cd34638d8857…
Patch: https://github.com/kamailio/kamailio/commit/a41dcf3259d72dfecf4cd34638d8857…
---
diff --git a/src/modules/siptrace/README b/src/modules/siptrace/README
index 5eab39eb23..df5b99f7cc 100644
--- a/src/modules/siptrace/README
+++ b/src/modules/siptrace/README
@@ -472,8 +472,10 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
Store or forward the current processed SIP message/transaction/dialog
in database. It is stored in the form prior applying changes made to
- it. Based on mode, one can trace the current message('m' - default),
- the current transaction('t') or the current dialog('d').
+ it. Based on mode, one can trace the current message('m'), the current
+ transaction('t') or the current dialog('d'). If no mode is given, it
+ falls back to the default mode - transaction tracking when trace_flag
+ is set, otherwise only the current message.
Meaning of the parameters is as follows:
* address - The address in form of SIP URI where to send a duplicate
@@ -564,13 +566,13 @@ kamcmd siptrace.status check
6. Database setup
- Before running Kamailio with siptrace, you have to setup the database
- tables where the module will store the data. For that, if the table
- were not created by the installation script or you choose to install
- everything by yourself you can use the siptrace-create.sql SQL script
- in the database directories in the kamailio/scripts folder as template.
- You can also find the complete database documentation on the project
- webpage,
+ Before running Kamailio with siptrace and activated trace_to_database
+ parameter, you have to setup the database tables where the module will
+ store the data. For that, if the table were not created by the
+ installation script or you choose to install everything by yourself you
+ can use the siptrace-create.sql SQL script in the database directories
+ in the kamailio/scripts folder as template. You can also find the
+ complete database documentation on the project webpage,
https://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
7. Known issues
Module: kamailio
Branch: master
Commit: a118641af8fb6bdd288e97c17b12076db6442ef9
URL: https://github.com/kamailio/kamailio/commit/a118641af8fb6bdd288e97c17b12076…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-06-05T12:31:22+02:00
modules: readme files regenerated - siptrace ... [skip ci]
---
Modified: src/modules/siptrace/README
---
Diff: https://github.com/kamailio/kamailio/commit/a118641af8fb6bdd288e97c17b12076…
Patch: https://github.com/kamailio/kamailio/commit/a118641af8fb6bdd288e97c17b12076…
---
diff --git a/src/modules/siptrace/README b/src/modules/siptrace/README
index 9006415a23..d9130a312e 100644
--- a/src/modules/siptrace/README
+++ b/src/modules/siptrace/README
@@ -551,8 +551,10 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
Store or forward the current processed SIP message/transaction/dialog
in database. It is stored in the form prior applying changes made to
- it. Based on mode, one can trace the current message('m' - default),
- the current transaction('t') or the current dialog('d').
+ it. Based on mode, one can trace the current message('m'), the current
+ transaction('t') or the current dialog('d'). If no mode is given, it
+ falls back to the default mode - transaction tracking when trace_flag
+ is set, otherwise only the current message.
Meaning of the parameters is as follows:
* address - The address in form of SIP URI where to send a duplicate
@@ -643,13 +645,13 @@ kamcmd siptrace.status check
6. Database setup
- Before running Kamailio with siptrace, you have to setup the database
- tables where the module will store the data. For that, if the table
- were not created by the installation script or you choose to install
- everything by yourself you can use the siptrace-create.sql SQL script
- in the database directories in the kamailio/scripts folder as template.
- You can also find the complete database documentation on the project
- webpage,
+ Before running Kamailio with siptrace and activated trace_to_database
+ parameter, you have to setup the database tables where the module will
+ store the data. For that, if the table were not created by the
+ installation script or you choose to install everything by yourself you
+ can use the siptrace-create.sql SQL script in the database directories
+ in the kamailio/scripts folder as template. You can also find the
+ complete database documentation on the project webpage,
https://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
7. Known issues
Module: kamailio
Branch: 5.3
Commit: 05a6f13c40249e0d658016652ae46b8512149857
URL: https://github.com/kamailio/kamailio/commit/05a6f13c40249e0d658016652ae46b8…
Author: Henning Westerholt <hw(a)skalatan.de>
Committer: Henning Westerholt <hw(a)skalatan.de>
Date: 2020-06-05T10:29:10Z
siptrace: manual backport of 75e6e370ceb7, improve documentation for siptrace and DB setup
---
Modified: src/modules/siptrace/doc/siptrace_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/05a6f13c40249e0d658016652ae46b8…
Patch: https://github.com/kamailio/kamailio/commit/05a6f13c40249e0d658016652ae46b8…
---
diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml
index 6b3a1f49f8..f5be1c663c 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -522,7 +522,9 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
<para>
Store or forward the current processed SIP message/transaction/dialog in database.
It is stored in the form prior applying changes made to it. Based on mode, one can trace
- the current message('m' - default), the current transaction('t') or the current dialog('d').
+ the current message('m'), the current transaction('t') or the current dialog('d').
+ If no mode is given, it falls back to the default mode - transaction tracking when
+ trace_flag is set, otherwise only the current message.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
@@ -674,12 +676,12 @@ hlog("$hdr(P-MyID)", "Another one with a custom correlation ID");
<section>
<title>Database setup</title>
<para>
- Before running &kamailio; with siptrace, you have to setup the database
- tables where the module will store the data. For that, if the
- table were not created by the installation script or you choose
- to install everything by yourself you can use the siptrace-create.sql
- <acronym>SQL</acronym> script in the database directories in the
- kamailio/scripts folder as template.
+ Before running &kamailio; with siptrace and activated trace_to_database
+ parameter, you have to setup the database tables where the module will
+ store the data. For that, if the table were not created by the
+ installation script or you choose to install everything by yourself
+ you can use the siptrace-create.sql <acronym>SQL</acronym> script in
+ the database directories in the kamailio/scripts folder as template.
You can also find the complete database documentation on the
project webpage, &kamailiodbdocslink;.
</para>
Module: kamailio
Branch: master
Commit: 75e6e370ceb701eabbdb2a1b7f12311ba0ae5024
URL: https://github.com/kamailio/kamailio/commit/75e6e370ceb701eabbdb2a1b7f12311…
Author: Henning Westerholt <hw(a)skalatan.de>
Committer: Henning Westerholt <hw(a)skalatan.de>
Date: 2020-06-05T10:25:46Z
siptrace: improve documentation about sip_trace and DB setup
---
Modified: src/modules/siptrace/doc/siptrace_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/75e6e370ceb701eabbdb2a1b7f12311…
Patch: https://github.com/kamailio/kamailio/commit/75e6e370ceb701eabbdb2a1b7f12311…
---
diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml
index 5bd274a2f0..7d5b0d34ef 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -643,7 +643,9 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
<para>
Store or forward the current processed SIP message/transaction/dialog in database.
It is stored in the form prior applying changes made to it. Based on mode, one can trace
- the current message('m' - default), the current transaction('t') or the current dialog('d').
+ the current message('m'), the current transaction('t') or the current dialog('d').
+ If no mode is given, it falls back to the default mode - transaction tracking when
+ trace_flag is set, otherwise only the current message.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
@@ -795,12 +797,12 @@ hlog("$hdr(P-MyID)", "Another one with a custom correlation ID");
<section>
<title>Database setup</title>
<para>
- Before running &kamailio; with siptrace, you have to setup the database
- tables where the module will store the data. For that, if the
- table were not created by the installation script or you choose
- to install everything by yourself you can use the siptrace-create.sql
- <acronym>SQL</acronym> script in the database directories in the
- kamailio/scripts folder as template.
+ Before running &kamailio; with siptrace and activated trace_to_database
+ parameter, you have to setup the database tables where the module will
+ store the data. For that, if the table were not created by the
+ installation script or you choose to install everything by yourself
+ you can use the siptrace-create.sql <acronym>SQL</acronym> script in
+ the database directories in the kamailio/scripts folder as template.
You can also find the complete database documentation on the
project webpage, &kamailiodbdocslink;.
</para>