$Revision: 743 $
$Date: 2006-03-14 18:36:39 +0200 (Tue, 14 Mar 2006) $
User's Guide
Overview
The Statistics module is a wrapper over the internal
statistics manager, allowing the script writer to dynamically define and
use of statistic variables.
By bringing the statistics support into the script, it takes advantage
of the script flexibility in defining logics, making possible
implementation of any kind of statistic scenario.
Dependencies
&ser; Modules
The following modules must be loaded before this module:
No dependencies on other &ser; modules.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>variable</varname> (string)
Name of a new statistic variable. The name may be followed by additional
flag which describe the variable behavior:
no_reset : variable cannot be reset.
variable example
modparam("statistics", "variable", "register_counter")
modparam("statistics", "variable", "active_calls/no_reset")
Exported Functions
<function moreinfo="none">update_stat(variable,value)</function>
Updates the value of the statistic variable with the new value.
Meaning of the parameters is as follows:
variable - variable to be updated
value - value to update with; it may be
also negative
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
FAILURE_ROUTE and ONREPLY_ROUTE.
<function>update_stat</function> usage
...
update_stat("register_counter", "+1");
...
update_stat("active_calls", "-1");
...
<function moreinfo="none">reset_stat(variable)</function>
Resets to zero the value of the statistic variable.
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
FAILURE_ROUTE and ONREPLY_ROUTE.
<function>reset_stat</function> usage
...
reset_stat("register_counter");
...