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
124 value_list_t vl = VALUE_LIST_INIT;
126 vl.values = &(value_t) { .gauge = value };
128 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
129 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
131 if (plugin_instance != NULL)
132 sstrncpy (vl.plugin_instance, plugin_instance,
133 sizeof (vl.plugin_instance));
135 sstrncpy (vl.type, type, sizeof (vl.type));
137 if (type_instance != NULL)
138 sstrncpy (vl.type_instance, type_instance,
139 sizeof (vl.type_instance));
141 plugin_dispatch_values (&vl);
142 } /* void tss2_submit_gauge */
144 static void tss2_submit_io (const char *plugin_instance, const char *type,
145 derive_t rx, derive_t tx)
148 * Submits the io rx/tx tuple to the collectd daemon
150 value_list_t vl = VALUE_LIST_INIT;
157 vl.values_len = STATIC_ARRAY_SIZE (values);
158 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
159 sstrncpy (vl.plugin, "teamspeak2", sizeof (vl.plugin));
161 if (plugin_instance != NULL)
162 sstrncpy (vl.plugin_instance, plugin_instance,
163 sizeof (vl.plugin_instance));
165 sstrncpy (vl.type, type, sizeof (vl.type));
167 plugin_dispatch_values (&vl);
168 } /* void tss2_submit_gauge */
170 static void tss2_close_socket (void)
175 if (global_write_fh != NULL)
177 fputs ("quit\r\n", global_write_fh);
180 if (global_read_fh != NULL)
182 fclose (global_read_fh);
183 global_read_fh = NULL;
186 if (global_write_fh != NULL)
188 fclose (global_write_fh);
189 global_write_fh = NULL;
191 } /* void tss2_close_socket */
193 static int tss2_get_socket (FILE **ret_read_fh, FILE **ret_write_fh)
196 * Returns connected file objects or establishes the connection
197 * if it's not already present
199 struct addrinfo *ai_head;
203 /* Check if we already got opened connections */
204 if ((global_read_fh != NULL) && (global_write_fh != NULL))
206 /* If so, use them */
207 if (ret_read_fh != NULL)
208 *ret_read_fh = global_read_fh;
209 if (ret_write_fh != NULL)
210 *ret_write_fh = global_write_fh;
214 /* Get all addrs for this hostname */
215 struct addrinfo ai_hints = {
216 .ai_family = AF_UNSPEC,
217 .ai_flags = AI_ADDRCONFIG,
218 .ai_socktype = SOCK_STREAM
221 status = getaddrinfo ((config_host != NULL) ? config_host : DEFAULT_HOST,
222 (config_port != NULL) ? config_port : DEFAULT_PORT,
227 ERROR ("teamspeak2 plugin: getaddrinfo failed: %s",
228 gai_strerror (status));
232 /* Try all given hosts until we can connect to one */
233 for (struct addrinfo *ai_ptr = ai_head; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
236 sd = socket (ai_ptr->ai_family, ai_ptr->ai_socktype,
237 ai_ptr->ai_protocol);
241 WARNING ("teamspeak2 plugin: socket failed: %s",
242 sstrerror (errno, errbuf, sizeof (errbuf)));
247 status = connect (sd, ai_ptr->ai_addr, ai_ptr->ai_addrlen);
251 WARNING ("teamspeak2 plugin: connect failed: %s",
252 sstrerror (errno, errbuf, sizeof (errbuf)));
259 * Success, we can break. Don't need more than one connection
264 freeaddrinfo (ai_head);
266 /* Check if we really got connected */
270 /* Create file objects from sockets */
271 global_read_fh = fdopen (sd, "r");
272 if (global_read_fh == NULL)
275 ERROR ("teamspeak2 plugin: fdopen failed: %s",
276 sstrerror (errno, errbuf, sizeof (errbuf)));
281 global_write_fh = fdopen (sd, "w");
282 if (global_write_fh == NULL)
285 ERROR ("teamspeak2 plugin: fdopen failed: %s",
286 sstrerror (errno, errbuf, sizeof (errbuf)));
287 tss2_close_socket ();
291 { /* Check that the server correctly identifies itself. */
295 buffer_ptr = fgets (buffer, sizeof (buffer), global_read_fh);
296 if (buffer_ptr == NULL)
298 WARNING ("teamspeak2 plugin: Unexpected EOF received "
299 "from remote host %s:%s.",
300 config_host ? config_host : DEFAULT_HOST,
301 config_port ? config_port : DEFAULT_PORT);
303 buffer[sizeof (buffer) - 1] = 0;
305 if (memcmp ("[TS]\r\n", buffer, 6) != 0)
307 ERROR ("teamspeak2 plugin: Unexpected response when connecting "
308 "to server. Expected ``[TS]'', got ``%s''.",
310 tss2_close_socket ();
313 DEBUG ("teamspeak2 plugin: Server send correct banner, connected!");
316 /* Copy the new filehandles to the given pointers */
317 if (ret_read_fh != NULL)
318 *ret_read_fh = global_read_fh;
319 if (ret_write_fh != NULL)
320 *ret_write_fh = global_write_fh;
322 } /* int tss2_get_socket */
324 static int tss2_send_request (FILE *fh, const char *request)
327 * This function puts a request to the server socket
331 status = fputs (request, fh);
334 ERROR ("teamspeak2 plugin: fputs failed.");
335 tss2_close_socket ();
341 } /* int tss2_send_request */
343 static int tss2_receive_line (FILE *fh, char *buffer, int buffer_size)
346 * Receive a single line from the given file object
351 * fgets is blocking but much easier then doing anything else
352 * TODO: Non-blocking Version would be safer
354 temp = fgets (buffer, buffer_size, fh);
358 ERROR ("teamspeak2 plugin: fgets failed: %s",
359 sstrerror (errno, errbuf, sizeof(errbuf)));
360 tss2_close_socket ();
364 buffer[buffer_size - 1] = 0;
366 } /* int tss2_receive_line */
368 static int tss2_select_vserver (FILE *read_fh, FILE *write_fh, vserver_list_t *vserver)
371 * Tell the server to select the given vserver
378 ssnprintf (command, sizeof (command), "sel %i\r\n", vserver->port);
380 status = tss2_send_request (write_fh, command);
383 ERROR ("teamspeak2 plugin: tss2_send_request (%s) failed.", command);
388 status = tss2_receive_line (read_fh, response, sizeof (response));
391 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
394 response[sizeof (response) - 1] = 0;
397 if ((strncasecmp ("OK", response, 2) == 0)
398 && ((response[2] == 0)
399 || (response[2] == '\n')
400 || (response[2] == '\r')))
403 ERROR ("teamspeak2 plugin: Command ``%s'' failed. "
404 "Response received from server was: ``%s''.",
407 } /* int tss2_select_vserver */
409 static int tss2_vserver_gapl (FILE *read_fh, FILE *write_fh,
413 * Reads the vserver's average packet loss and submits it to collectd.
414 * Be sure to run the tss2_read_vserver function before calling this so
415 * the vserver is selected correctly.
417 gauge_t packet_loss = NAN;
420 status = tss2_send_request (write_fh, "gapl\r\n");
423 ERROR("teamspeak2 plugin: tss2_send_request (gapl) failed.");
433 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
436 /* Set to NULL just to make sure no one uses these FHs anymore. */
439 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
442 buffer[sizeof (buffer) - 1] = 0;
444 if (strncmp ("average_packet_loss=", buffer,
445 strlen ("average_packet_loss=")) == 0)
447 /* Got average packet loss, now interpret it */
449 /* Replace , with . */
462 packet_loss = strtod (value, &endptr);
466 WARNING ("teamspeak2 plugin: Could not read average package "
467 "loss from string: %s", buffer);
471 else if (strncasecmp ("OK", buffer, 2) == 0)
475 else if (strncasecmp ("ERROR", buffer, 5) == 0)
477 ERROR ("teamspeak2 plugin: Server returned an error: %s", buffer);
482 WARNING ("teamspeak2 plugin: Server returned unexpected string: %s",
487 *ret_value = packet_loss;
489 } /* int tss2_vserver_gapl */
491 static int tss2_read_vserver (vserver_list_t *vserver)
494 * Poll information for the given vserver and submit it to collect.
495 * If vserver is NULL the global server information will be queried.
500 gauge_t channels = NAN;
501 gauge_t servers = NAN;
502 derive_t rx_octets = 0;
503 derive_t tx_octets = 0;
504 derive_t rx_packets = 0;
505 derive_t tx_packets = 0;
506 gauge_t packet_loss = NAN;
509 char plugin_instance[DATA_MAX_NAME_LEN] = { 0 };
514 /* Get the send/receive sockets */
515 status = tss2_get_socket (&read_fh, &write_fh);
518 ERROR ("teamspeak2 plugin: tss2_get_socket failed.");
524 /* Request global information */
525 status = tss2_send_request (write_fh, "gi\r\n");
529 /* Request server information */
530 ssnprintf (plugin_instance, sizeof (plugin_instance), "vserver%i",
533 /* Select the server */
534 status = tss2_select_vserver (read_fh, write_fh, vserver);
538 status = tss2_send_request (write_fh, "si\r\n");
543 ERROR ("teamspeak2 plugin: tss2_send_request failed.");
547 /* Loop until break */
555 /* Read one line of the server's answer */
556 status = tss2_receive_line (read_fh, buffer, sizeof (buffer));
559 /* Set to NULL just to make sure no one uses these FHs anymore. */
562 ERROR ("teamspeak2 plugin: tss2_receive_line failed.");
566 if (strncasecmp ("ERROR", buffer, 5) == 0)
568 ERROR ("teamspeak2 plugin: Server returned an error: %s",
572 else if (strncasecmp ("OK", buffer, 2) == 0)
577 /* Split line into key and value */
578 key = strchr (buffer, '_');
581 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
586 /* Evaluate assignment */
587 value = strchr (key, '=');
590 DEBUG ("teamspeak2 plugin: Cannot parse line: %s", buffer);
596 /* Check for known key and save the given value */
597 /* global info: users_online,
598 * server info: currentusers. */
599 if ((strcmp ("currentusers", key) == 0)
600 || (strcmp ("users_online", key) == 0))
602 users = strtod (value, &endptr);
606 /* global info: channels,
607 * server info: currentchannels. */
608 else if ((strcmp ("currentchannels", key) == 0)
609 || (strcmp ("channels", key) == 0))
611 channels = strtod (value, &endptr);
616 else if (strcmp ("servers", key) == 0)
618 servers = strtod (value, &endptr);
622 else if (strcmp ("bytesreceived", key) == 0)
624 rx_octets = strtoll (value, &endptr, 0);
628 else if (strcmp ("bytessend", key) == 0)
630 tx_octets = strtoll (value, &endptr, 0);
634 else if (strcmp ("packetsreceived", key) == 0)
636 rx_packets = strtoll (value, &endptr, 0);
640 else if (strcmp ("packetssend", key) == 0)
642 tx_packets = strtoll (value, &endptr, 0);
646 else if ((strncmp ("allow_codec_", key, strlen ("allow_codec_")) == 0)
647 || (strncmp ("bwinlast", key, strlen ("bwinlast")) == 0)
648 || (strncmp ("bwoutlast", key, strlen ("bwoutlast")) == 0)
649 || (strncmp ("webpost_", key, strlen ("webpost_")) == 0)
650 || (strcmp ("adminemail", key) == 0)
651 || (strcmp ("clan_server", key) == 0)
652 || (strcmp ("countrynumber", key) == 0)
653 || (strcmp ("id", key) == 0)
654 || (strcmp ("ispname", key) == 0)
655 || (strcmp ("linkurl", key) == 0)
656 || (strcmp ("maxusers", key) == 0)
657 || (strcmp ("name", key) == 0)
658 || (strcmp ("password", key) == 0)
659 || (strcmp ("platform", key) == 0)
660 || (strcmp ("server_platform", key) == 0)
661 || (strcmp ("server_uptime", key) == 0)
662 || (strcmp ("server_version", key) == 0)
663 || (strcmp ("udpport", key) == 0)
664 || (strcmp ("uptime", key) == 0)
665 || (strcmp ("users_maximal", key) == 0)
666 || (strcmp ("welcomemessage", key) == 0))
670 INFO ("teamspeak2 plugin: Unknown key-value-pair: "
671 "key = %s; value = %s;", key, value);
675 /* Collect vserver packet loss rates only if the loop above did not exit
677 if ((status == 0) && (vserver != NULL))
679 status = tss2_vserver_gapl (read_fh, write_fh, &packet_loss);
686 WARNING ("teamspeak2 plugin: Reading package loss "
687 "for vserver %i failed.", vserver->port);
691 if ((valid & 0x01) == 0x01)
692 tss2_submit_gauge (plugin_instance, "users", NULL, users);
694 if ((valid & 0x06) == 0x06)
695 tss2_submit_io (plugin_instance, "io_octets", rx_octets, tx_octets);
697 if ((valid & 0x18) == 0x18)
698 tss2_submit_io (plugin_instance, "io_packets", rx_packets, tx_packets);
700 if ((valid & 0x20) == 0x20)
701 tss2_submit_gauge (plugin_instance, "percent", "packet_loss", packet_loss);
703 if ((valid & 0x40) == 0x40)
704 tss2_submit_gauge (plugin_instance, "gauge", "channels", channels);
706 if ((valid & 0x80) == 0x80)
707 tss2_submit_gauge (plugin_instance, "gauge", "servers", servers);
712 } /* int tss2_read_vserver */
714 static int tss2_config (const char *key, const char *value)
717 * Interpret configuration values
719 if (strcasecmp ("Host", key) == 0)
723 temp = strdup (value);
726 ERROR("teamspeak2 plugin: strdup failed.");
732 else if (strcasecmp ("Port", key) == 0)
736 temp = strdup (value);
739 ERROR("teamspeak2 plugin: strdup failed.");
745 else if (strcasecmp ("Server", key) == 0)
747 /* Server variable found */
750 status = tss2_add_vserver (atoi (value));
756 /* Unknown variable found */
761 } /* int tss2_config */
763 static int tss2_read (void)
766 * Poll function which collects global and vserver information
767 * and submits it to collectd
772 /* Handle global server variables */
773 status = tss2_read_vserver (NULL);
780 WARNING ("teamspeak2 plugin: Reading global server variables failed.");
783 /* Handle vservers */
784 for (vserver_list_t *vserver = server_list; vserver != NULL; vserver = vserver->next)
786 status = tss2_read_vserver (vserver);
793 WARNING ("teamspeak2 plugin: Reading statistics "
794 "for vserver %i failed.", vserver->port);
802 } /* int tss2_read */
804 static int tss2_shutdown(void)
809 vserver_list_t *entry;
811 tss2_close_socket ();
815 while (entry != NULL)
817 vserver_list_t *next;
824 /* Get rid of the configuration */
829 } /* int tss2_shutdown */
831 void module_register(void)
834 * Mandatory module_register function
836 plugin_register_config ("teamspeak2", tss2_config,
837 config_keys, config_keys_num);
838 plugin_register_read ("teamspeak2", tss2_read);
839 plugin_register_shutdown ("teamspeak2", tss2_shutdown);
840 } /* void module_register */
842 /* vim: set sw=4 ts=4 : */