Merge "app_queue: Added reason pause of member"
[asterisk/asterisk.git] / apps / app_statsd.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2015, Digium, Inc.
5  *
6  * Tyler Cambron <tcambron@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19  /*** MODULEINFO
20         <depend>res_statsd</depend>
21         <defaultenabled>no</defaultenabled>
22         <support_level>extended</support_level>
23  ***/
24
25 #include "asterisk.h"
26
27 ASTERISK_REGISTER_FILE()
28
29 #include <math.h>
30
31 #include "asterisk/module.h"
32 #include "asterisk/logger.h"
33 #include "asterisk/app.h"
34 #include "asterisk/pbx.h"
35 #include "asterisk/strings.h"
36
37 /*** DOCUMENTATION
38         <application name="StatsD" language="en_US">
39                 <synopsis>
40                         Allow statistics to be passed to the StatsD server from the dialplan.
41                 </synopsis>
42                 <syntax>
43                         <parameter name="metric_type" required="true">
44                                 <para>The metric type to be sent to StatsD.</para>
45                         </parameter>
46                         <parameter name="statistic_name" required="true">
47                                 <para>The name of the variable to be sent to StatsD.</para>
48                         </parameter>
49                         <parameter name="value" required="true">
50                                 <para>The value of the variable to be sent to StatsD.</para>
51                         </parameter>
52                 </syntax>
53                 <description>
54                         <para>This dialplan application sends statistics to the StatsD
55                         server specified inside of <literal>statsd.conf</literal>.</para>
56                 </description>
57         </application>
58  ***/
59
60 static const char app[] = "StatsD";
61
62 /*!
63  * \brief Check to ensure the value is within the allowed range.
64  *
65  * \param value The value of the statistic to be sent to StatsD.
66  * \param metric The metric type to be sent to StatsD.
67  *
68  * This function checks to see if the value given to the StatsD daialplan
69  * application is within the allowed range as specified by StatsD. A counter
70  * is the only metric type allowed to be initialized as a negative number.
71  *
72  * \retval zero on success.
73  * \retval 1 on error.
74  */
75 static int value_in_range(const char *value, const char *metric)
76 {
77         double numerical_value = strtod(value, NULL);
78
79         if (!strcmp(metric, "counter")) {
80                 if (numerical_value < pow(-2, 63) || numerical_value > pow(2, 63)) {
81                         ast_log(AST_LOG_WARNING, "Value %lf out of range!\n", numerical_value);
82                         return 1;
83                 }
84         } else {
85                 if (numerical_value < 0 || numerical_value > pow(2, 64)) {
86                         ast_log(AST_LOG_WARNING, "Value %lf out of range!\n", numerical_value);
87                         return 1;
88                 }
89         }
90
91         return 0;
92 }
93
94 /*!
95  * \brief Check to ensure the metric type is a valid metric type.
96  *
97  * \param metric The metric type to be sent to StatsD.
98  *
99  * This function checks to see if the metric type given to the StatsD dialplan
100  * is a valid metric type. Metric types are determined by StatsD.
101  *
102  * \retval zero on success.
103  * \retval 1 on error.
104  */
105 static int validate_metric(const char *metric)
106 {
107         const char *valid_metrics[] = {"gauge","set","timer","counter"};
108         int i;
109
110         if (ast_strlen_zero(metric)) {
111                 ast_log(AST_LOG_ERROR, "Missing metric type argument.\n");
112                 return 1;
113         }
114
115         for (i = 0; i < ARRAY_LEN(valid_metrics); i++) {
116                 if (!strcmp(valid_metrics[i], metric)) {
117                         return 0;
118                 }
119         }
120
121         ast_log(AST_LOG_ERROR, "Invalid metric type %s.\n", metric);
122
123         return 1;
124 }
125
126 /*!
127  * \brief Check to ensure the statistic name is valid.
128  *
129  * \param name The variable name to be sent to StatsD.
130  *
131  * This function checks to see if the statistic name given to the StatsD
132  * dialplan application is valid by ensuring that the name does not have any
133  * invalid characters.
134  *
135  * \retval zero on success.
136  * \retval 1 on error.
137  */
138 static int validate_name(const char *name)
139 {
140         if (ast_strlen_zero(name) || (strstr(name, "|") != NULL)) {
141                 ast_log(AST_LOG_ERROR, "Statistic name %s is missing or contains a pipe (|)"
142                         " character.\n", name);
143                 return 1;
144         }
145
146         return 0;
147 }
148
149 /*!
150  * \brief Check to ensure the value is valid.
151  *
152  * \param value The value of the statistic to be sent to StatsD.
153  * \param metric The metric type to be sent to StatsD.
154  *
155  * This function checks to see if the value given to the StatsD daialplan
156  * application is valid by testing if it is numeric. A plus or minus is only
157  * allowed at the beginning of the value if it is a counter or a gauge.
158  *
159  * \retval zero on success.
160  * \retval 1 on error.
161  */
162 static int validate_value(const char *value, const char *metric)
163 {
164         const char *actual_value;
165
166         if (ast_strlen_zero(value)) {
167                 ast_log(AST_LOG_ERROR, "Missing value argument.\n");
168                 return 1;
169         }
170
171         if (!strcmp(metric, "gauge") || !strcmp(metric, "counter")) {
172                 if ((value[0] == '+') || (value[0] == '-')) {
173                         actual_value = &value[1];
174                         if (ast_strlen_zero(actual_value)) {
175                                 ast_log(AST_LOG_ERROR, "Value argument %s only contains a sign"
176                                         " operator.\n", value);
177                                 return 1;
178                         }
179                 } else {
180                         actual_value = &value[0];
181                 }
182         } else {
183                 actual_value = &value[0];
184         }
185
186         if (!isdigit(*actual_value)) {
187                 ast_log(AST_LOG_ERROR, "Value of %s is not a valid number!\n", actual_value);
188                 return 1;
189         }
190
191         if (value_in_range(actual_value, metric)) {
192                 return 1;
193         }
194
195         return 0;
196 }
197
198 static int statsd_exec(struct ast_channel *chan, const char *data)
199 {
200         char *stats;
201
202         AST_DECLARE_APP_ARGS(args,
203                         AST_APP_ARG(metric_type);
204                         AST_APP_ARG(statistic_name);
205                         AST_APP_ARG(value);
206         );
207
208         if (!data) {
209                 ast_log(AST_LOG_ERROR, "No parameters were provided. Correct format is "
210                         "StatsD(metric_type,statistic_name,value). All parameters are required.\n");
211                 return 1;
212         }
213
214         stats = ast_strdupa(data);
215         AST_STANDARD_APP_ARGS(args, stats);
216
217         /* If any of the validations fail, emit a warning message. */
218         if (validate_metric(args.metric_type) || validate_name(args.statistic_name)
219                 || validate_value(args.value, args.metric_type)) {
220                 ast_log(AST_LOG_WARNING, "Invalid parameters provided. Correct format is "
221                         "StatsD(metric_type,statistic_name,value). All parameters are required.\n");
222
223                 return 1;
224         }
225
226         return 0;
227 }
228
229 static int unload_module(void)
230 {
231         return ast_unregister_application(app);
232 }
233
234 static int load_module(void)
235 {
236         return ast_register_application_xml(app, statsd_exec);
237 }
238
239 AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "StatsD Dialplan Application");