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 /* All the other stuff.. */
210 {"all-outqueries", "dns_question", "outgoing"},
211 {"answers0-1", "dns_answer", "0_1"},
212 {"answers1-10", "dns_answer", "1_10"},
213 {"answers10-100", "dns_answer", "10_100"},
214 {"answers100-1000", "dns_answer", "100_1000"},
215 {"answers-slow", "dns_answer", "slow"},
216 {"chain-resends", "dns_question", "chained"},
217 {"client-parse-errors", "counter", "drops-client_parse_error"},
218 {"concurrent-queries", "dns_question", "concurrent"},
219 {"dlg-only-drops", "counter", "drops-delegation_only"},
220 {"negcache-entries", "cache_size", "negative"},
221 {"nsspeeds-entries", "gauge", "entries-ns_speeds"},
222 {"nsset-invalidations", "counter", "ns_set_invalidation"},
223 {"outgoing-timeouts", "counter", "drops-timeout_outgoing"},
224 {"resource-limits", "counter", "drops-resource_limit"},
225 {"server-parse-errors", "counter", "drops-server_parse_error"},
226 {"spoof-prevents", "counter", "drops-spoofed"},
227 {"tcp-client-overflow", "counter", "denied-client_overflow_tcp"},
228 {"tcp-outqueries", "dns_question", "outgoing-tcp"},
229 {"tcp-questions", "dns_question", "incoming-tcp"},
230 {"throttled-out", "dns_question", "outgoing-throttled"},
231 {"throttle-entries", "gauge", "entries-throttle"},
232 {"unauthorized-tcp", "counter", "denied-unauthorized_tcp"},
233 {"unauthorized-udp", "counter", "denied-unauthorized_udp"},
234 {"unexpected-packets", "dns_answer", "unexpected"}
235 /* {"uptime", "", ""} */
237 int lookup_table_length = STATIC_ARRAY_SIZE (lookup_table);
239 static llist_t *list = NULL;
241 #define PDNS_LOCAL_SOCKPATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-powerdns"
242 static char *local_sockpath = NULL;
244 /* TODO: Do this before 4.4:
246 * - Complete list of known pdns -> collectd mappings.
247 * - Update the collectd.conf(5) manpage.
252 /* <http://doc.powerdns.com/recursor-stats.html> */
253 static void submit (const char *plugin_instance, /* {{{ */
254 const char *pdns_type, const char *value)
256 value_list_t vl = VALUE_LIST_INIT;
259 const char *type = NULL;
260 const char *type_instance = NULL;
261 const data_set_t *ds;
265 for (i = 0; i < lookup_table_length; i++)
266 if (strcmp (lookup_table[i].name, pdns_type) == 0)
269 if (lookup_table[i].type == NULL)
272 if (i >= lookup_table_length)
274 DEBUG ("powerdns plugin: submit: Not found in lookup table: %s = %s;",
279 type = lookup_table[i].type;
280 type_instance = lookup_table[i].type_instance;
282 ds = plugin_get_ds (type);
285 ERROR ("powerdns plugin: The lookup table returned type `%s', "
286 "but I cannot find it via `plugin_get_ds'.",
293 ERROR ("powerdns plugin: type `%s' has %i data sources, "
294 "but I can only handle one.",
299 if (ds->ds[0].type == DS_TYPE_GAUGE)
303 values[0].gauge = strtod (value, &endptr);
307 ERROR ("powerdns plugin: Cannot convert `%s' "
308 "to a floating point number.", value);
316 values[0].counter = strtoll (value, &endptr, 0);
319 ERROR ("powerdns plugin: Cannot convert `%s' "
320 "to an integer number.", value);
327 vl.time = time (NULL);
328 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
329 sstrncpy (vl.plugin, "powerdns", sizeof (vl.plugin));
330 if (type_instance != NULL)
331 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
332 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
334 plugin_dispatch_values (type, &vl);
335 } /* }}} static void submit */
337 static int powerdns_get_data_dgram (list_item_t *item, /* {{{ */
339 size_t *ret_buffer_size)
346 size_t buffer_size = 0;
348 struct sockaddr_un sa_unix;
350 sd = socket (PF_UNIX, item->socktype, 0);
353 FUNC_ERROR ("socket");
357 memset (&sa_unix, 0, sizeof (sa_unix));
358 sa_unix.sun_family = AF_UNIX;
359 strncpy (sa_unix.sun_path,
360 (local_sockpath != NULL) ? local_sockpath : PDNS_LOCAL_SOCKPATH,
361 sizeof (sa_unix.sun_path));
362 sa_unix.sun_path[sizeof (sa_unix.sun_path) - 1] = 0;
364 status = unlink (sa_unix.sun_path);
365 if ((status != 0) && (errno != ENOENT))
367 FUNC_ERROR ("unlink");
374 /* We need to bind to a specific path, because this is a datagram socket
375 * and otherwise the daemon cannot answer. */
376 status = bind (sd, (struct sockaddr *) &sa_unix, sizeof (sa_unix));
383 /* Make the socket writeable by the daemon.. */
384 status = chmod (sa_unix.sun_path, 0666);
387 FUNC_ERROR ("chmod");
391 status = connect (sd, (struct sockaddr *) &item->sockaddr,
392 sizeof (item->sockaddr));
395 FUNC_ERROR ("connect");
399 status = send (sd, item->command, strlen (item->command), 0);
406 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
416 unlink (sa_unix.sun_path);
421 buffer_size = status + 1;
422 buffer = (char *) malloc (buffer_size);
425 FUNC_ERROR ("malloc");
429 memcpy (buffer, temp, status);
432 *ret_buffer = buffer;
433 *ret_buffer_size = buffer_size;
436 } /* }}} int powerdns_get_data_dgram */
438 static int powerdns_get_data_stream (list_item_t *item, /* {{{ */
440 size_t *ret_buffer_size)
447 size_t buffer_size = 0;
449 sd = socket (PF_UNIX, item->socktype, 0);
452 FUNC_ERROR ("socket");
456 status = connect (sd, (struct sockaddr *) &item->sockaddr,
457 sizeof (item->sockaddr));
460 FUNC_ERROR ("connect");
465 /* strlen + 1, because we need to send the terminating NULL byte, too. */
466 status = send (sd, item->command, strlen (item->command) + 1,
479 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
485 else if (status == 0)
488 buffer_new = (char *) realloc (buffer, buffer_size + status + 1);
489 if (buffer_new == NULL)
491 FUNC_ERROR ("realloc");
497 memcpy (buffer + buffer_size, temp, status);
498 buffer_size += status;
499 buffer[buffer_size] = 0;
510 assert (status == 0);
511 *ret_buffer = buffer;
512 *ret_buffer_size = buffer_size;
516 } /* }}} int powerdns_get_data_stream */
518 static int powerdns_get_data (list_item_t *item, char **ret_buffer,
519 size_t *ret_buffer_size)
521 if (item->socktype == SOCK_DGRAM)
522 return (powerdns_get_data_dgram (item, ret_buffer, ret_buffer_size));
523 else if (item->socktype == SOCK_STREAM)
524 return (powerdns_get_data_stream (item, ret_buffer, ret_buffer_size));
527 ERROR ("powerdns plugin: Unknown socket type: %i", (int) item->socktype);
530 } /* int powerdns_get_data */
532 static int powerdns_read_server (list_item_t *item) /* {{{ */
535 size_t buffer_size = 0;
544 const char* const *fields;
547 if (item->command == NULL)
548 item->command = strdup ("SHOW *");
549 if (item->command == NULL)
551 ERROR ("powerdns plugin: strdup failed.");
555 status = powerdns_get_data (item, &buffer, &buffer_size);
559 if (item->fields_num != 0)
561 fields = (const char* const *) item->fields;
562 fields_num = item->fields_num;
566 fields = default_server_fields;
567 fields_num = default_server_fields_num;
570 assert (fields != NULL);
571 assert (fields_num > 0);
573 /* 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, */
576 while ((key = strtok_r (dummy, ",", &saveptr)) != NULL)
582 value = strchr (key, '=');
589 if (value[0] == '\0')
592 /* Check if this item was requested. */
593 for (i = 0; i < fields_num; i++)
594 if (strcasecmp (key, fields[i]) == 0)
599 submit (item->instance, key, value);
600 } /* while (strtok_r) */
605 } /* }}} int powerdns_read_server */
608 * powerdns_update_recursor_command
610 * Creates a string that holds the command to be sent to the recursor. This
611 * string is stores in the `command' member of the `list_item_t' passed to the
612 * function. This function is called by `powerdns_read_recursor'.
614 static int powerdns_update_recursor_command (list_item_t *li) /* {{{ */
622 if (li->fields_num < 1)
624 sstrncpy (buffer, RECURSOR_COMMAND, sizeof (buffer));
628 strcpy (buffer, "get ");
629 status = strjoin (&buffer[4], sizeof (buffer) - strlen ("get "),
630 li->fields, li->fields_num,
631 /* seperator = */ " ");
634 ERROR ("powerdns plugin: strjoin failed.");
639 buffer[sizeof (buffer) - 1] = 0;
640 li->command = strdup (buffer);
641 if (li->command == NULL)
643 ERROR ("powerdns plugin: strdup failed.");
648 } /* }}} int powerdns_update_recursor_command */
650 static int powerdns_read_recursor (list_item_t *item) /* {{{ */
653 size_t buffer_size = 0;
664 if (item->command == NULL)
666 status = powerdns_update_recursor_command (item);
669 ERROR ("powerdns plugin: powerdns_update_recursor_command failed.");
673 assert (item->command != NULL);
675 status = powerdns_get_data (item, &buffer, &buffer_size);
679 keys_list = strdup (item->command);
680 if (keys_list == NULL)
682 FUNC_ERROR ("strdup");
688 value_saveptr = NULL;
690 /* Skip the `get' at the beginning */
691 strtok_r (keys_list, " \t", &key_saveptr);
694 while ((value = strtok_r (dummy, " \t\n\r", &value_saveptr)) != NULL)
698 key = strtok_r (NULL, " \t", &key_saveptr);
702 submit (item->instance, key, value);
703 } /* while (strtok_r) */
709 } /* }}} int powerdns_read_recursor */
711 static int powerdns_config_add_string (const char *name, /* {{{ */
715 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
717 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
723 *dest = strdup (ci->values[0].value.string);
728 } /* }}} int powerdns_config_add_string */
730 static int powerdns_config_add_collect (list_item_t *li, /* {{{ */
736 if (ci->values_num < 1)
738 WARNING ("powerdns plugin: The `Collect' option needs "
739 "at least one argument.");
743 for (i = 0; i < ci->values_num; i++)
744 if (ci->values[i].type != OCONFIG_TYPE_STRING)
746 WARNING ("powerdns plugin: Only string arguments are allowed to "
747 "the `Collect' option.");
751 temp = (char **) realloc (li->fields,
752 sizeof (char *) * (li->fields_num + ci->values_num));
755 WARNING ("powerdns plugin: realloc failed.");
760 for (i = 0; i < ci->values_num; i++)
762 li->fields[li->fields_num] = strdup (ci->values[i].value.string);
763 if (li->fields[li->fields_num] == NULL)
765 WARNING ("powerdns plugin: strdup failed.");
771 /* Invalidate a previously computed command */
775 } /* }}} int powerdns_config_add_collect */
777 static int powerdns_config_add_server (oconfig_item_t *ci) /* {{{ */
785 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
787 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
792 item = (list_item_t *) malloc (sizeof (list_item_t));
795 ERROR ("powerdns plugin: malloc failed.");
798 memset (item, '\0', sizeof (list_item_t));
800 item->instance = strdup (ci->values[0].value.string);
801 if (item->instance == NULL)
803 ERROR ("powerdns plugin: strdup failed.");
809 * Set default values for the members of list_item_t
811 if (strcasecmp ("Server", ci->key) == 0)
813 item->server_type = SRV_AUTHORATIVE;
814 item->func = powerdns_read_server;
815 item->socktype = SOCK_STREAM;
816 socket_temp = strdup (SERVER_SOCKET);
818 else if (strcasecmp ("Recursor", ci->key) == 0)
820 item->server_type = SRV_RECURSOR;
821 item->func = powerdns_read_recursor;
822 item->socktype = SOCK_DGRAM;
823 socket_temp = strdup (RECURSOR_SOCKET);
827 /* We must never get here.. */
833 for (i = 0; i < ci->children_num; i++)
835 oconfig_item_t *option = ci->children + i;
837 if (strcasecmp ("Collect", option->key) == 0)
838 status = powerdns_config_add_collect (item, option);
839 else if (strcasecmp ("Socket", option->key) == 0)
840 status = powerdns_config_add_string ("Socket", &socket_temp, option);
843 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
855 if (socket_temp == NULL)
857 ERROR ("powerdns plugin: socket_temp == NULL.");
862 if (item->command == NULL)
864 ERROR ("powerdns plugin: item->command == NULL.");
869 item->sockaddr.sun_family = AF_UNIX;
870 sstrncpy (item->sockaddr.sun_path, socket_temp, UNIX_PATH_MAX);
872 e = llentry_create (item->instance, item);
875 ERROR ("powerdns plugin: llentry_create failed.");
879 llist_append (list, e);
890 DEBUG ("powerdns plugin: Add server: instance = %s;", item->instance);
893 } /* }}} int powerdns_config_add_server */
895 static int powerdns_config (oconfig_item_t *ci) /* {{{ */
899 DEBUG ("powerdns plugin: powerdns_config (ci = %p);", (void *) ci);
903 list = llist_create ();
907 ERROR ("powerdns plugin: `llist_create' failed.");
912 for (i = 0; i < ci->children_num; i++)
914 oconfig_item_t *option = ci->children + i;
916 if ((strcasecmp ("Server", option->key) == 0)
917 || (strcasecmp ("Recursor", option->key) == 0))
918 powerdns_config_add_server (option);
919 if (strcasecmp ("LocalSocket", option->key) == 0)
921 char *temp = strdup (option->key);
924 sfree (local_sockpath);
925 local_sockpath = temp;
929 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
931 } /* for (i = 0; i < ci->children_num; i++) */
934 } /* }}} int powerdns_config */
936 static int powerdns_read (void)
940 for (e = llist_head (list); e != NULL; e = e->next)
942 list_item_t *item = e->value;
947 } /* static int powerdns_read */
949 static int powerdns_shutdown (void)
956 for (e = llist_head (list); e != NULL; e = e->next)
958 list_item_t *item = (list_item_t *) e->value;
961 sfree (item->instance);
962 sfree (item->command);
966 llist_destroy (list);
970 } /* static int powerdns_shutdown */
972 void module_register (void)
974 plugin_register_complex_config ("powerdns", powerdns_config);
975 plugin_register_read ("powerdns", powerdns_read);
976 plugin_register_shutdown ("powerdns", powerdns_shutdown );
977 } /* void module_register */
979 /* vim: set sw=2 sts=2 ts=8 fdm=marker : */