Merge branch 'collectd-5.7'
[collectd.git] / src / routeros.c
1 /**
2  * collectd - src/routeros.c
3  * Copyright (C) 2009,2010  Florian octo Forster
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  *   Florian octo Forster <octo at collectd.org>
25  **/
26
27 #include "collectd.h"
28
29 #include "common.h"
30 #include "plugin.h"
31
32 #include <routeros_api.h>
33
34 struct cr_data_s {
35   ros_connection_t *connection;
36
37   char *node;
38   char *service;
39   char *username;
40   char *password;
41
42   _Bool collect_interface;
43   _Bool collect_regtable;
44   _Bool collect_cpu_load;
45   _Bool collect_memory;
46   _Bool collect_df;
47   _Bool collect_disk;
48 };
49 typedef struct cr_data_s cr_data_t;
50
51 static void cr_submit_io(cr_data_t *rd, const char *type, /* {{{ */
52                          const char *type_instance, derive_t rx, derive_t tx) {
53   value_list_t vl = VALUE_LIST_INIT;
54   value_t values[] = {
55       {.derive = rx}, {.derive = tx},
56   };
57
58   vl.values = values;
59   vl.values_len = STATIC_ARRAY_SIZE(values);
60   sstrncpy(vl.host, rd->node, sizeof(vl.host));
61   sstrncpy(vl.plugin, "routeros", sizeof(vl.plugin));
62   sstrncpy(vl.type, type, sizeof(vl.type));
63   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
64
65   plugin_dispatch_values(&vl);
66 } /* }}} void cr_submit_io */
67
68 static void submit_interface(cr_data_t *rd, /* {{{ */
69                              const ros_interface_t *i) {
70   if (i == NULL)
71     return;
72
73   if (!i->running) {
74     submit_interface(rd, i->next);
75     return;
76   }
77
78   cr_submit_io(rd, "if_packets", i->name, (derive_t)i->rx_packets,
79                (derive_t)i->tx_packets);
80   cr_submit_io(rd, "if_octets", i->name, (derive_t)i->rx_bytes,
81                (derive_t)i->tx_bytes);
82   cr_submit_io(rd, "if_errors", i->name, (derive_t)i->rx_errors,
83                (derive_t)i->tx_errors);
84   cr_submit_io(rd, "if_dropped", i->name, (derive_t)i->rx_drops,
85                (derive_t)i->tx_drops);
86
87   submit_interface(rd, i->next);
88 } /* }}} void submit_interface */
89
90 static int handle_interface(__attribute__((unused))
91                             ros_connection_t *c, /* {{{ */
92                             const ros_interface_t *i, void *user_data) {
93   if ((i == NULL) || (user_data == NULL))
94     return EINVAL;
95
96   submit_interface(user_data, i);
97   return 0;
98 } /* }}} int handle_interface */
99
100 static void cr_submit_gauge(cr_data_t *rd, const char *type, /* {{{ */
101                             const char *type_instance, gauge_t value) {
102   value_t values[1];
103   value_list_t vl = VALUE_LIST_INIT;
104
105   values[0].gauge = value;
106
107   vl.values = values;
108   vl.values_len = STATIC_ARRAY_SIZE(values);
109   sstrncpy(vl.host, rd->node, sizeof(vl.host));
110   sstrncpy(vl.plugin, "routeros", sizeof(vl.plugin));
111   sstrncpy(vl.type, type, sizeof(vl.type));
112   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
113
114   plugin_dispatch_values(&vl);
115 } /* }}} void cr_submit_gauge */
116
117 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
118 static void cr_submit_counter(cr_data_t *rd, const char *type, /* {{{ */
119                               const char *type_instance, derive_t value) {
120   value_t values[1];
121   value_list_t vl = VALUE_LIST_INIT;
122
123   values[0].derive = value;
124
125   vl.values = values;
126   vl.values_len = STATIC_ARRAY_SIZE(values);
127   sstrncpy(vl.host, rd->node, sizeof(vl.host));
128   sstrncpy(vl.plugin, "routeros", sizeof(vl.plugin));
129   sstrncpy(vl.type, type, sizeof(vl.type));
130   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
131
132   plugin_dispatch_values(&vl);
133 } /* }}} void cr_submit_gauge */
134 #endif
135
136 static void submit_regtable(cr_data_t *rd, /* {{{ */
137                             const ros_registration_table_t *r) {
138   char type_instance[DATA_MAX_NAME_LEN];
139
140   if (r == NULL)
141     return;
142
143   /*** RX ***/
144   snprintf(type_instance, sizeof(type_instance), "%s-%s-rx", r->interface,
145            r->radio_name);
146   cr_submit_gauge(rd, "bitrate", type_instance,
147                   (gauge_t)(1000000.0 * r->rx_rate));
148   cr_submit_gauge(rd, "signal_power", type_instance,
149                   (gauge_t)r->rx_signal_strength);
150   cr_submit_gauge(rd, "signal_quality", type_instance, (gauge_t)r->rx_ccq);
151
152   /*** TX ***/
153   snprintf(type_instance, sizeof(type_instance), "%s-%s-tx", r->interface,
154            r->radio_name);
155   cr_submit_gauge(rd, "bitrate", type_instance,
156                   (gauge_t)(1000000.0 * r->tx_rate));
157   cr_submit_gauge(rd, "signal_power", type_instance,
158                   (gauge_t)r->tx_signal_strength);
159   cr_submit_gauge(rd, "signal_quality", type_instance, (gauge_t)r->tx_ccq);
160
161   /*** RX / TX ***/
162   snprintf(type_instance, sizeof(type_instance), "%s-%s", r->interface,
163            r->radio_name);
164   cr_submit_io(rd, "if_octets", type_instance, (derive_t)r->rx_bytes,
165                (derive_t)r->tx_bytes);
166   cr_submit_gauge(rd, "snr", type_instance, (gauge_t)r->signal_to_noise);
167
168   submit_regtable(rd, r->next);
169 } /* }}} void submit_regtable */
170
171 static int handle_regtable(__attribute__((unused))
172                            ros_connection_t *c, /* {{{ */
173                            const ros_registration_table_t *r, void *user_data) {
174   if ((r == NULL) || (user_data == NULL))
175     return EINVAL;
176
177   submit_regtable(user_data, r);
178   return 0;
179 } /* }}} int handle_regtable */
180
181 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
182 static int handle_system_resource(__attribute__((unused))
183                                   ros_connection_t *c, /* {{{ */
184                                   const ros_system_resource_t *r,
185                                   __attribute__((unused)) void *user_data) {
186   cr_data_t *rd;
187
188   if ((r == NULL) || (user_data == NULL))
189     return EINVAL;
190   rd = user_data;
191
192   if (rd->collect_cpu_load)
193     cr_submit_gauge(rd, "gauge", "cpu_load", (gauge_t)r->cpu_load);
194
195   if (rd->collect_memory) {
196     cr_submit_gauge(rd, "memory", "used",
197                     (gauge_t)(r->total_memory - r->free_memory));
198     cr_submit_gauge(rd, "memory", "free", (gauge_t)r->free_memory);
199   }
200
201   if (rd->collect_df) {
202     cr_submit_gauge(rd, "df_complex", "used",
203                     (gauge_t)(r->total_memory - r->free_memory));
204     cr_submit_gauge(rd, "df_complex", "free", (gauge_t)r->free_memory);
205   }
206
207   if (rd->collect_disk) {
208     cr_submit_counter(rd, "counter", "secors_written",
209                       (derive_t)r->write_sect_total);
210     cr_submit_gauge(rd, "gauge", "bad_blocks", (gauge_t)r->bad_blocks);
211   }
212
213   return 0;
214 } /* }}} int handle_system_resource */
215 #endif
216
217 static int cr_read(user_data_t *user_data) /* {{{ */
218 {
219   int status;
220   cr_data_t *rd;
221
222   if (user_data == NULL)
223     return EINVAL;
224
225   rd = user_data->data;
226   if (rd == NULL)
227     return EINVAL;
228
229   if (rd->connection == NULL) {
230     rd->connection =
231         ros_connect(rd->node, rd->service, rd->username, rd->password);
232     if (rd->connection == NULL) {
233       char errbuf[128];
234       ERROR("routeros plugin: ros_connect failed: %s",
235             sstrerror(errno, errbuf, sizeof(errbuf)));
236       return -1;
237     }
238   }
239   assert(rd->connection != NULL);
240
241   if (rd->collect_interface) {
242     status = ros_interface(rd->connection, handle_interface,
243                            /* user data = */ rd);
244     if (status != 0) {
245       char errbuf[128];
246       ERROR("routeros plugin: ros_interface failed: %s",
247             sstrerror(status, errbuf, sizeof(errbuf)));
248       ros_disconnect(rd->connection);
249       rd->connection = NULL;
250       return -1;
251     }
252   }
253
254   if (rd->collect_regtable) {
255     status = ros_registration_table(rd->connection, handle_regtable,
256                                     /* user data = */ rd);
257     if (status != 0) {
258       char errbuf[128];
259       ERROR("routeros plugin: ros_registration_table failed: %s",
260             sstrerror(status, errbuf, sizeof(errbuf)));
261       ros_disconnect(rd->connection);
262       rd->connection = NULL;
263       return -1;
264     }
265   }
266
267 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
268   if (rd->collect_cpu_load || rd->collect_memory || rd->collect_df ||
269       rd->collect_disk) {
270     status = ros_system_resource(rd->connection, handle_system_resource,
271                                  /* user data = */ rd);
272     if (status != 0) {
273       char errbuf[128];
274       ERROR("routeros plugin: ros_system_resource failed: %s",
275             sstrerror(status, errbuf, sizeof(errbuf)));
276       ros_disconnect(rd->connection);
277       rd->connection = NULL;
278       return -1;
279     }
280   }
281 #endif
282
283   return 0;
284 } /* }}} int cr_read */
285
286 static void cr_free_data(cr_data_t *ptr) /* {{{ */
287 {
288   if (ptr == NULL)
289     return;
290
291   ros_disconnect(ptr->connection);
292   ptr->connection = NULL;
293
294   sfree(ptr->node);
295   sfree(ptr->service);
296   sfree(ptr->username);
297   sfree(ptr->password);
298
299   sfree(ptr);
300 } /* }}} void cr_free_data */
301
302 static int cr_config_router(oconfig_item_t *ci) /* {{{ */
303 {
304   cr_data_t *router_data;
305   char read_name[128];
306   int status;
307
308   router_data = calloc(1, sizeof(*router_data));
309   if (router_data == NULL)
310     return -1;
311   router_data->connection = NULL;
312   router_data->node = NULL;
313   router_data->service = NULL;
314   router_data->username = NULL;
315   router_data->password = NULL;
316
317   status = 0;
318   for (int i = 0; i < ci->children_num; i++) {
319     oconfig_item_t *child = ci->children + i;
320
321     if (strcasecmp("Host", child->key) == 0)
322       status = cf_util_get_string(child, &router_data->node);
323     else if (strcasecmp("Port", child->key) == 0)
324       status = cf_util_get_service(child, &router_data->service);
325     else if (strcasecmp("User", child->key) == 0)
326       status = cf_util_get_string(child, &router_data->username);
327     else if (strcasecmp("Password", child->key) == 0)
328       status = cf_util_get_string(child, &router_data->password);
329     else if (strcasecmp("CollectInterface", child->key) == 0)
330       cf_util_get_boolean(child, &router_data->collect_interface);
331     else if (strcasecmp("CollectRegistrationTable", child->key) == 0)
332       cf_util_get_boolean(child, &router_data->collect_regtable);
333 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
334     else if (strcasecmp("CollectCPULoad", child->key) == 0)
335       cf_util_get_boolean(child, &router_data->collect_cpu_load);
336     else if (strcasecmp("CollectMemory", child->key) == 0)
337       cf_util_get_boolean(child, &router_data->collect_memory);
338     else if (strcasecmp("CollectDF", child->key) == 0)
339       cf_util_get_boolean(child, &router_data->collect_df);
340     else if (strcasecmp("CollectDisk", child->key) == 0)
341       cf_util_get_boolean(child, &router_data->collect_disk);
342 #endif
343     else {
344       WARNING("routeros plugin: Unknown config option `%s'.", child->key);
345     }
346
347     if (status != 0)
348       break;
349   }
350
351   if (status == 0) {
352     if (router_data->node == NULL) {
353       ERROR("routeros plugin: No `Host' option within a `Router' block. "
354             "Where should I connect to?");
355       status = -1;
356     }
357
358     if (router_data->password == NULL) {
359       ERROR("routeros plugin: No `Password' option within a `Router' block. "
360             "How should I authenticate?");
361       status = -1;
362     }
363
364     if (!router_data->collect_interface && !router_data->collect_regtable) {
365       ERROR("routeros plugin: No `Collect*' option within a `Router' block. "
366             "What statistics should I collect?");
367       status = -1;
368     }
369   }
370
371   if ((status == 0) && (router_data->username == NULL)) {
372     router_data->username = sstrdup("admin");
373     if (router_data->username == NULL) {
374       ERROR("routeros plugin: sstrdup failed.");
375       status = -1;
376     }
377   }
378
379   snprintf(read_name, sizeof(read_name), "routeros/%s", router_data->node);
380   if (status == 0)
381     status = plugin_register_complex_read(
382         /* group = */ NULL, read_name, cr_read, /* interval = */ 0,
383         &(user_data_t){
384             .data = router_data, .free_func = (void *)cr_free_data,
385         });
386
387   if (status != 0)
388     cr_free_data(router_data);
389
390   return status;
391 } /* }}} int cr_config_router */
392
393 static int cr_config(oconfig_item_t *ci) {
394   for (int i = 0; i < ci->children_num; i++) {
395     oconfig_item_t *child = ci->children + i;
396
397     if (strcasecmp("Router", child->key) == 0)
398       cr_config_router(child);
399     else {
400       WARNING("routeros plugin: Unknown config option `%s'.", child->key);
401     }
402   }
403
404   return 0;
405 } /* }}} int cr_config */
406
407 void module_register(void) {
408   plugin_register_complex_config("routeros", cr_config);
409 } /* void module_register */