Merge "StatsD: Send stuff to the StatsD server and test"
[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 #include "asterisk/statsd.h"
37
38 /*** DOCUMENTATION
39         <application name="StatsD" language="en_US">
40                 <synopsis>
41                         Allow statistics to be passed to the StatsD server from the dialplan.
42                 </synopsis>
43                 <syntax>
44                         <parameter name="metric_type" required="true">
45                                 <para>The metric type to be sent to StatsD.</para>
46                         </parameter>
47                         <parameter name="statistic_name" required="true">
48                                 <para>The name of the variable to be sent to StatsD.</para>
49                         </parameter>
50                         <parameter name="value" required="true">
51                                 <para>The value of the variable to be sent to StatsD.</para>
52                         </parameter>
53                 </syntax>
54                 <description>
55                         <para>This dialplan application sends statistics to the StatsD
56                         server specified inside of <literal>statsd.conf</literal>.</para>
57                 </description>
58         </application>
59  ***/
60
61 static const char app[] = "StatsD";
62
63 /*!
64  * \brief Check to ensure the value is within the allowed range.
65  *
66  * \param value The value of the statistic to be sent to StatsD.
67  * \param metric The metric type to be sent to StatsD.
68  *
69  * This function checks to see if the value given to the StatsD daialplan
70  * application is within the allowed range as specified by StatsD. A counter
71  * is the only metric type allowed to be initialized as a negative number.
72  *
73  * \retval zero on success.
74  * \retval 1 on error.
75  */
76 static int value_in_range(const char *value, const char *metric)
77 {
78         double numerical_value = strtod(value, NULL);
79
80         if (!strcmp(metric, "c")) {
81                 if (numerical_value < pow(-2, 63) || numerical_value > pow(2, 63)) {
82                         ast_log(AST_LOG_WARNING, "Value %lf out of range!\n", numerical_value);
83                         return 1;
84                 }
85         } else {
86                 if (numerical_value < 0 || numerical_value > pow(2, 64)) {
87                         ast_log(AST_LOG_WARNING, "Value %lf out of range!\n", numerical_value);
88                         return 1;
89                 }
90         }
91
92         return 0;
93 }
94
95 /*!
96  * \brief Check to ensure the metric type is a valid metric type.
97  *
98  * \param metric The metric type to be sent to StatsD.
99  *
100  * This function checks to see if the metric type given to the StatsD dialplan
101  * is a valid metric type. Metric types are determined by StatsD.
102  *
103  * \retval zero on success.
104  * \retval 1 on error.
105  */
106 static int validate_metric(const char *metric)
107 {
108         const char *valid_metrics[] = {"g","s","ms","c"};
109         int i;
110
111         if (ast_strlen_zero(metric)) {
112                 ast_log(AST_LOG_ERROR, "Missing metric type argument.\n");
113                 return 1;
114         }
115
116         for (i = 0; i < ARRAY_LEN(valid_metrics); i++) {
117                 if (!strcmp(valid_metrics[i], metric)) {
118                         return 0;
119                 }
120         }
121
122         ast_log(AST_LOG_ERROR, "Invalid metric type %s.\n", metric);
123
124         return 1;
125 }
126
127 /*!
128  * \brief Check to ensure the statistic name is valid.
129  *
130  * \param name The variable name to be sent to StatsD.
131  *
132  * This function checks to see if the statistic name given to the StatsD
133  * dialplan application is valid by ensuring that the name does not have any
134  * invalid characters.
135  *
136  * \retval zero on success.
137  * \retval 1 on error.
138  */
139 static int validate_name(const char *name)
140 {
141         if (ast_strlen_zero(name) || (strstr(name, "|") != NULL)) {
142                 ast_log(AST_LOG_ERROR, "Statistic name %s is missing or contains a pipe (|)"
143                         " character.\n", name);
144                 return 1;
145         }
146
147         return 0;
148 }
149
150 /*!
151  * \brief Check to ensure the value is valid.
152  *
153  * \param value The value of the statistic to be sent to StatsD.
154  * \param metric The metric type to be sent to StatsD.
155  *
156  * This function checks to see if the value given to the StatsD daialplan
157  * application is valid by testing if it is numeric. A plus or minus is only
158  * allowed at the beginning of the value if it is a counter or a gauge.
159  *
160  * \retval zero on success.
161  * \retval 1 on error.
162  */
163 static int validate_value(const char *value, const char *metric)
164 {
165         const char *actual_value;
166
167         if (ast_strlen_zero(value)) {
168                 ast_log(AST_LOG_ERROR, "Missing value argument.\n");
169                 return 1;
170         }
171
172         if (!strcmp(metric, "g") || !strcmp(metric, "c")) {
173                 if ((value[0] == '+') || (value[0] == '-')) {
174                         actual_value = &value[1];
175                         if (ast_strlen_zero(actual_value)) {
176                                 ast_log(AST_LOG_ERROR, "Value argument %s only contains a sign"
177                                         " operator.\n", value);
178                                 return 1;
179                         }
180                 } else {
181                         actual_value = &value[0];
182                 }
183         } else {
184                 actual_value = &value[0];
185         }
186
187         if (!isdigit(*actual_value)) {
188                 ast_log(AST_LOG_ERROR, "Value of %s is not a valid number!\n", actual_value);
189                 return 1;
190         }
191
192         if (value_in_range(actual_value, metric)) {
193                 return 1;
194         }
195
196         return 0;
197 }
198
199 static int statsd_exec(struct ast_channel *chan, const char *data)
200 {
201         char *stats;
202         double numerical_value;
203
204         AST_DECLARE_APP_ARGS(args,
205                         AST_APP_ARG(metric_type);
206                         AST_APP_ARG(statistic_name);
207                         AST_APP_ARG(value);
208         );
209
210         if (!data) {
211                 ast_log(AST_LOG_ERROR, "No parameters were provided. Correct format is "
212                         "StatsD(metric_type,statistic_name,value). All parameters are required.\n");
213                 return 1;
214         }
215
216         stats = ast_strdupa(data);
217         AST_STANDARD_APP_ARGS(args, stats);
218
219         /* If any of the validations fail, emit a warning message. */
220         if (validate_metric(args.metric_type) || validate_name(args.statistic_name)
221                 || validate_value(args.value, args.metric_type)) {
222                 ast_log(AST_LOG_WARNING, "Invalid parameters provided. Correct format is "
223                         "StatsD(metric_type,statistic_name,value). All parameters are required.\n");
224
225                 return 1;
226         }
227
228         /*
229          * Conversion to a double is safe here since the value would have been validated as a
230          * number in validate_value().
231          */
232         numerical_value = strtod(args.value, NULL);
233         ast_statsd_log(args.statistic_name, args.metric_type, numerical_value);
234
235         return 0;
236 }
237
238 static int unload_module(void)
239 {
240         return ast_unregister_application(app);
241 }
242
243 static int load_module(void)
244 {
245         return ast_register_application_xml(app, statsd_exec);
246 }
247
248 AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "StatsD Dialplan Application");