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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
Statistics Module
Bogdan Iancu
voice-system.ro
Edited by
Bogdan Iancu
Copyright 2006 voice-system.ro
_________________________________________________________
Table of Contents
1. User's Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSER Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. variable (string)
1.4. Exported Functions
1.4.1. update_stat(variable,value)
1.4.2. reset_stat(variable)
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. variable example
1-2. update_stat usage
1-3. reset_stat usage
_________________________________________________________
Chapter 1. User's Guide
1.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.
_________________________________________________________
1.2. Dependencies
1.2.1. OpenSER Modules
The following modules must be loaded before this module:
* No dependencies on other OpenSER modules.
_________________________________________________________
1.2.2. External Libraries or Applications
The following libraries or applications must be installed
before running OpenSER with this module loaded:
* None.
_________________________________________________________
1.3. Exported Parameters
1.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")
_________________________________________________________
1.4. Exported Functions
1.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
* 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.
Example 1-2. update_stat usage
...
update_stat("register_counter", "+1");
...
update_stat("active_calls", "-1");
...
_________________________________________________________
1.4.2. reset_stat(variable)
Resets to zero the value of the statistic variable.
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");
...
_________________________________________________________
Chapter 2. Developer's Guide
The module does not provide any API to use in other OpenSER
modules.
_________________________________________________________
Chapter 3. Frequently Asked Questions
3.1. Where can I find more about OpenSER?
3.2. Where can I post a question about this module?
3.3. How can I report a bug?
3.1. Where can I find more about OpenSER?
Take a look at http://openser.org/.
3.2. Where can I post a question about this module?
First at all check if your question was already answered on
one of our mailing lists:
* User Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/users
* Developer Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/devel
E-mails regarding any stable OpenSER release should be sent to
<users@openser.org> and e-mails regarding development versions
should be sent to <devel@openser.org>.
If you want to keep the mail private, send it to
<team@openser.org>.
3.3. How can I report a bug?
Please follow the guidelines provided at:
http://sourceforge.net/tracker/?group_id=139143.
|
