/usr/share/doc/kamailio/modules/README.statistics is in kamailio 4.0.4-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | Statistics Module
Bogdan Iancu
Voice Sistem SRL
Edited by
Bogdan Iancu
Copyright © 2006 Voice Sistem SRL
__________________________________________________________________
Table of Contents
1. Admin Guide
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. variable (string)
4. Functions
4.1. update_stat(variable,value)
4.2. reset_stat(variable)
List of Examples
1.1. variable example
1.2. update_stat usage
1.3. reset_stat usage
Chapter 1. Admin Guide
Table of Contents
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. variable (string)
4. Functions
4.1. update_stat(variable,value)
4.2. reset_stat(variable)
1. 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.
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
2.1. Kamailio Modules
The following modules must be loaded before this module:
* No dependencies on other Kamailio modules.
2.2. External Libraries or Applications
The following libraries or applications must be installed before
running Kamailio with this module loaded:
* None.
3. Parameters
3.1. variable (string)
3.1. variable (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.
Example 1.1. variable example
modparam("statistics", "variable", "register_counter")
modparam("statistics", "variable", "active_calls/no_reset")
4. Functions
4.1. update_stat(variable,value)
4.2. reset_stat(variable)
4.1. update_stat(variable,value)
Updates the value of the statistic variable with the new value.
Meaning of the parameters is as follows:
* variable - variable to be updated (it can be a string or a
pseudovariable);
* value - value to update with; it may be also negative (it can be a
string or pseudovariable).
This function can be used from ANY_ROUTE.
Example 1.2. update_stat usage
...
update_stat("register_counter", "+1");
...
$var(a_calls) = "active_calls";
update_stat("$var(a_calls)", "-1");
...
4.2. reset_stat(variable)
Resets to zero the value of the statistic variable.
Meaning of the parameters is as follows:
* variable - variable to be reset-ed (it can be a string or a
pseudovariable).
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
FAILURE_ROUTE and ONREPLY_ROUTE.
Example 1.3. reset_stat usage
...
reset_stat("register_counter");
...
$var(reg_counter) = "register_counter";
update_stat("$var(reg_counter)");
...
|