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;
68 int (*func) (list_item_t *item);
71 struct sockaddr_un sockaddr;
75 struct statname_lookup_s
81 typedef struct statname_lookup_s statname_lookup_t;
83 /* Description of statistics returned by the recursor: {{{
84 all-outqueries counts the number of outgoing UDP queries since starting
85 answers0-1 counts the number of queries answered within 1 milisecond
86 answers100-1000 counts the number of queries answered within 1 second
87 answers10-100 counts the number of queries answered within 100 miliseconds
88 answers1-10 counts the number of queries answered within 10 miliseconds
89 answers-slow counts the number of queries answered after 1 second
90 cache-entries shows the number of entries in the cache
91 cache-hits counts the number of cache hits since starting
92 cache-misses counts the number of cache misses since starting
93 chain-resends number of queries chained to existing outstanding query
94 client-parse-errors counts number of client packets that could not be parsed
95 concurrent-queries shows the number of MThreads currently running
96 dlg-only-drops number of records dropped because of delegation only setting
97 negcache-entries shows the number of entries in the Negative answer cache
98 noerror-answers counts the number of times it answered NOERROR since starting
99 nsspeeds-entries shows the number of entries in the NS speeds map
100 nsset-invalidations number of times an nsset was dropped because it no longer worked
101 nxdomain-answers counts the number of times it answered NXDOMAIN since starting
102 outgoing-timeouts counts the number of timeouts on outgoing UDP queries since starting
103 qa-latency shows the current latency average
104 questions counts all End-user initiated queries with the RD bit set
105 resource-limits counts number of queries that could not be performed because of resource limits
106 server-parse-errors counts number of server replied packets that could not be parsed
107 servfail-answers counts the number of times it answered SERVFAIL since starting
108 spoof-prevents number of times PowerDNS considered itself spoofed, and dropped the data
109 sys-msec number of CPU milliseconds spent in 'system' mode
110 tcp-client-overflow number of times an IP address was denied TCP access because it already had too many connections
111 tcp-outqueries counts the number of outgoing TCP queries since starting
112 tcp-questions counts all incoming TCP queries (since starting)
113 throttled-out counts the number of throttled outgoing UDP queries since starting
114 throttle-entries shows the number of entries in the throttle map
115 unauthorized-tcp number of TCP questions denied because of allow-from restrictions
116 unauthorized-udp number of UDP questions denied because of allow-from restrictions
117 unexpected-packets number of answers from remote servers that were unexpected (might point to spoofing)
118 uptime number of seconds process has been running (since 3.1.5)
119 user-msec number of CPU milliseconds spent in 'user' mode
122 statname_lookup_t lookup_table[] = /* {{{ */
124 /*********************
125 * Server statistics *
126 *********************/
128 {"recursing-questions", "dns_question", "recurse"},
129 {"tcp-queries", "dns_question", "tcp"},
130 {"udp-queries", "dns_question", "udp"},
133 {"recursing-answers", "dns_answer", "recurse"},
134 {"tcp-answers", "dns_answer", "tcp"},
135 {"udp-answers", "dns_answer", "udp"},
138 {"packetcache-hit", "cache_result", "packet-hit"},
139 {"packetcache-miss", "cache_result", "packet-miss"},
140 {"packetcache-size", "cache_size", "packet"},
141 {"query-cache-hit", "cache_result", "query-hit"},
142 {"query-cache-miss", "cache_result", "query-miss"},
145 {"latency", "latency", NULL},
148 {"corrupt-packets", "io_packets", "corrupt"},
149 {"deferred-cache-inserts", "counter", "cache-deferred_insert"},
150 {"deferred-cache-lookup", "counter", "cache-deferred_lookup"},
151 {"qsize-a", "cache_size", "answers"},
152 {"qsize-q", "cache_size", "questions"},
153 {"servfail-packets", "io_packets", "servfail"},
154 {"timedout-packets", "io_packets", "timeout"},
155 {"udp4-answers", "dns_answer", "udp4"},
156 {"udp4-queries", "dns_question", "queries-udp4"},
157 {"udp6-answers", "dns_answer", "udp6"},
158 {"udp6-queries", "dns_question", "queries-udp6"},
160 /***********************
161 * Recursor statistics *
162 ***********************/
163 /* Answers by return code */
164 {"noerror-answers", "dns_rcode", "NOERROR"},
165 {"nxdomain-answers", "dns_rcode", "NXDOMAIN"},
166 {"servfail-answers", "dns_rcode", "SERVFAIL"},
168 /* CPU utilization */
169 {"sys-msec", "cpu", "system"},
170 {"user-msec", "cpu", "user"},
172 /* Question-to-answer latency */
173 {"qa-latency", "latency", NULL},
176 {"cache-entries", "cache_size", NULL},
177 {"cache-hits", "cache_result", "hit"},
178 {"cache-misses", "cache_result", "miss"},
180 /* Total number of questions.. */
181 {"questions", "dns_qtype", "total"},
183 /* All the other stuff.. */
184 {"all-outqueries", "dns_question", "outgoing"},
185 {"answers0-1", "dns_answer", "0_1"},
186 {"answers1-10", "dns_answer", "1_10"},
187 {"answers10-100", "dns_answer", "10_100"},
188 {"answers100-1000", "dns_answer", "100_1000"},
189 {"answers-slow", "dns_answer", "slow"},
190 {"chain-resends", "dns_question", "chained"},
191 {"client-parse-errors", "counter", "drops-client_parse_error"},
192 {"concurrent-queries", "dns_question", "concurrent"},
193 {"dlg-only-drops", "counter", "drops-delegation_only"},
194 {"negcache-entries", "cache_size", "negative"},
195 {"nsspeeds-entries", "gauge", "entries-ns_speeds"},
196 {"nsset-invalidations", "counter", "ns_set_invalidation"},
197 {"outgoing-timeouts", "counter", "drops-timeout_outgoing"},
198 {"resource-limits", "counter", "drops-resource_limit"},
199 {"server-parse-errors", "counter", "drops-server_parse_error"},
200 {"spoof-prevents", "counter", "drops-spoofed"},
201 {"tcp-client-overflow", "counter", "denied-client_overflow_tcp"},
202 {"tcp-outqueries", "dns_question", "outgoing-tcp"},
203 {"tcp-questions", "dns_question", "incoming-tcp"},
204 {"throttled-out", "dns_question", "outgoing-throttled"},
205 {"throttle-entries", "gauge", "entries-throttle"},
206 {"unauthorized-tcp", "counter", "denied-unauthorized_tcp"},
207 {"unauthorized-udp", "counter", "denied-unauthorized_udp"},
208 {"unexpected-packets", "dns_answer", "unexpected"}
209 /* {"uptime", "", ""} */
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:
219 * - Make list of ``interesting values'' configurable
220 * - Authorative server:
221 * - Store each element in a list or an array
222 * - Check values returned by `SHOW *' against that list.
224 * - Use the list to build a command to request the given values
225 * - Complete list of known pdns -> collectd mappings.
230 /* <http://doc.powerdns.com/recursor-stats.html> */
231 static void submit (const char *plugin_instance, /* {{{ */
232 const char *pdns_type, const char *value)
234 value_list_t vl = VALUE_LIST_INIT;
237 const char *type = NULL;
238 const char *type_instance = NULL;
239 const data_set_t *ds;
243 for (i = 0; i < lookup_table_length; i++)
244 if (strcmp (lookup_table[i].name, pdns_type) == 0)
247 if (lookup_table[i].type == NULL)
250 if (i >= lookup_table_length)
252 DEBUG ("powerdns plugin: submit: Not found in lookup table: %s = %s;",
257 type = lookup_table[i].type;
258 type_instance = lookup_table[i].type_instance;
260 ds = plugin_get_ds (type);
263 ERROR ("powerdns plugin: The lookup table returned type `%s', "
264 "but I cannot find it via `plugin_get_ds'.",
271 ERROR ("powerdns plugin: type `%s' has %i data sources, "
272 "but I can only handle one.",
277 if (ds->ds[0].type == DS_TYPE_GAUGE)
281 values[0].gauge = strtod (value, &endptr);
285 ERROR ("powerdns plugin: Cannot convert `%s' "
286 "to a floating point number.", value);
294 values[0].counter = strtoll (value, &endptr, 0);
297 ERROR ("powerdns plugin: Cannot convert `%s' "
298 "to an integer number.", value);
305 vl.time = time (NULL);
306 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
307 sstrncpy (vl.plugin, "powerdns", sizeof (vl.plugin));
308 if (type_instance != NULL)
309 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
310 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
312 plugin_dispatch_values (type, &vl);
313 } /* }}} static void submit */
315 static int powerdns_get_data_dgram (list_item_t *item, /* {{{ */
317 size_t *ret_buffer_size)
324 size_t buffer_size = 0;
326 struct sockaddr_un sa_unix;
328 sd = socket (PF_UNIX, item->socktype, 0);
331 FUNC_ERROR ("socket");
335 memset (&sa_unix, 0, sizeof (sa_unix));
336 sa_unix.sun_family = AF_UNIX;
337 strncpy (sa_unix.sun_path,
338 (local_sockpath != NULL) ? local_sockpath : PDNS_LOCAL_SOCKPATH,
339 sizeof (sa_unix.sun_path));
340 sa_unix.sun_path[sizeof (sa_unix.sun_path) - 1] = 0;
342 status = unlink (sa_unix.sun_path);
343 if ((status != 0) && (errno != ENOENT))
345 FUNC_ERROR ("unlink");
352 /* We need to bind to a specific path, because this is a datagram socket
353 * and otherwise the daemon cannot answer. */
354 status = bind (sd, (struct sockaddr *) &sa_unix, sizeof (sa_unix));
361 /* Make the socket writeable by the daemon.. */
362 status = chmod (sa_unix.sun_path, 0666);
365 FUNC_ERROR ("chmod");
369 status = connect (sd, (struct sockaddr *) &item->sockaddr,
370 sizeof (item->sockaddr));
373 FUNC_ERROR ("connect");
377 status = send (sd, item->command, strlen (item->command), 0);
384 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
394 unlink (sa_unix.sun_path);
399 buffer_size = status + 1;
400 buffer = (char *) malloc (buffer_size);
403 FUNC_ERROR ("malloc");
407 memcpy (buffer, temp, status);
410 *ret_buffer = buffer;
411 *ret_buffer_size = buffer_size;
414 } /* }}} int powerdns_get_data_dgram */
416 static int powerdns_get_data_stream (list_item_t *item, /* {{{ */
418 size_t *ret_buffer_size)
425 size_t buffer_size = 0;
427 sd = socket (PF_UNIX, item->socktype, 0);
430 FUNC_ERROR ("socket");
434 status = connect (sd, (struct sockaddr *) &item->sockaddr,
435 sizeof (item->sockaddr));
438 FUNC_ERROR ("connect");
443 /* strlen + 1, because we need to send the terminating NULL byte, too. */
444 status = send (sd, item->command, strlen (item->command) + 1,
457 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
463 else if (status == 0)
466 buffer_new = (char *) realloc (buffer, buffer_size + status + 1);
467 if (buffer_new == NULL)
469 FUNC_ERROR ("realloc");
475 memcpy (buffer + buffer_size, temp, status);
476 buffer_size += status;
477 buffer[buffer_size] = 0;
488 assert (status == 0);
489 *ret_buffer = buffer;
490 *ret_buffer_size = buffer_size;
494 } /* }}} int powerdns_get_data_stream */
496 static int powerdns_get_data (list_item_t *item, char **ret_buffer,
497 size_t *ret_buffer_size)
499 if (item->socktype == SOCK_DGRAM)
500 return (powerdns_get_data_dgram (item, ret_buffer, ret_buffer_size));
501 else if (item->socktype == SOCK_STREAM)
502 return (powerdns_get_data_stream (item, ret_buffer, ret_buffer_size));
505 ERROR ("powerdns plugin: Unknown socket type: %i", (int) item->socktype);
508 } /* int powerdns_get_data */
510 static int powerdns_read_server (list_item_t *item) /* {{{ */
513 size_t buffer_size = 0;
522 status = powerdns_get_data (item, &buffer, &buffer_size);
526 /* 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, */
529 while ((key = strtok_r (dummy, ",", &saveptr)) != NULL)
533 value = strchr (key, '=');
540 if (value[0] == '\0')
543 submit (item->instance, key, value);
544 } /* while (strtok_r) */
549 } /* }}} int powerdns_read_server */
551 static int powerdns_read_recursor (list_item_t *item) /* {{{ */
554 size_t buffer_size = 0;
565 status = powerdns_get_data (item, &buffer, &buffer_size);
569 keys_list = strdup (item->command);
570 if (keys_list == NULL)
572 FUNC_ERROR ("strdup");
578 value_saveptr = NULL;
580 /* Skip the `get' at the beginning */
581 strtok_r (keys_list, " \t", &key_saveptr);
584 while ((value = strtok_r (dummy, " \t\n\r", &value_saveptr)) != NULL)
588 key = strtok_r (NULL, " \t", &key_saveptr);
592 submit (item->instance, key, value);
593 } /* while (strtok_r) */
599 } /* }}} int powerdns_read_recursor */
601 static int powerdns_config_add_string (const char *name, /* {{{ */
605 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
607 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
613 *dest = strdup (ci->values[0].value.string);
618 } /* }}} int ctail_config_add_string */
620 static int powerdns_config_add_server (oconfig_item_t *ci) /* {{{ */
628 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
630 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
635 item = (list_item_t *) malloc (sizeof (list_item_t));
638 ERROR ("powerdns plugin: malloc failed.");
641 memset (item, '\0', sizeof (list_item_t));
643 item->instance = strdup (ci->values[0].value.string);
644 if (item->instance == NULL)
646 ERROR ("powerdns plugin: strdup failed.");
652 * Set default values for the members of list_item_t
654 if (strcasecmp ("Server", ci->key) == 0)
656 item->func = powerdns_read_server;
657 item->command = strdup (SERVER_COMMAND);
658 item->socktype = SOCK_STREAM;
659 socket_temp = strdup (SERVER_SOCKET);
661 else if (strcasecmp ("Recursor", ci->key) == 0)
663 item->func = powerdns_read_recursor;
664 item->command = strdup (RECURSOR_COMMAND);
665 item->socktype = SOCK_DGRAM;
666 socket_temp = strdup (RECURSOR_SOCKET);
670 for (i = 0; i < ci->children_num; i++)
672 oconfig_item_t *option = ci->children + i;
674 if (strcasecmp ("Command", option->key) == 0)
675 status = powerdns_config_add_string ("Command", &item->command, option);
676 else if (strcasecmp ("Socket", option->key) == 0)
677 status = powerdns_config_add_string ("Socket", &socket_temp, option);
680 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
692 if (socket_temp == NULL)
694 ERROR ("powerdns plugin: socket_temp == NULL.");
699 if (item->command == NULL)
701 ERROR ("powerdns plugin: item->command == NULL.");
706 item->sockaddr.sun_family = AF_UNIX;
707 sstrncpy (item->sockaddr.sun_path, socket_temp, UNIX_PATH_MAX);
709 e = llentry_create (item->instance, item);
712 ERROR ("powerdns plugin: llentry_create failed.");
716 llist_append (list, e);
727 DEBUG ("powerdns plugin: Add server: instance = %s;", item->instance);
730 } /* }}} int powerdns_config_add_server */
732 static int powerdns_config (oconfig_item_t *ci) /* {{{ */
736 DEBUG ("powerdns plugin: powerdns_config (ci = %p);", (void *) ci);
740 list = llist_create ();
744 ERROR ("powerdns plugin: `llist_create' failed.");
749 for (i = 0; i < ci->children_num; i++)
751 oconfig_item_t *option = ci->children + i;
753 if ((strcasecmp ("Server", option->key) == 0)
754 || (strcasecmp ("Recursor", option->key) == 0))
755 powerdns_config_add_server (option);
756 if (strcasecmp ("LocalSocket", option->key) == 0)
758 char *temp = strdup (option->key);
761 sfree (local_sockpath);
762 local_sockpath = temp;
766 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
768 } /* for (i = 0; i < ci->children_num; i++) */
771 } /* }}} int powerdns_config */
773 static int powerdns_read (void)
777 for (e = llist_head (list); e != NULL; e = e->next)
779 list_item_t *item = e->value;
784 } /* static int powerdns_read */
786 static int powerdns_shutdown (void)
793 for (e = llist_head (list); e != NULL; e = e->next)
795 list_item_t *item = (list_item_t *) e->value;
798 sfree (item->instance);
799 sfree (item->command);
803 llist_destroy (list);
807 } /* static int powerdns_shutdown */
809 void module_register (void)
811 plugin_register_complex_config ("powerdns", powerdns_config);
812 plugin_register_read ("powerdns", powerdns_read);
813 plugin_register_shutdown ("powerdns", powerdns_shutdown );
814 } /* void module_register */
816 /* vim: set sw=2 sts=2 ts=8 fdm=marker : */