[sr-dev] git:master: acc: updated readme with the new parameters

Module: sip-router Branch: master Commit: ea6514c2af00561643af6a2b671fbd4411048ca1 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=ea6514c… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Tue Sep 3 13:47:24 2013 +0200 acc: updated readme with the new parameters --- modules/acc/README | 51 +++++++++++++++++++++++++++++++------ modules/acc/doc/acc_admin.xml | 56 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 99 insertions(+), 8 deletions(-) diff --git a/modules/acc/README b/modules/acc/README index 694f43d..c266803 100644 --- a/modules/acc/README +++ b/modules/acc/README @@ -125,6 +125,8 @@ Sven Knoblich 6.42. cdr_start_id (string) 6.43. cdr_end_id (string) 6.44. cdr_duration_id (string) + 6.45. time_mode (int) + 6.46. time_attr (str) 7. Functions @@ -181,10 +183,12 @@ Sven Knoblich 1.42. cdr_start_id example 1.43. cdr_end_id example 1.44. cdr_duration_id example - 1.45. acc_log_request usage - 1.46. acc_db_request usage - 1.47. acc_rad_request usage - 1.48. acc_diam_request usage + 1.45. time_mode example + 1.46. time_attr example + 1.47. acc_log_request usage + 1.48. acc_db_request usage + 1.49. acc_rad_request usage + 1.50. acc_diam_request usage Chapter 1. Admin Guide @@ -273,6 +277,8 @@ Chapter 1. Admin Guide 6.42. cdr_start_id (string) 6.43. cdr_end_id (string) 6.44. cdr_duration_id (string) + 6.45. time_mode (int) + 6.46. time_attr (str) 7. Functions @@ -679,6 +685,8 @@ $dlg_var(callee) = $avp(callee); #callee='C' 6.42. cdr_start_id (string) 6.43. cdr_end_id (string) 6.44. cdr_duration_id (string) + 6.45. time_mode (int) + 6.46. time_attr (str) 6.1. early_media (integer) @@ -1145,6 +1153,33 @@ modparam("acc", "cdr_end_id", "end") Example 1.44. cdr_duration_id example modparam("acc", "cdr_duration_id", "start") +6.45. time_mode (int) + + Store additional value related to the time of event. + + Values can be: + * 0 - (default), save only unix timestamp for syslog and datetime for + database. + * 1 - save microseconds part (does not include the seconds in the + value) in time_attr. + * 3 - save seconds.miliseconds in time_attr. + + Example 1.45. time_mode example +modparam("acc", "time_mode", 1) + +6.46. time_attr (str) + + Name of the syslog attribute or database column where to store + additional value related to the time of event. + + For db accounting, the column has to be of different types, depending + on time_mode value. When time_mode is: + * 1 - time_attr column has to be int. + * 2 - time_attr column has to be double. + + Example 1.46. time_attr example +modparam("acc", "time_attr", "micorsecs") + 7. Functions 7.1. acc_log_request(comment) @@ -1164,7 +1199,7 @@ modparam("acc", "cdr_duration_id", "start") This function can be used from ANY_ROUTE. - Example 1.45. acc_log_request usage + Example 1.47. acc_log_request usage ... acc_log_request("Some comment"); ... @@ -1182,7 +1217,7 @@ acc_log_request("Some comment"); This function can be used from ANY_ROUTE. - Example 1.46. acc_db_request usage + Example 1.48. acc_db_request usage ... acc_db_request("Some comment", "SomeTable"); acc_db_request("Some comment", "acc_$time(year)_$time(mon)"); @@ -1198,7 +1233,7 @@ acc_db_request("Some comment", "acc_$time(year)_$time(mon)"); This function can be used from ANY_ROUTE. - Example 1.47. acc_rad_request usage + Example 1.49. acc_rad_request usage ... acc_rad_request("Some comment"); ... @@ -1213,7 +1248,7 @@ acc_rad_request("Some comment"); This function can be used from ANY_ROUTE. - Example 1.48. acc_diam_request usage + Example 1.50. acc_diam_request usage ... acc_diam_request("Some comment"); ... diff --git a/modules/acc/doc/acc_admin.xml b/modules/acc/doc/acc_admin.xml index 869ea8c..fb40555 100644 --- a/modules/acc/doc/acc_admin.xml +++ b/modules/acc/doc/acc_admin.xml @@ -1233,6 +1233,62 @@ modparam("acc", "cdr_duration_id", "start") </programlisting> </example> </section> + <section id="acc.p.time_mode"> + <title><varname>time_mode</varname> (int)</title> + <para> + Store additional value related to the time of event. + </para> + <para> + Values can be: + </para> + <itemizedlist> + <listitem> + <para><emphasis>0</emphasis> - (default), save only unix + timestamp for syslog and datetime for database.</para> + </listitem> + <listitem> + <para><emphasis>1</emphasis> - save microseconds part (does not + include the seconds in the value) in time_attr.</para> + </listitem> + <listitem> + <para><emphasis>3</emphasis> - save seconds.miliseconds + in time_attr.</para> + </listitem> + </itemizedlist> + + <example> + <title>time_mode example</title> + <programlisting format="linespecific"> +modparam("acc", "time_mode", 1) +</programlisting> + </example> + </section> + <section id="acc.p.time_attr"> + <title><varname>time_attr</varname> (str)</title> + <para> + Name of the syslog attribute or database column where to store additional + value related to the time of event. + </para> + <para> + For db accounting, the column has to be of different types, depending on + time_mode value. When time_mode is: + </para> + <itemizedlist> + <listitem> + <para><emphasis>1</emphasis> - time_attr column has to be int.</para> + </listitem> + <listitem> + <para><emphasis>2</emphasis> - time_attr column has to be double.</para> + </listitem> + </itemizedlist> + + <example> + <title>time_attr example</title> + <programlisting format="linespecific"> +modparam("acc", "time_attr", "micorsecs") +</programlisting> + </example> + </section> </section> <section>