2 * collectd - src/routeros.c
3 * Copyright (C) 2009,2010 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
30 #include "utils/common/common.h"
32 #include <routeros_api.h>
35 ros_connection_t *connection;
42 bool collect_interface;
43 bool collect_regtable;
44 bool collect_cpu_load;
50 typedef struct cr_data_s cr_data_t;
52 static void cr_submit_io(cr_data_t *rd, const char *type, /* {{{ */
53 const char *type_instance, derive_t rx, derive_t tx) {
54 value_list_t vl = VALUE_LIST_INIT;
61 vl.values_len = STATIC_ARRAY_SIZE(values);
62 sstrncpy(vl.host, rd->node, sizeof(vl.host));
63 sstrncpy(vl.plugin, "routeros", sizeof(vl.plugin));
64 sstrncpy(vl.type, type, sizeof(vl.type));
65 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
67 plugin_dispatch_values(&vl);
68 } /* }}} void cr_submit_io */
70 static void submit_interface(cr_data_t *rd, /* {{{ */
71 const ros_interface_t *i) {
76 submit_interface(rd, i->next);
80 cr_submit_io(rd, "if_packets", i->name, (derive_t)i->rx_packets,
81 (derive_t)i->tx_packets);
82 cr_submit_io(rd, "if_octets", i->name, (derive_t)i->rx_bytes,
83 (derive_t)i->tx_bytes);
84 cr_submit_io(rd, "if_errors", i->name, (derive_t)i->rx_errors,
85 (derive_t)i->tx_errors);
86 cr_submit_io(rd, "if_dropped", i->name, (derive_t)i->rx_drops,
87 (derive_t)i->tx_drops);
89 submit_interface(rd, i->next);
90 } /* }}} void submit_interface */
92 static int handle_interface(__attribute__((unused))
93 ros_connection_t *c, /* {{{ */
94 const ros_interface_t *i, void *user_data) {
95 if ((i == NULL) || (user_data == NULL))
98 submit_interface(user_data, i);
100 } /* }}} int handle_interface */
102 static void cr_submit_gauge(cr_data_t *rd, const char *type, /* {{{ */
103 const char *type_instance, gauge_t value) {
105 value_list_t vl = VALUE_LIST_INIT;
107 values[0].gauge = value;
110 vl.values_len = STATIC_ARRAY_SIZE(values);
111 sstrncpy(vl.host, rd->node, sizeof(vl.host));
112 sstrncpy(vl.plugin, "routeros", sizeof(vl.plugin));
113 sstrncpy(vl.type, type, sizeof(vl.type));
114 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
116 plugin_dispatch_values(&vl);
117 } /* }}} void cr_submit_gauge */
119 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
120 static void cr_submit_counter(cr_data_t *rd, const char *type, /* {{{ */
121 const char *type_instance, derive_t value) {
123 value_list_t vl = VALUE_LIST_INIT;
125 values[0].derive = value;
128 vl.values_len = STATIC_ARRAY_SIZE(values);
129 sstrncpy(vl.host, rd->node, sizeof(vl.host));
130 sstrncpy(vl.plugin, "routeros", sizeof(vl.plugin));
131 sstrncpy(vl.type, type, sizeof(vl.type));
132 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
134 plugin_dispatch_values(&vl);
135 } /* }}} void cr_submit_gauge */
138 static void submit_regtable(cr_data_t *rd, /* {{{ */
139 const ros_registration_table_t *r) {
140 char type_instance[DATA_MAX_NAME_LEN];
145 const char *name = r->radio_name;
146 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 3)
148 name = r->mac_address;
154 ssnprintf(type_instance, sizeof(type_instance), "%s-%s-rx", r->interface,
156 cr_submit_gauge(rd, "bitrate", type_instance,
157 (gauge_t)(1000000.0 * r->rx_rate));
158 cr_submit_gauge(rd, "signal_power", type_instance,
159 (gauge_t)r->rx_signal_strength);
160 cr_submit_gauge(rd, "signal_quality", type_instance, (gauge_t)r->rx_ccq);
163 ssnprintf(type_instance, sizeof(type_instance), "%s-%s-tx", r->interface,
165 cr_submit_gauge(rd, "bitrate", type_instance,
166 (gauge_t)(1000000.0 * r->tx_rate));
167 cr_submit_gauge(rd, "signal_power", type_instance,
168 (gauge_t)r->tx_signal_strength);
169 cr_submit_gauge(rd, "signal_quality", type_instance, (gauge_t)r->tx_ccq);
172 ssnprintf(type_instance, sizeof(type_instance), "%s-%s", r->interface, name);
173 cr_submit_io(rd, "if_octets", type_instance, (derive_t)r->rx_bytes,
174 (derive_t)r->tx_bytes);
175 cr_submit_gauge(rd, "snr", type_instance, (gauge_t)r->signal_to_noise);
177 submit_regtable(rd, r->next);
178 } /* }}} void submit_regtable */
180 static int handle_regtable(__attribute__((unused))
181 ros_connection_t *c, /* {{{ */
182 const ros_registration_table_t *r, void *user_data) {
183 if ((r == NULL) || (user_data == NULL))
186 submit_regtable(user_data, r);
188 } /* }}} int handle_regtable */
190 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
191 static int handle_system_resource(__attribute__((unused))
192 ros_connection_t *c, /* {{{ */
193 const ros_system_resource_t *r,
194 __attribute__((unused)) void *user_data) {
197 if ((r == NULL) || (user_data == NULL))
201 if (rd->collect_cpu_load)
202 cr_submit_gauge(rd, "gauge", "cpu_load", (gauge_t)r->cpu_load);
204 if (rd->collect_memory) {
205 cr_submit_gauge(rd, "memory", "used",
206 (gauge_t)(r->total_memory - r->free_memory));
207 cr_submit_gauge(rd, "memory", "free", (gauge_t)r->free_memory);
210 if (rd->collect_df) {
211 cr_submit_gauge(rd, "df_complex", "used",
212 (gauge_t)(r->total_memory - r->free_memory));
213 cr_submit_gauge(rd, "df_complex", "free", (gauge_t)r->free_memory);
216 if (rd->collect_disk) {
217 cr_submit_counter(rd, "counter", "sectors_written",
218 (derive_t)r->write_sect_total);
219 cr_submit_gauge(rd, "gauge", "bad_blocks", (gauge_t)r->bad_blocks);
223 } /* }}} int handle_system_resource */
225 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 3)
226 static int handle_system_health(__attribute__((unused))
227 ros_connection_t *c, /* {{{ */
228 const ros_system_health_t *r,
229 __attribute__((unused)) void *user_data) {
231 if ((r == NULL) || (user_data == NULL))
234 cr_data_t *rd = user_data;
236 cr_submit_gauge(rd, "voltage", "system", (gauge_t)r->voltage);
237 cr_submit_gauge(rd, "temperature", "system", (gauge_t)r->temperature);
240 } /* }}} int handle_system_health */
244 static int cr_read(user_data_t *user_data) /* {{{ */
249 if (user_data == NULL)
252 rd = user_data->data;
256 if (rd->connection == NULL) {
258 ros_connect(rd->node, rd->service, rd->username, rd->password);
259 if (rd->connection == NULL) {
260 ERROR("routeros plugin: ros_connect failed: %s", STRERRNO);
264 assert(rd->connection != NULL);
266 if (rd->collect_interface) {
267 status = ros_interface(rd->connection, handle_interface,
268 /* user data = */ rd);
270 ERROR("routeros plugin: ros_interface failed: %s", STRERROR(status));
271 ros_disconnect(rd->connection);
272 rd->connection = NULL;
277 if (rd->collect_regtable) {
278 status = ros_registration_table(rd->connection, handle_regtable,
279 /* user data = */ rd);
281 ERROR("routeros plugin: ros_registration_table failed: %s",
283 ros_disconnect(rd->connection);
284 rd->connection = NULL;
289 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
290 if (rd->collect_cpu_load || rd->collect_memory || rd->collect_df ||
292 status = ros_system_resource(rd->connection, handle_system_resource,
293 /* user data = */ rd);
295 ERROR("routeros plugin: ros_system_resource failed: %s",
297 ros_disconnect(rd->connection);
298 rd->connection = NULL;
303 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 3)
304 if (rd->collect_health) {
305 status = ros_system_health(rd->connection, handle_system_health,
306 /* user data = */ rd);
308 ERROR("routeros plugin: ros_system_health failed: %s", STRERROR(status));
309 ros_disconnect(rd->connection);
310 rd->connection = NULL;
318 } /* }}} int cr_read */
320 static void cr_free_data(cr_data_t *ptr) /* {{{ */
325 ros_disconnect(ptr->connection);
326 ptr->connection = NULL;
330 sfree(ptr->username);
331 sfree(ptr->password);
334 } /* }}} void cr_free_data */
336 static int cr_config_router(oconfig_item_t *ci) /* {{{ */
338 cr_data_t *router_data;
342 router_data = calloc(1, sizeof(*router_data));
343 if (router_data == NULL)
345 router_data->connection = NULL;
346 router_data->node = NULL;
347 router_data->service = NULL;
348 router_data->username = NULL;
349 router_data->password = NULL;
352 for (int i = 0; i < ci->children_num; i++) {
353 oconfig_item_t *child = ci->children + i;
355 if (strcasecmp("Host", child->key) == 0)
356 status = cf_util_get_string(child, &router_data->node);
357 else if (strcasecmp("Port", child->key) == 0)
358 status = cf_util_get_service(child, &router_data->service);
359 else if (strcasecmp("User", child->key) == 0)
360 status = cf_util_get_string(child, &router_data->username);
361 else if (strcasecmp("Password", child->key) == 0)
362 status = cf_util_get_string(child, &router_data->password);
363 else if (strcasecmp("CollectInterface", child->key) == 0)
364 cf_util_get_boolean(child, &router_data->collect_interface);
365 else if (strcasecmp("CollectRegistrationTable", child->key) == 0)
366 cf_util_get_boolean(child, &router_data->collect_regtable);
367 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
368 else if (strcasecmp("CollectCPULoad", child->key) == 0)
369 cf_util_get_boolean(child, &router_data->collect_cpu_load);
370 else if (strcasecmp("CollectMemory", child->key) == 0)
371 cf_util_get_boolean(child, &router_data->collect_memory);
372 else if (strcasecmp("CollectDF", child->key) == 0)
373 cf_util_get_boolean(child, &router_data->collect_df);
374 else if (strcasecmp("CollectDisk", child->key) == 0)
375 cf_util_get_boolean(child, &router_data->collect_disk);
376 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 3)
377 else if (strcasecmp("CollectHealth", child->key) == 0)
378 cf_util_get_boolean(child, &router_data->collect_health);
382 WARNING("routeros plugin: Unknown config option `%s'.", child->key);
390 if (router_data->node == NULL) {
391 ERROR("routeros plugin: No `Host' option within a `Router' block. "
392 "Where should I connect to?");
396 if (router_data->password == NULL) {
397 ERROR("routeros plugin: No `Password' option within a `Router' block. "
398 "How should I authenticate?");
403 if (router_data->collect_interface)
405 if (router_data->collect_regtable)
407 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 0)
408 if (router_data->collect_cpu_load)
410 if (router_data->collect_memory)
412 if (router_data->collect_df)
414 if (router_data->collect_disk)
416 #if ROS_VERSION >= ROS_VERSION_ENCODE(1, 1, 3)
417 if (router_data->collect_health)
423 ERROR("routeros plugin: No `Collect*' option within a `Router' block. "
424 "What statistics should I collect?");
429 if ((status == 0) && (router_data->username == NULL)) {
430 router_data->username = sstrdup("admin");
431 if (router_data->username == NULL) {
432 ERROR("routeros plugin: sstrdup failed.");
438 cr_free_data(router_data);
442 ssnprintf(read_name, sizeof(read_name), "routeros/%s", router_data->node);
443 return plugin_register_complex_read(
444 /* group = */ NULL, read_name, cr_read, /* interval = */ 0,
447 .free_func = (void *)cr_free_data,
449 } /* }}} int cr_config_router */
451 static int cr_config(oconfig_item_t *ci) {
452 for (int i = 0; i < ci->children_num; i++) {
453 oconfig_item_t *child = ci->children + i;
455 if (strcasecmp("Router", child->key) == 0)
456 cr_config_router(child);
458 WARNING("routeros plugin: Unknown config option `%s'.", child->key);
463 } /* }}} int cr_config */
465 void module_register(void) {
466 plugin_register_complex_config("routeros", cr_config);
467 } /* void module_register */