2 * collectd - src/teamspeak2.c
3 * Copyright (C) 2008 Stefan Hacker
4 * Copyright (C) 2008 Florian Forster
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; only version 2 of the License is applicable.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Stefan Hacker <d0t at dbclan dot de>
21 * Florian Forster <octo at collectd.org>
29 #include <arpa/inet.h>
31 #include <netinet/in.h>
32 #include <sys/types.h>
37 /* Default host and port */
38 #define DEFAULT_HOST "127.0.0.1"
39 #define DEFAULT_PORT "51234"
44 /* Server linked list structure */
45 typedef struct vserver_list_s {
47 struct vserver_list_s *next;
49 static vserver_list_t *server_list = NULL;
52 static char *config_host = NULL;
53 static char *config_port = NULL;
55 static FILE *global_read_fh = NULL;
56 static FILE *global_write_fh = NULL;
59 static const char *config_keys[] = {"Host", "Port", "Server"};
60 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
65 static int tss2_add_vserver(int vserver_port) {
67 * Adds a new vserver to the linked list
69 vserver_list_t *entry;
71 /* Check port range */
72 if ((vserver_port <= 0) || (vserver_port > 65535)) {
73 ERROR("teamspeak2 plugin: VServer port is invalid: %i", vserver_port);
78 entry = calloc(1, sizeof(*entry));
80 ERROR("teamspeak2 plugin: calloc failed.");
85 entry->port = vserver_port;
88 if (server_list == NULL) {
89 /* Add the server as the first element */
94 /* Add the server to the end of the list */
96 while (prev->next != NULL)
101 INFO("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
104 } /* int tss2_add_vserver */
106 static void tss2_submit_gauge(const char *plugin_instance, const char *type,
107 const char *type_instance, gauge_t value) {
109 * Submits a gauge value to the collectd daemon
111 value_list_t vl = VALUE_LIST_INIT;
113 vl.values = &(value_t){.gauge = value};
115 sstrncpy(vl.plugin, "teamspeak2", sizeof(vl.plugin));
117 if (plugin_instance != NULL)
118 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
120 sstrncpy(vl.type, type, sizeof(vl.type));
122 if (type_instance != NULL)
123 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
125 plugin_dispatch_values(&vl);
126 } /* void tss2_submit_gauge */
128 static void tss2_submit_io(const char *plugin_instance, const char *type,
129 derive_t rx, derive_t tx) {
131 * Submits the io rx/tx tuple to the collectd daemon
133 value_list_t vl = VALUE_LIST_INIT;
135 {.derive = rx}, {.derive = tx},
139 vl.values_len = STATIC_ARRAY_SIZE(values);
140 sstrncpy(vl.plugin, "teamspeak2", sizeof(vl.plugin));
142 if (plugin_instance != NULL)
143 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
145 sstrncpy(vl.type, type, sizeof(vl.type));
147 plugin_dispatch_values(&vl);
148 } /* void tss2_submit_gauge */
150 static void tss2_close_socket(void) {
154 if (global_write_fh != NULL) {
155 fputs("quit\r\n", global_write_fh);
158 if (global_read_fh != NULL) {
159 fclose(global_read_fh);
160 global_read_fh = NULL;
163 if (global_write_fh != NULL) {
164 fclose(global_write_fh);
165 global_write_fh = NULL;
167 } /* void tss2_close_socket */
169 static int tss2_get_socket(FILE **ret_read_fh, FILE **ret_write_fh) {
171 * Returns connected file objects or establishes the connection
172 * if it's not already present
174 struct addrinfo *ai_head;
178 /* Check if we already got opened connections */
179 if ((global_read_fh != NULL) && (global_write_fh != NULL)) {
180 /* If so, use them */
181 if (ret_read_fh != NULL)
182 *ret_read_fh = global_read_fh;
183 if (ret_write_fh != NULL)
184 *ret_write_fh = global_write_fh;
188 /* Get all addrs for this hostname */
189 struct addrinfo ai_hints = {.ai_family = AF_UNSPEC,
190 .ai_flags = AI_ADDRCONFIG,
191 .ai_socktype = SOCK_STREAM};
193 status = getaddrinfo((config_host != NULL) ? config_host : DEFAULT_HOST,
194 (config_port != NULL) ? config_port : DEFAULT_PORT,
195 &ai_hints, &ai_head);
197 ERROR("teamspeak2 plugin: getaddrinfo failed: %s", gai_strerror(status));
201 /* Try all given hosts until we can connect to one */
202 for (struct addrinfo *ai_ptr = ai_head; ai_ptr != NULL;
203 ai_ptr = ai_ptr->ai_next) {
205 sd = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol);
208 WARNING("teamspeak2 plugin: socket failed: %s",
209 sstrerror(errno, errbuf, sizeof(errbuf)));
214 status = connect(sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
217 WARNING("teamspeak2 plugin: connect failed: %s",
218 sstrerror(errno, errbuf, sizeof(errbuf)));
225 * Success, we can break. Don't need more than one connection
230 freeaddrinfo(ai_head);
232 /* Check if we really got connected */
236 /* Create file objects from sockets */
237 global_read_fh = fdopen(sd, "r");
238 if (global_read_fh == NULL) {
240 ERROR("teamspeak2 plugin: fdopen failed: %s",
241 sstrerror(errno, errbuf, sizeof(errbuf)));
246 global_write_fh = fdopen(sd, "w");
247 if (global_write_fh == NULL) {
249 ERROR("teamspeak2 plugin: fdopen failed: %s",
250 sstrerror(errno, errbuf, sizeof(errbuf)));
255 { /* Check that the server correctly identifies itself. */
259 buffer_ptr = fgets(buffer, sizeof(buffer), global_read_fh);
260 if (buffer_ptr == NULL) {
261 WARNING("teamspeak2 plugin: Unexpected EOF received "
262 "from remote host %s:%s.",
263 config_host ? config_host : DEFAULT_HOST,
264 config_port ? config_port : DEFAULT_PORT);
266 buffer[sizeof(buffer) - 1] = 0;
268 if (memcmp("[TS]\r\n", buffer, 6) != 0) {
269 ERROR("teamspeak2 plugin: Unexpected response when connecting "
270 "to server. Expected ``[TS]'', got ``%s''.",
275 DEBUG("teamspeak2 plugin: Server send correct banner, connected!");
278 /* Copy the new filehandles to the given pointers */
279 if (ret_read_fh != NULL)
280 *ret_read_fh = global_read_fh;
281 if (ret_write_fh != NULL)
282 *ret_write_fh = global_write_fh;
284 } /* int tss2_get_socket */
286 static int tss2_send_request(FILE *fh, const char *request) {
288 * This function puts a request to the server socket
292 status = fputs(request, fh);
294 ERROR("teamspeak2 plugin: fputs failed.");
301 } /* int tss2_send_request */
303 static int tss2_receive_line(FILE *fh, char *buffer, int buffer_size) {
305 * Receive a single line from the given file object
310 * fgets is blocking but much easier then doing anything else
311 * TODO: Non-blocking Version would be safer
313 temp = fgets(buffer, buffer_size, fh);
316 ERROR("teamspeak2 plugin: fgets failed: %s",
317 sstrerror(errno, errbuf, sizeof(errbuf)));
322 buffer[buffer_size - 1] = 0;
324 } /* int tss2_receive_line */
326 static int tss2_select_vserver(FILE *read_fh, FILE *write_fh,
327 vserver_list_t *vserver) {
329 * Tell the server to select the given vserver
336 snprintf(command, sizeof(command), "sel %i\r\n", vserver->port);
338 status = tss2_send_request(write_fh, command);
340 ERROR("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
345 status = tss2_receive_line(read_fh, response, sizeof(response));
347 ERROR("teamspeak2 plugin: tss2_receive_line failed.");
350 response[sizeof(response) - 1] = 0;
353 if ((strncasecmp("OK", response, 2) == 0) &&
354 ((response[2] == 0) || (response[2] == '\n') || (response[2] == '\r')))
357 ERROR("teamspeak2 plugin: Command ``%s'' failed. "
358 "Response received from server was: ``%s''.",
361 } /* int tss2_select_vserver */
363 static int tss2_vserver_gapl(FILE *read_fh, FILE *write_fh,
364 gauge_t *ret_value) {
366 * Reads the vserver's average packet loss and submits it to collectd.
367 * Be sure to run the tss2_read_vserver function before calling this so
368 * the vserver is selected correctly.
370 gauge_t packet_loss = NAN;
373 status = tss2_send_request(write_fh, "gapl\r\n");
375 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
384 status = tss2_receive_line(read_fh, buffer, sizeof(buffer));
386 /* Set to NULL just to make sure no one uses these FHs anymore. */
389 ERROR("teamspeak2 plugin: tss2_receive_line failed.");
392 buffer[sizeof(buffer) - 1] = 0;
394 if (strncmp("average_packet_loss=", buffer,
395 strlen("average_packet_loss=")) == 0) {
396 /* Got average packet loss, now interpret it */
398 /* Replace , with . */
399 while (*value != 0) {
409 packet_loss = strtod(value, &endptr);
410 if (value == endptr) {
412 WARNING("teamspeak2 plugin: Could not read average package "
413 "loss from string: %s",
417 } else if (strncasecmp("OK", buffer, 2) == 0) {
419 } else if (strncasecmp("ERROR", buffer, 5) == 0) {
420 ERROR("teamspeak2 plugin: Server returned an error: %s", buffer);
423 WARNING("teamspeak2 plugin: Server returned unexpected string: %s",
428 *ret_value = packet_loss;
430 } /* int tss2_vserver_gapl */
432 static int tss2_read_vserver(vserver_list_t *vserver) {
434 * Poll information for the given vserver and submit it to collect.
435 * If vserver is NULL the global server information will be queried.
440 gauge_t channels = NAN;
441 gauge_t servers = NAN;
442 derive_t rx_octets = 0;
443 derive_t tx_octets = 0;
444 derive_t rx_packets = 0;
445 derive_t tx_packets = 0;
446 gauge_t packet_loss = NAN;
449 char plugin_instance[DATA_MAX_NAME_LEN] = {0};
454 /* Get the send/receive sockets */
455 status = tss2_get_socket(&read_fh, &write_fh);
457 ERROR("teamspeak2 plugin: tss2_get_socket failed.");
461 if (vserver == NULL) {
462 /* Request global information */
463 status = tss2_send_request(write_fh, "gi\r\n");
465 /* Request server information */
466 snprintf(plugin_instance, sizeof(plugin_instance), "vserver%i",
469 /* Select the server */
470 status = tss2_select_vserver(read_fh, write_fh, vserver);
474 status = tss2_send_request(write_fh, "si\r\n");
478 ERROR("teamspeak2 plugin: tss2_send_request failed.");
482 /* Loop until break */
489 /* Read one line of the server's answer */
490 status = tss2_receive_line(read_fh, buffer, sizeof(buffer));
492 /* Set to NULL just to make sure no one uses these FHs anymore. */
495 ERROR("teamspeak2 plugin: tss2_receive_line failed.");
499 if (strncasecmp("ERROR", buffer, 5) == 0) {
500 ERROR("teamspeak2 plugin: Server returned an error: %s", buffer);
502 } else if (strncasecmp("OK", buffer, 2) == 0) {
506 /* Split line into key and value */
507 key = strchr(buffer, '_');
509 DEBUG("teamspeak2 plugin: Cannot parse line: %s", buffer);
514 /* Evaluate assignment */
515 value = strchr(key, '=');
517 DEBUG("teamspeak2 plugin: Cannot parse line: %s", buffer);
523 /* Check for known key and save the given value */
524 /* global info: users_online,
525 * server info: currentusers. */
526 if ((strcmp("currentusers", key) == 0) ||
527 (strcmp("users_online", key) == 0)) {
528 users = strtod(value, &endptr);
532 /* global info: channels,
533 * server info: currentchannels. */
534 else if ((strcmp("currentchannels", key) == 0) ||
535 (strcmp("channels", key) == 0)) {
536 channels = strtod(value, &endptr);
541 else if (strcmp("servers", key) == 0) {
542 servers = strtod(value, &endptr);
545 } else if (strcmp("bytesreceived", key) == 0) {
546 rx_octets = strtoll(value, &endptr, 0);
549 } else if (strcmp("bytessend", key) == 0) {
550 tx_octets = strtoll(value, &endptr, 0);
553 } else if (strcmp("packetsreceived", key) == 0) {
554 rx_packets = strtoll(value, &endptr, 0);
557 } else if (strcmp("packetssend", key) == 0) {
558 tx_packets = strtoll(value, &endptr, 0);
561 } else if ((strncmp("allow_codec_", key, strlen("allow_codec_")) == 0) ||
562 (strncmp("bwinlast", key, strlen("bwinlast")) == 0) ||
563 (strncmp("bwoutlast", key, strlen("bwoutlast")) == 0) ||
564 (strncmp("webpost_", key, strlen("webpost_")) == 0) ||
565 (strcmp("adminemail", key) == 0) ||
566 (strcmp("clan_server", key) == 0) ||
567 (strcmp("countrynumber", key) == 0) ||
568 (strcmp("id", key) == 0) || (strcmp("ispname", key) == 0) ||
569 (strcmp("linkurl", key) == 0) ||
570 (strcmp("maxusers", key) == 0) || (strcmp("name", key) == 0) ||
571 (strcmp("password", key) == 0) ||
572 (strcmp("platform", key) == 0) ||
573 (strcmp("server_platform", key) == 0) ||
574 (strcmp("server_uptime", key) == 0) ||
575 (strcmp("server_version", key) == 0) ||
576 (strcmp("udpport", key) == 0) || (strcmp("uptime", key) == 0) ||
577 (strcmp("users_maximal", key) == 0) ||
578 (strcmp("welcomemessage", key) == 0))
581 INFO("teamspeak2 plugin: Unknown key-value-pair: "
582 "key = %s; value = %s;",
587 /* Collect vserver packet loss rates only if the loop above did not exit
589 if ((status == 0) && (vserver != NULL)) {
590 status = tss2_vserver_gapl(read_fh, write_fh, &packet_loss);
594 WARNING("teamspeak2 plugin: Reading package loss "
595 "for vserver %i failed.",
600 if ((valid & 0x01) == 0x01)
601 tss2_submit_gauge(plugin_instance, "users", NULL, users);
603 if ((valid & 0x06) == 0x06)
604 tss2_submit_io(plugin_instance, "io_octets", rx_octets, tx_octets);
606 if ((valid & 0x18) == 0x18)
607 tss2_submit_io(plugin_instance, "io_packets", rx_packets, tx_packets);
609 if ((valid & 0x20) == 0x20)
610 tss2_submit_gauge(plugin_instance, "percent", "packet_loss", packet_loss);
612 if ((valid & 0x40) == 0x40)
613 tss2_submit_gauge(plugin_instance, "gauge", "channels", channels);
615 if ((valid & 0x80) == 0x80)
616 tss2_submit_gauge(plugin_instance, "gauge", "servers", servers);
621 } /* int tss2_read_vserver */
623 static int tss2_config(const char *key, const char *value) {
625 * Interpret configuration values
627 if (strcasecmp("Host", key) == 0) {
630 temp = strdup(value);
632 ERROR("teamspeak2 plugin: strdup failed.");
637 } else if (strcasecmp("Port", key) == 0) {
640 temp = strdup(value);
642 ERROR("teamspeak2 plugin: strdup failed.");
647 } else if (strcasecmp("Server", key) == 0) {
648 /* Server variable found */
651 status = tss2_add_vserver(atoi(value));
655 /* Unknown variable found */
660 } /* int tss2_config */
662 static int tss2_read(void) {
664 * Poll function which collects global and vserver information
665 * and submits it to collectd
670 /* Handle global server variables */
671 status = tss2_read_vserver(NULL);
675 WARNING("teamspeak2 plugin: Reading global server variables failed.");
678 /* Handle vservers */
679 for (vserver_list_t *vserver = server_list; vserver != NULL;
680 vserver = vserver->next) {
681 status = tss2_read_vserver(vserver);
685 WARNING("teamspeak2 plugin: Reading statistics "
686 "for vserver %i failed.",
695 } /* int tss2_read */
697 static int tss2_shutdown(void) {
701 vserver_list_t *entry;
707 while (entry != NULL) {
708 vserver_list_t *next;
715 /* Get rid of the configuration */
720 } /* int tss2_shutdown */
722 void module_register(void) {
724 * Mandatory module_register function
726 plugin_register_config("teamspeak2", tss2_config, config_keys,
728 plugin_register_read("teamspeak2", tss2_read);
729 plugin_register_shutdown("teamspeak2", tss2_shutdown);
730 } /* void module_register */