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 <netinet/in.h>
30 #include <arpa/inet.h>
31 #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
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 = calloc (1, sizeof (*entry));
90 ERROR ("teamspeak2 plugin: calloc failed.");
95 entry->port = vserver_port;
98 if(server_list == NULL) {
99 /* Add the server as the first element */
103 vserver_list_t *prev;
105 /* Add the server to the end of the list */
107 while (prev->next != NULL)
112 INFO ("teamspeak2 plugin: Registered new vserver: %i", vserver_port);
115 } /* int tss2_add_vserver */
117 static void tss2_submit_gauge (const char *plugin_instance,
118 const char *type, const char *type_instance,
122 * Submits a gauge value to the collectd daemon
125 value_list_t vl = VALUE_LIST_INIT;
127 values[0].gauge = value;
131 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
132 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
134 if (plugin_instance != NULL)
135 sstrncpy (vl.plugin_instance, plugin_instance,
136 sizeof (vl.plugin_instance));
138 sstrncpy (vl.type, type, sizeof (vl.type));
140 if (type_instance != NULL)
141 sstrncpy (vl.type_instance, type_instance,
142 sizeof (vl.type_instance));
144 plugin_dispatch_values (&vl);
145 } /* void tss2_submit_gauge */
147 static void tss2_submit_io (const char *plugin_instance, const char *type,
148 derive_t rx, derive_t tx)
151 * Submits the io rx/tx tuple to the collectd daemon
154 value_list_t vl = VALUE_LIST_INIT;
156 values[0].derive = rx;
157 values[1].derive = tx;
161 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
162 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
164 if (plugin_instance != NULL)
165 sstrncpy (vl.plugin_instance, plugin_instance,
166 sizeof (vl.plugin_instance));
168 sstrncpy (vl.type, type, sizeof (vl.type));
170 plugin_dispatch_values (&vl);
171 } /* void tss2_submit_gauge */
173 static void tss2_close_socket (void)
178 if (global_write_fh != NULL)
180 fputs ("quit\r\n", global_write_fh);
183 if (global_read_fh != NULL)
185 fclose (global_read_fh);
186 global_read_fh = NULL;
189 if (global_write_fh != NULL)
191 fclose (global_write_fh);
192 global_write_fh = NULL;
194 } /* void tss2_close_socket */
196 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
199 * Returns connected file objects or establishes the connection
200 * if it's not already present
202 struct addrinfo *ai_head;
206 /* Check if we already got opened connections */
207 if ((global_read_fh != NULL) && (global_write_fh != NULL))
209 /* If so, use them */
210 if (ret_read_fh != NULL)
211 *ret_read_fh = global_read_fh;
212 if (ret_write_fh != NULL)
213 *ret_write_fh = global_write_fh;
217 /* Get all addrs for this hostname */
218 struct addrinfo ai_hints = {
219 .ai_family = AF_UNSPEC,
220 .ai_flags = AI_ADDRCONFIG,
221 .ai_socktype = SOCK_STREAM
224 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
225 (config_port != NULL) ? config_port : DEFAULT_PORT,
230 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
231 gai_strerror (status));
235 /* Try all given hosts until we can connect to one */
236 for (struct addrinfo *ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
239 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
240 ai_ptr->ai_protocol);
244 WARNING ("teamspeak2 plugin: socket failed: %s",
245 sstrerror (errno, errbuf, sizeof (errbuf)));
250 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
254 WARNING ("teamspeak2 plugin: connect failed: %s",
255 sstrerror (errno, errbuf, sizeof (errbuf)));
262 * Success, we can break. Don't need more than one connection
267 freeaddrinfo (ai_head);
269 /* Check if we really got connected */
273 /* Create file objects from sockets */
274 global_read_fh = fdopen (sd, "r");
275 if (global_read_fh == NULL)
278 ERROR ("teamspeak2 plugin: fdopen failed: %s",
279 sstrerror (errno, errbuf, sizeof (errbuf)));
284 global_write_fh = fdopen (sd, "w");
285 if (global_write_fh == NULL)
288 ERROR ("teamspeak2 plugin: fdopen failed: %s",
289 sstrerror (errno, errbuf, sizeof (errbuf)));
290 tss2_close_socket ();
294 { /* Check that the server correctly identifies itself. */
298 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
299 if (buffer_ptr == NULL)
301 WARNING ("teamspeak2 plugin: Unexpected EOF received "
302 "from remote host %s:%s.",
303 config_host ? config_host : DEFAULT_HOST,
304 config_port ? config_port : DEFAULT_PORT);
306 buffer[sizeof (buffer) - 1] = 0;
308 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
310 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
311 "to server. Expected ``[TS]'', got ``%s''.",
313 tss2_close_socket ();
316 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
319 /* Copy the new filehandles to the given pointers */
320 if (ret_read_fh != NULL)
321 *ret_read_fh = global_read_fh;
322 if (ret_write_fh != NULL)
323 *ret_write_fh = global_write_fh;
325 } /* int tss2_get_socket */
327 static int tss2_send_request (FILE *fh, const char *request)
330 * This function puts a request to the server socket
334 status = fputs (request, fh);
337 ERROR ("teamspeak2 plugin: fputs failed.");
338 tss2_close_socket ();
344 } /* int tss2_send_request */
346 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
349 * Receive a single line from the given file object
354 * fgets is blocking but much easier then doing anything else
355 * TODO: Non-blocking Version would be safer
357 temp = fgets (buffer, buffer_size, fh);
361 ERROR ("teamspeak2 plugin: fgets failed: %s",
362 sstrerror (errno, errbuf, sizeof(errbuf)));
363 tss2_close_socket ();
367 buffer[buffer_size - 1] = 0;
369 } /* int tss2_receive_line */
371 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
374 * Tell the server to select the given vserver
381 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
383 status = tss2_send_request (write_fh, command);
386 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
391 status = tss2_receive_line (read_fh, response, sizeof (response));
394 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
397 response[sizeof (response) - 1] = 0;
400 if ((strncasecmp ("OK", response, 2) == 0)
401 && ((response[2] == 0)
402 || (response[2] == '\n')
403 || (response[2] == '\r')))
406 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
407 "Response received from server was: ``%s''.",
410 } /* int tss2_select_vserver */
412 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
416 * Reads the vserver's average packet loss and submits it to collectd.
417 * Be sure to run the tss2_read_vserver function before calling this so
418 * the vserver is selected correctly.
420 gauge_t packet_loss = NAN;
423 status = tss2_send_request (write_fh, "gapl\r\n");
426 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
436 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
439 /* Set to NULL just to make sure no one uses these FHs anymore. */
442 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
445 buffer[sizeof (buffer) - 1] = 0;
447 if (strncmp ("average_packet_loss=", buffer,
448 strlen ("average_packet_loss=")) == 0)
450 /* Got average packet loss, now interpret it */
452 /* Replace , with . */
465 packet_loss = strtod (value, &endptr);
469 WARNING ("teamspeak2 plugin: Could not read average package "
470 "loss from string: %s", buffer);
474 else if (strncasecmp ("OK", buffer, 2) == 0)
478 else if (strncasecmp ("ERROR", buffer, 5) == 0)
480 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
485 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
490 *ret_value = packet_loss;
492 } /* int tss2_vserver_gapl */
494 static int tss2_read_vserver (vserver_list_t *vserver)
497 * Poll information for the given vserver and submit it to collect.
498 * If vserver is NULL the global server information will be queried.
503 gauge_t channels = NAN;
504 gauge_t servers = NAN;
505 derive_t rx_octets = 0;
506 derive_t tx_octets = 0;
507 derive_t rx_packets = 0;
508 derive_t tx_packets = 0;
509 gauge_t packet_loss = NAN;
512 char plugin_instance[DATA_MAX_NAME_LEN] = { 0 };
517 /* Get the send/receive sockets */
518 status = tss2_get_socket (&read_fh, &write_fh);
521 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
527 /* Request global information */
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 no one 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, &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
775 /* Handle global server variables */
776 status = tss2_read_vserver (NULL);
783 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
786 /* Handle vservers */
787 for (vserver_list_t *vserver = server_list; vserver != NULL; vserver = vserver->next)
789 status = tss2_read_vserver (vserver);
796 WARNING ("teamspeak2 plugin: Reading statistics "
797 "for vserver %i failed.", vserver->port);
805 } /* int tss2_read */
807 static int tss2_shutdown(void)
812 vserver_list_t *entry;
814 tss2_close_socket ();
818 while (entry != NULL)
820 vserver_list_t *next;
827 /* Get rid of the configuration */
832 } /* int tss2_shutdown */
834 void module_register(void)
837 * Mandatory module_register function
839 plugin_register_config ("teamspeak2", tss2_config,
840 config_keys, config_keys_num);
841 plugin_register_read ("teamspeak2", tss2_read);
842 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
843 } /* void module_register */
845 /* vim: set sw=4 ts=4 : */