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 verplant.org>
28 #include <arpa/inet.h>
29 #include <netinet/in.h>
30 #include <sys/types.h>
31 #include <sys/socket.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
48 struct vserver_list_s *next;
50 static vserver_list_t *server_list = NULL;
53 static char *config_host = NULL;
54 static char *config_port = NULL;
56 static FILE *global_read_fh = NULL;
57 static FILE *global_write_fh = NULL;
60 static const char *config_keys[] =
66 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
71 static int tss2_add_vserver (int vserver_port)
74 * Adds a new vserver to the linked list
76 vserver_list_t *entry;
78 /* Check port range */
79 if ((vserver_port <= 0) || (vserver_port > 65535))
81 ERROR ("teamspeak2 plugin: VServer port is invalid: %i",
87 entry = (vserver_list_t *) malloc (sizeof (vserver_list_t));
90 ERROR ("teamspeak2 plugin: malloc failed.");
93 memset (entry, 0, sizeof (vserver_list_t));
96 entry->port = vserver_port;
99 if(server_list == NULL) {
100 /* Add the server as the first element */
104 vserver_list_t *prev;
106 /* Add the server to the end of the list */
108 while (prev->next != NULL)
113 INFO ("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
116 } /* int tss2_add_vserver */
118 static void tss2_submit_gauge (const char *plugin_instance,
119 const char *type, const char *type_instance,
123 * Submits a gauge value to the collectd daemon
126 value_list_t vl = VALUE_LIST_INIT;
128 values[0].gauge = value;
132 vl.time = time (NULL);
133 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
134 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
136 if (plugin_instance != NULL)
137 sstrncpy (vl.plugin_instance, plugin_instance,
138 sizeof (vl.plugin_instance));
140 sstrncpy (vl.type, type, sizeof (vl.type));
142 if (type_instance != NULL)
143 sstrncpy (vl.type_instance, type_instance,
144 sizeof (vl.type_instance));
146 plugin_dispatch_values (&vl);
147 } /* void tss2_submit_gauge */
149 static void tss2_submit_io (const char *plugin_instance, const char *type,
150 counter_t rx, counter_t tx)
153 * Submits the io rx/tx tuple to the collectd daemon
156 value_list_t vl = VALUE_LIST_INIT;
158 values[0].counter = rx;
159 values[1].counter = tx;
163 vl.time = time (NULL);
164 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
165 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
167 if (plugin_instance != NULL)
168 sstrncpy (vl.plugin_instance, plugin_instance,
169 sizeof (vl.plugin_instance));
171 sstrncpy (vl.type, type, sizeof (vl.type));
173 plugin_dispatch_values (&vl);
174 } /* void tss2_submit_gauge */
176 static void tss2_close_socket (void)
181 if (global_write_fh != NULL)
183 fputs ("quit\r\n", global_write_fh);
186 if (global_read_fh != NULL)
188 fclose (global_read_fh);
189 global_read_fh = NULL;
192 if (global_write_fh != NULL)
194 fclose (global_write_fh);
195 global_write_fh = NULL;
197 } /* void tss2_close_socket */
199 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
202 * Returns connected file objects or establishes the connection
203 * if it's not already present
205 struct addrinfo ai_hints;
206 struct addrinfo *ai_head;
207 struct addrinfo *ai_ptr;
211 /* Check if we already got opened connections */
212 if ((global_read_fh != NULL) && (global_write_fh != NULL))
214 /* If so, use them */
215 if (ret_read_fh != NULL)
216 *ret_read_fh = global_read_fh;
217 if (ret_write_fh != NULL)
218 *ret_write_fh = global_write_fh;
222 /* Get all addrs for this hostname */
223 memset (&ai_hints, 0, sizeof (ai_hints));
225 ai_hints.ai_flags |= AI_ADDRCONFIG;
227 ai_hints.ai_family = AF_UNSPEC;
228 ai_hints.ai_socktype = SOCK_STREAM;
230 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
231 (config_port != NULL) ? config_port : DEFAULT_PORT,
236 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
237 gai_strerror (status));
241 /* Try all given hosts until we can connect to one */
242 for (ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
245 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
246 ai_ptr->ai_protocol);
250 WARNING ("teamspeak2 plugin: socket failed: %s",
251 sstrerror (errno, errbuf, sizeof (errbuf)));
256 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
260 WARNING ("teamspeak2 plugin: connect failed: %s",
261 sstrerror (errno, errbuf, sizeof (errbuf)));
267 * Success, we can break. Don't need more than one connection
272 freeaddrinfo (ai_head);
274 /* Check if we really got connected */
278 /* Create file objects from sockets */
279 global_read_fh = fdopen (sd, "r");
280 if (global_read_fh == NULL)
283 ERROR ("teamspeak2 plugin: fdopen failed: %s",
284 sstrerror (errno, errbuf, sizeof (errbuf)));
289 global_write_fh = fdopen (sd, "w");
290 if (global_write_fh == NULL)
293 ERROR ("teamspeak2 plugin: fdopen failed: %s",
294 sstrerror (errno, errbuf, sizeof (errbuf)));
295 tss2_close_socket ();
299 { /* Check that the server correctly identifies itself. */
303 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
304 buffer[sizeof (buffer) - 1] = 0;
306 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
308 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
309 "to server. Expected ``[TS]'', got ``%s''.",
311 tss2_close_socket ();
314 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
317 /* Copy the new filehandles to the given pointers */
318 if (ret_read_fh != NULL)
319 *ret_read_fh = global_read_fh;
320 if (ret_write_fh != NULL)
321 *ret_write_fh = global_write_fh;
323 } /* int tss2_get_socket */
325 static int tss2_send_request (FILE *fh, const char *request)
328 * This function puts a request to the server socket
332 status = fputs (request, fh);
335 ERROR ("teamspeak2 plugin: fputs failed.");
336 tss2_close_socket ();
342 } /* int tss2_send_request */
344 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
347 * Receive a single line from the given file object
352 * fgets is blocking but much easier then doing anything else
353 * TODO: Non-blocking Version would be safer
355 temp = fgets (buffer, buffer_size, fh);
359 ERROR ("teamspeak2 plugin: fgets failed: %s",
360 sstrerror (errno, errbuf, sizeof(errbuf)));
361 tss2_close_socket ();
365 buffer[buffer_size - 1] = 0;
367 } /* int tss2_receive_line */
369 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
372 * Tell the server to select the given vserver
379 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
381 status = tss2_send_request (write_fh, command);
384 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
389 status = tss2_receive_line (read_fh, response, sizeof (response));
392 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
395 response[sizeof (response) - 1] = 0;
398 if ((strncasecmp ("OK", response, 2) == 0)
399 && ((response[2] == 0)
400 || (response[2] == '\n')
401 || (response[2] == '\r')))
404 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
405 "Response received from server was: ``%s''.",
408 } /* int tss2_select_vserver */
410 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
411 vserver_list_t *vserver, gauge_t *ret_value)
414 * Reads the vserver's average packet loss and submits it to collectd.
415 * Be sure to run the tss2_read_vserver function before calling this so
416 * the vserver is selected correctly.
418 gauge_t packet_loss = NAN;
421 status = tss2_send_request (write_fh, "gapl\r\n");
424 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
434 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
437 /* Set to NULL just to make sure noone uses these FHs anymore. */
440 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
443 buffer[sizeof (buffer) - 1] = 0;
445 if (strncmp ("average_packet_loss=", buffer,
446 strlen ("average_packet_loss=")) == 0)
448 /* Got average packet loss, now interpret it */
450 /* Replace , with . */
463 packet_loss = strtod (value, &endptr);
467 WARNING ("teamspeak2 plugin: Could not read average package "
468 "loss from string: %s", buffer);
472 else if (strncasecmp ("OK", buffer, 2) == 0)
476 else if (strncasecmp ("ERROR", buffer, 5) == 0)
478 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
483 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
488 *ret_value = packet_loss;
490 } /* int tss2_vserver_gapl */
492 static int tss2_read_vserver (vserver_list_t *vserver)
495 * Poll information for the given vserver and submit it to collect.
496 * If vserver is NULL the global server information will be queried.
501 gauge_t channels = NAN;
502 gauge_t servers = NAN;
503 counter_t rx_octets = 0;
504 counter_t tx_octets = 0;
505 counter_t rx_packets = 0;
506 counter_t tx_packets = 0;
507 gauge_t packet_loss = NAN;
510 char plugin_instance[DATA_MAX_NAME_LEN];
515 /* Get the send/receive sockets */
516 status = tss2_get_socket (&read_fh, &write_fh);
519 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
525 /* Request global information */
526 memset (plugin_instance, 0, sizeof (plugin_instance));
528 status = tss2_send_request (write_fh, "gi\r\n");
532 /* Request server information */
533 ssnprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
536 /* Select the server */
537 status = tss2_select_vserver (read_fh, write_fh, vserver);
541 status = tss2_send_request (write_fh, "si\r\n");
546 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
550 /* Loop until break */
558 /* Read one line of the server's answer */
559 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
562 /* Set to NULL just to make sure noone uses these FHs anymore. */
565 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
569 if (strncasecmp ("ERROR", buffer, 5) == 0)
571 ERROR ("teamspeak2 plugin: Server returned an error: %s",
575 else if (strncasecmp ("OK", buffer, 2) == 0)
580 /* Split line into key and value */
581 key = strchr (buffer, '_');
584 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
589 /* Evaluate assignment */
590 value = strchr (key, '=');
593 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
599 /* Check for known key and save the given value */
600 /* global info: users_online,
601 * server info: currentusers. */
602 if ((strcmp ("currentusers", key) == 0)
603 || (strcmp ("users_online", key) == 0))
605 users = strtod (value, &endptr);
609 /* global info: channels,
610 * server info: currentchannels. */
611 else if ((strcmp ("currentchannels", key) == 0)
612 || (strcmp ("channels", key) == 0))
614 channels = strtod (value, &endptr);
619 else if (strcmp ("servers", key) == 0)
621 servers = strtod (value, &endptr);
625 else if (strcmp ("bytesreceived", key) == 0)
627 rx_octets = strtoll (value, &endptr, 0);
631 else if (strcmp ("bytessend", key) == 0)
633 tx_octets = strtoll (value, &endptr, 0);
637 else if (strcmp ("packetsreceived", key) == 0)
639 rx_packets = strtoll (value, &endptr, 0);
643 else if (strcmp ("packetssend", key) == 0)
645 tx_packets = strtoll (value, &endptr, 0);
649 else if ((strncmp ("allow_codec_", key, strlen ("allow_codec_")) == 0)
650 || (strncmp ("bwinlast", key, strlen ("bwinlast")) == 0)
651 || (strncmp ("bwoutlast", key, strlen ("bwoutlast")) == 0)
652 || (strncmp ("webpost_", key, strlen ("webpost_")) == 0)
653 || (strcmp ("adminemail", key) == 0)
654 || (strcmp ("clan_server", key) == 0)
655 || (strcmp ("countrynumber", key) == 0)
656 || (strcmp ("id", key) == 0)
657 || (strcmp ("ispname", key) == 0)
658 || (strcmp ("linkurl", key) == 0)
659 || (strcmp ("maxusers", key) == 0)
660 || (strcmp ("name", key) == 0)
661 || (strcmp ("password", key) == 0)
662 || (strcmp ("platform", key) == 0)
663 || (strcmp ("server_platform", key) == 0)
664 || (strcmp ("server_uptime", key) == 0)
665 || (strcmp ("server_version", key) == 0)
666 || (strcmp ("udpport", key) == 0)
667 || (strcmp ("uptime", key) == 0)
668 || (strcmp ("users_maximal", key) == 0)
669 || (strcmp ("welcomemessage", key) == 0))
673 INFO ("teamspeak2 plugin: Unknown key-value-pair: "
674 "key = %s; value = %s;", key, value);
678 /* Collect vserver packet loss rates only if the loop above did not exit
680 if ((status == 0) && (vserver != NULL))
682 status = tss2_vserver_gapl (read_fh, write_fh, vserver, &packet_loss);
689 WARNING ("teamspeak2 plugin: Reading package loss "
690 "for vserver %i failed.", vserver->port);
694 if ((valid & 0x01) == 0x01)
695 tss2_submit_gauge (plugin_instance, "users", NULL, users);
697 if ((valid & 0x06) == 0x06)
698 tss2_submit_io (plugin_instance, "io_octets", rx_octets, tx_octets);
700 if ((valid & 0x18) == 0x18)
701 tss2_submit_io (plugin_instance, "io_packets", rx_packets, tx_packets);
703 if ((valid & 0x20) == 0x20)
704 tss2_submit_gauge (plugin_instance, "percent", "packet_loss", packet_loss);
706 if ((valid & 0x40) == 0x40)
707 tss2_submit_gauge (plugin_instance, "gauge", "channels", channels);
709 if ((valid & 0x80) == 0x80)
710 tss2_submit_gauge (plugin_instance, "gauge", "servers", servers);
715 } /* int tss2_read_vserver */
717 static int tss2_config (const char *key, const char *value)
720 * Interpret configuration values
722 if (strcasecmp ("Host", key) == 0)
726 temp = strdup (value);
729 ERROR("teamspeak2 plugin: strdup failed.");
735 else if (strcasecmp ("Port", key) == 0)
739 temp = strdup (value);
742 ERROR("teamspeak2 plugin: strdup failed.");
748 else if (strcasecmp ("Server", key) == 0)
750 /* Server variable found */
753 status = tss2_add_vserver (atoi (value));
759 /* Unknown variable found */
764 } /* int tss2_config */
766 static int tss2_read (void)
769 * Poll function which collects global and vserver information
770 * and submits it to collectd
772 vserver_list_t *vserver;
776 /* Handle global server variables */
777 status = tss2_read_vserver (NULL);
784 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
787 /* Handle vservers */
788 for (vserver = server_list; vserver != NULL; vserver = vserver->next)
790 status = tss2_read_vserver (vserver);
797 WARNING ("teamspeak2 plugin: Reading statistics "
798 "for vserver %i failed.", vserver->port);
806 } /* int tss2_read */
808 static int tss2_shutdown(void)
813 vserver_list_t *entry;
815 tss2_close_socket ();
819 while (entry != NULL)
821 vserver_list_t *next;
828 /* Get rid of the configuration */
833 } /* int tss2_shutdown */
835 void module_register(void)
838 * Mandatory module_register function
840 plugin_register_config ("teamspeak2", tss2_config,
841 config_keys, config_keys_num);
842 plugin_register_read ("teamspeak2", tss2_read);
843 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
844 } /* void module_register */
846 /* vim: set sw=4 ts=4 : */