2 * collectd - src/powerdns.c
3 * Copyright (C) 2007-2008 C-Ware, Inc.
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 * Luke Heberling <lukeh at c-ware.com>
21 * Florian Forster <octo at verplant.org>
24 * Queries a PowerDNS control socket for statistics
30 #include "configfile.h"
31 #include "utils_llist.h"
39 #include <sys/types.h>
40 #include <sys/socket.h>
44 # define UNIX_PATH_MAX sizeof (((struct sockaddr_un *)0)->sun_path)
46 #define FUNC_ERROR(func) do { char errbuf[1024]; ERROR ("powerdns plugin: %s failed: %s", func, sstrerror (errno, errbuf, sizeof (errbuf))); } while (0)
48 #define SERVER_SOCKET "/var/run/pdns.controlsocket"
49 #define SERVER_COMMAND "SHOW *"
51 #define RECURSOR_SOCKET "/var/run/pdns_recursor.controlsocket"
52 #define RECURSOR_COMMAND "get all-outqueries answers0-1 " /* {{{ */ \
53 "answers100-1000 answers10-100 answers1-10 answers-slow cache-entries " \
54 "cache-hits cache-misses chain-resends client-parse-errors " \
55 "concurrent-queries dlg-only-drops ipv6-outqueries negcache-entries " \
56 "noerror-answers nsset-invalidations nsspeeds-entries nxdomain-answers " \
57 "outgoing-timeouts qa-latency questions resource-limits " \
58 "server-parse-errors servfail-answers spoof-prevents sys-msec " \
59 "tcp-client-overflow tcp-outqueries tcp-questions throttled-out " \
60 "throttled-outqueries throttle-entries unauthorized-tcp unauthorized-udp " \
61 "unexpected-packets unreachables user-msec" /* }}} */
64 typedef struct list_item_s list_item_t;
73 int (*func) (list_item_t *item);
80 struct sockaddr_un sockaddr;
84 struct statname_lookup_s
90 typedef struct statname_lookup_s statname_lookup_t;
92 /* Description of statistics returned by the recursor: {{{
93 all-outqueries counts the number of outgoing UDP queries since starting
94 answers0-1 counts the number of queries answered within 1 milisecond
95 answers100-1000 counts the number of queries answered within 1 second
96 answers10-100 counts the number of queries answered within 100 miliseconds
97 answers1-10 counts the number of queries answered within 10 miliseconds
98 answers-slow counts the number of queries answered after 1 second
99 cache-entries shows the number of entries in the cache
100 cache-hits counts the number of cache hits since starting
101 cache-misses counts the number of cache misses since starting
102 chain-resends number of queries chained to existing outstanding query
103 client-parse-errors counts number of client packets that could not be parsed
104 concurrent-queries shows the number of MThreads currently running
105 dlg-only-drops number of records dropped because of delegation only setting
106 negcache-entries shows the number of entries in the Negative answer cache
107 noerror-answers counts the number of times it answered NOERROR since starting
108 nsspeeds-entries shows the number of entries in the NS speeds map
109 nsset-invalidations number of times an nsset was dropped because it no longer worked
110 nxdomain-answers counts the number of times it answered NXDOMAIN since starting
111 outgoing-timeouts counts the number of timeouts on outgoing UDP queries since starting
112 qa-latency shows the current latency average
113 questions counts all End-user initiated queries with the RD bit set
114 resource-limits counts number of queries that could not be performed because of resource limits
115 server-parse-errors counts number of server replied packets that could not be parsed
116 servfail-answers counts the number of times it answered SERVFAIL since starting
117 spoof-prevents number of times PowerDNS considered itself spoofed, and dropped the data
118 sys-msec number of CPU milliseconds spent in 'system' mode
119 tcp-client-overflow number of times an IP address was denied TCP access because it already had too many connections
120 tcp-outqueries counts the number of outgoing TCP queries since starting
121 tcp-questions counts all incoming TCP queries (since starting)
122 throttled-out counts the number of throttled outgoing UDP queries since starting
123 throttle-entries shows the number of entries in the throttle map
124 unauthorized-tcp number of TCP questions denied because of allow-from restrictions
125 unauthorized-udp number of UDP questions denied because of allow-from restrictions
126 unexpected-packets number of answers from remote servers that were unexpected (might point to spoofing)
127 uptime number of seconds process has been running (since 3.1.5)
128 user-msec number of CPU milliseconds spent in 'user' mode
131 const char* const default_server_fields[] = /* {{{ */
140 "recursing-questions",
146 int default_server_fields_num = STATIC_ARRAY_SIZE (default_server_fields);
148 statname_lookup_t lookup_table[] = /* {{{ */
150 /*********************
151 * Server statistics *
152 *********************/
154 {"recursing-questions", "dns_question", "recurse"},
155 {"tcp-queries", "dns_question", "tcp"},
156 {"udp-queries", "dns_question", "udp"},
159 {"recursing-answers", "dns_answer", "recurse"},
160 {"tcp-answers", "dns_answer", "tcp"},
161 {"udp-answers", "dns_answer", "udp"},
164 {"packetcache-hit", "cache_result", "packet-hit"},
165 {"packetcache-miss", "cache_result", "packet-miss"},
166 {"packetcache-size", "cache_size", "packet"},
167 {"query-cache-hit", "cache_result", "query-hit"},
168 {"query-cache-miss", "cache_result", "query-miss"},
171 {"latency", "latency", NULL},
174 {"corrupt-packets", "io_packets", "corrupt"},
175 {"deferred-cache-inserts", "counter", "cache-deferred_insert"},
176 {"deferred-cache-lookup", "counter", "cache-deferred_lookup"},
177 {"qsize-a", "cache_size", "answers"},
178 {"qsize-q", "cache_size", "questions"},
179 {"servfail-packets", "io_packets", "servfail"},
180 {"timedout-packets", "io_packets", "timeout"},
181 {"udp4-answers", "dns_answer", "udp4"},
182 {"udp4-queries", "dns_question", "queries-udp4"},
183 {"udp6-answers", "dns_answer", "udp6"},
184 {"udp6-queries", "dns_question", "queries-udp6"},
186 /***********************
187 * Recursor statistics *
188 ***********************/
189 /* Answers by return code */
190 {"noerror-answers", "dns_rcode", "NOERROR"},
191 {"nxdomain-answers", "dns_rcode", "NXDOMAIN"},
192 {"servfail-answers", "dns_rcode", "SERVFAIL"},
194 /* CPU utilization */
195 {"sys-msec", "cpu", "system"},
196 {"user-msec", "cpu", "user"},
198 /* Question-to-answer latency */
199 {"qa-latency", "latency", NULL},
202 {"cache-entries", "cache_size", NULL},
203 {"cache-hits", "cache_result", "hit"},
204 {"cache-misses", "cache_result", "miss"},
206 /* Total number of questions.. */
207 {"questions", "dns_qtype", "total"}
209 /* TODO: Add all recursor metrics here */
211 int lookup_table_length = STATIC_ARRAY_SIZE (lookup_table);
213 static llist_t *list = NULL;
215 #define PDNS_LOCAL_SOCKPATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-powerdns"
216 static char *local_sockpath = NULL;
218 /* TODO: Do this before 4.4:
220 * - Complete list of known pdns -> collectd mappings.
221 * - Update the collectd.conf(5) manpage.
226 /* <http://doc.powerdns.com/recursor-stats.html> */
227 static void submit (const char *plugin_instance, /* {{{ */
228 const char *pdns_type, const char *value)
230 value_list_t vl = VALUE_LIST_INIT;
233 const char *type = NULL;
234 const char *type_instance = NULL;
235 const data_set_t *ds;
239 for (i = 0; i < lookup_table_length; i++)
240 if (strcmp (lookup_table[i].name, pdns_type) == 0)
243 if (lookup_table[i].type == NULL)
246 if (i >= lookup_table_length)
248 DEBUG ("powerdns plugin: submit: Not found in lookup table: %s = %s;",
253 type = lookup_table[i].type;
254 type_instance = lookup_table[i].type_instance;
256 ds = plugin_get_ds (type);
259 ERROR ("powerdns plugin: The lookup table returned type `%s', "
260 "but I cannot find it via `plugin_get_ds'.",
267 ERROR ("powerdns plugin: type `%s' has %i data sources, "
268 "but I can only handle one.",
273 if (ds->ds[0].type == DS_TYPE_GAUGE)
277 values[0].gauge = strtod (value, &endptr);
281 ERROR ("powerdns plugin: Cannot convert `%s' "
282 "to a floating point number.", value);
290 values[0].counter = strtoll (value, &endptr, 0);
293 ERROR ("powerdns plugin: Cannot convert `%s' "
294 "to an integer number.", value);
301 vl.time = time (NULL);
302 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
303 sstrncpy (vl.plugin, "powerdns", sizeof (vl.plugin));
304 if (type_instance != NULL)
305 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
306 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
308 plugin_dispatch_values (type, &vl);
309 } /* }}} static void submit */
311 static int powerdns_get_data_dgram (list_item_t *item, /* {{{ */
313 size_t *ret_buffer_size)
320 size_t buffer_size = 0;
322 struct sockaddr_un sa_unix;
324 sd = socket (PF_UNIX, item->socktype, 0);
327 FUNC_ERROR ("socket");
331 memset (&sa_unix, 0, sizeof (sa_unix));
332 sa_unix.sun_family = AF_UNIX;
333 strncpy (sa_unix.sun_path,
334 (local_sockpath != NULL) ? local_sockpath : PDNS_LOCAL_SOCKPATH,
335 sizeof (sa_unix.sun_path));
336 sa_unix.sun_path[sizeof (sa_unix.sun_path) - 1] = 0;
338 status = unlink (sa_unix.sun_path);
339 if ((status != 0) && (errno != ENOENT))
341 FUNC_ERROR ("unlink");
348 /* We need to bind to a specific path, because this is a datagram socket
349 * and otherwise the daemon cannot answer. */
350 status = bind (sd, (struct sockaddr *) &sa_unix, sizeof (sa_unix));
357 /* Make the socket writeable by the daemon.. */
358 status = chmod (sa_unix.sun_path, 0666);
361 FUNC_ERROR ("chmod");
365 status = connect (sd, (struct sockaddr *) &item->sockaddr,
366 sizeof (item->sockaddr));
369 FUNC_ERROR ("connect");
373 status = send (sd, item->command, strlen (item->command), 0);
380 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
390 unlink (sa_unix.sun_path);
395 buffer_size = status + 1;
396 buffer = (char *) malloc (buffer_size);
399 FUNC_ERROR ("malloc");
403 memcpy (buffer, temp, status);
406 *ret_buffer = buffer;
407 *ret_buffer_size = buffer_size;
410 } /* }}} int powerdns_get_data_dgram */
412 static int powerdns_get_data_stream (list_item_t *item, /* {{{ */
414 size_t *ret_buffer_size)
421 size_t buffer_size = 0;
423 sd = socket (PF_UNIX, item->socktype, 0);
426 FUNC_ERROR ("socket");
430 status = connect (sd, (struct sockaddr *) &item->sockaddr,
431 sizeof (item->sockaddr));
434 FUNC_ERROR ("connect");
439 /* strlen + 1, because we need to send the terminating NULL byte, too. */
440 status = send (sd, item->command, strlen (item->command) + 1,
453 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
459 else if (status == 0)
462 buffer_new = (char *) realloc (buffer, buffer_size + status + 1);
463 if (buffer_new == NULL)
465 FUNC_ERROR ("realloc");
471 memcpy (buffer + buffer_size, temp, status);
472 buffer_size += status;
473 buffer[buffer_size] = 0;
484 assert (status == 0);
485 *ret_buffer = buffer;
486 *ret_buffer_size = buffer_size;
490 } /* }}} int powerdns_get_data_stream */
492 static int powerdns_get_data (list_item_t *item, char **ret_buffer,
493 size_t *ret_buffer_size)
495 if (item->socktype == SOCK_DGRAM)
496 return (powerdns_get_data_dgram (item, ret_buffer, ret_buffer_size));
497 else if (item->socktype == SOCK_STREAM)
498 return (powerdns_get_data_stream (item, ret_buffer, ret_buffer_size));
501 ERROR ("powerdns plugin: Unknown socket type: %i", (int) item->socktype);
504 } /* int powerdns_get_data */
506 static int powerdns_read_server (list_item_t *item) /* {{{ */
509 size_t buffer_size = 0;
518 const char* const *fields;
521 if (item->command == NULL)
522 item->command = strdup ("SHOW *");
523 if (item->command == NULL)
525 ERROR ("powerdns plugin: strdup failed.");
529 status = powerdns_get_data (item, &buffer, &buffer_size);
533 if (item->fields_num != 0)
535 fields = (const char* const *) item->fields;
536 fields_num = item->fields_num;
540 fields = default_server_fields;
541 fields_num = default_server_fields_num;
544 assert (fields != NULL);
545 assert (fields_num > 0);
547 /* corrupt-packets=0,deferred-cache-inserts=0,deferred-cache-lookup=0,latency=0,packetcache-hit=0,packetcache-miss=0,packetcache-size=0,qsize-q=0,query-cache-hit=0,query-cache-miss=0,recursing-answers=0,recursing-questions=0,servfail-packets=0,tcp-answers=0,tcp-queries=0,timedout-packets=0,udp-answers=0,udp-queries=0,udp4-answers=0,udp4-queries=0,udp6-answers=0,udp6-queries=0, */
550 while ((key = strtok_r (dummy, ",", &saveptr)) != NULL)
556 value = strchr (key, '=');
563 if (value[0] == '\0')
566 /* Check if this item was requested. */
567 for (i = 0; i < fields_num; i++)
568 if (strcasecmp (key, fields[i]) == 0)
573 submit (item->instance, key, value);
574 } /* while (strtok_r) */
579 } /* }}} int powerdns_read_server */
582 * powerdns_update_recursor_command
584 * Creates a string that holds the command to be sent to the recursor. This
585 * string is stores in the `command' member of the `list_item_t' passed to the
586 * function. This function is called by `powerdns_read_recursor'.
588 static int powerdns_update_recursor_command (list_item_t *li) /* {{{ */
596 if (li->fields_num < 1)
598 sstrncpy (buffer, RECURSOR_COMMAND, sizeof (buffer));
602 strcpy (buffer, "get ");
603 status = strjoin (&buffer[4], sizeof (buffer) - strlen ("get "),
604 li->fields, li->fields_num,
605 /* seperator = */ " ");
608 ERROR ("powerdns plugin: strjoin failed.");
613 buffer[sizeof (buffer) - 1] = 0;
614 li->command = strdup (buffer);
615 if (li->command == NULL)
617 ERROR ("powerdns plugin: strdup failed.");
622 } /* }}} int powerdns_update_recursor_command */
624 static int powerdns_read_recursor (list_item_t *item) /* {{{ */
627 size_t buffer_size = 0;
638 if (item->command == NULL)
640 status = powerdns_update_recursor_command (item);
643 ERROR ("powerdns plugin: powerdns_update_recursor_command failed.");
647 assert (item->command != NULL);
649 status = powerdns_get_data (item, &buffer, &buffer_size);
653 keys_list = strdup (item->command);
654 if (keys_list == NULL)
656 FUNC_ERROR ("strdup");
662 value_saveptr = NULL;
664 /* Skip the `get' at the beginning */
665 strtok_r (keys_list, " \t", &key_saveptr);
668 while ((value = strtok_r (dummy, " \t\n\r", &value_saveptr)) != NULL)
672 key = strtok_r (NULL, " \t", &key_saveptr);
676 submit (item->instance, key, value);
677 } /* while (strtok_r) */
683 } /* }}} int powerdns_read_recursor */
685 static int powerdns_config_add_string (const char *name, /* {{{ */
689 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
691 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
697 *dest = strdup (ci->values[0].value.string);
702 } /* }}} int powerdns_config_add_string */
704 static int powerdns_config_add_collect (list_item_t *li, /* {{{ */
710 if (ci->values_num < 1)
712 WARNING ("powerdns plugin: The `Collect' option needs "
713 "at least one argument.");
717 for (i = 0; i < ci->values_num; i++)
718 if (ci->values[i].type != OCONFIG_TYPE_STRING)
720 WARNING ("powerdns plugin: Only string arguments are allowed to "
721 "the `Collect' option.");
725 temp = (char **) realloc (li->fields,
726 sizeof (char *) * (li->fields_num + ci->values_num));
729 WARNING ("powerdns plugin: realloc failed.");
734 for (i = 0; i < ci->values_num; i++)
736 li->fields[li->fields_num] = strdup (ci->values[i].value.string);
737 if (li->fields[li->fields_num] == NULL)
739 WARNING ("powerdns plugin: strdup failed.");
745 /* Invalidate a previously computed command */
749 } /* }}} int powerdns_config_add_collect */
751 static int powerdns_config_add_server (oconfig_item_t *ci) /* {{{ */
759 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
761 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
766 item = (list_item_t *) malloc (sizeof (list_item_t));
769 ERROR ("powerdns plugin: malloc failed.");
772 memset (item, '\0', sizeof (list_item_t));
774 item->instance = strdup (ci->values[0].value.string);
775 if (item->instance == NULL)
777 ERROR ("powerdns plugin: strdup failed.");
783 * Set default values for the members of list_item_t
785 if (strcasecmp ("Server", ci->key) == 0)
787 item->server_type = SRV_AUTHORATIVE;
788 item->func = powerdns_read_server;
789 item->socktype = SOCK_STREAM;
790 socket_temp = strdup (SERVER_SOCKET);
792 else if (strcasecmp ("Recursor", ci->key) == 0)
794 item->server_type = SRV_RECURSOR;
795 item->func = powerdns_read_recursor;
796 item->socktype = SOCK_DGRAM;
797 socket_temp = strdup (RECURSOR_SOCKET);
801 /* We must never get here.. */
807 for (i = 0; i < ci->children_num; i++)
809 oconfig_item_t *option = ci->children + i;
811 if (strcasecmp ("Collect", option->key) == 0)
812 status = powerdns_config_add_collect (item, option);
813 else if (strcasecmp ("Socket", option->key) == 0)
814 status = powerdns_config_add_string ("Socket", &socket_temp, option);
817 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
829 if (socket_temp == NULL)
831 ERROR ("powerdns plugin: socket_temp == NULL.");
836 if (item->command == NULL)
838 ERROR ("powerdns plugin: item->command == NULL.");
843 item->sockaddr.sun_family = AF_UNIX;
844 sstrncpy (item->sockaddr.sun_path, socket_temp, UNIX_PATH_MAX);
846 e = llentry_create (item->instance, item);
849 ERROR ("powerdns plugin: llentry_create failed.");
853 llist_append (list, e);
864 DEBUG ("powerdns plugin: Add server: instance = %s;", item->instance);
867 } /* }}} int powerdns_config_add_server */
869 static int powerdns_config (oconfig_item_t *ci) /* {{{ */
873 DEBUG ("powerdns plugin: powerdns_config (ci = %p);", (void *) ci);
877 list = llist_create ();
881 ERROR ("powerdns plugin: `llist_create' failed.");
886 for (i = 0; i < ci->children_num; i++)
888 oconfig_item_t *option = ci->children + i;
890 if ((strcasecmp ("Server", option->key) == 0)
891 || (strcasecmp ("Recursor", option->key) == 0))
892 powerdns_config_add_server (option);
893 if (strcasecmp ("LocalSocket", option->key) == 0)
895 char *temp = strdup (option->key);
898 sfree (local_sockpath);
899 local_sockpath = temp;
903 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
905 } /* for (i = 0; i < ci->children_num; i++) */
908 } /* }}} int powerdns_config */
910 static int powerdns_read (void)
914 for (e = llist_head (list); e != NULL; e = e->next)
916 list_item_t *item = e->value;
921 } /* static int powerdns_read */
923 static int powerdns_shutdown (void)
930 for (e = llist_head (list); e != NULL; e = e->next)
932 list_item_t *item = (list_item_t *) e->value;
935 sfree (item->instance);
936 sfree (item->command);
940 llist_destroy (list);
944 } /* static int powerdns_shutdown */
946 void module_register (void)
948 plugin_register_complex_config ("powerdns", powerdns_config);
949 plugin_register_read ("powerdns", powerdns_read);
950 plugin_register_shutdown ("powerdns", powerdns_shutdown );
951 } /* void module_register */
953 /* vim: set sw=2 sts=2 ts=8 fdm=marker : */