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 LOCALSTATEDIR"/run/pdns.controlsocket"
49 #define SERVER_COMMAND "SHOW *"
51 #define RECURSOR_SOCKET LOCALSTATEDIR"/run/pdns_recursor.controlsocket"
52 #define RECURSOR_COMMAND "get noerror-answers nxdomain-answers " \
53 "servfail-answers sys-msec user-msec qa-latency cache-entries cache-hits " \
54 "cache-misses questions"
57 typedef struct list_item_s list_item_t;
66 int (*func) (list_item_t *item);
73 struct sockaddr_un sockaddr;
77 struct statname_lookup_s
83 typedef struct statname_lookup_s statname_lookup_t;
85 /* Description of statistics returned by the recursor: {{{
86 all-outqueries counts the number of outgoing UDP queries since starting
87 answers0-1 counts the number of queries answered within 1 milisecond
88 answers100-1000 counts the number of queries answered within 1 second
89 answers10-100 counts the number of queries answered within 100 miliseconds
90 answers1-10 counts the number of queries answered within 10 miliseconds
91 answers-slow counts the number of queries answered after 1 second
92 cache-entries shows the number of entries in the cache
93 cache-hits counts the number of cache hits since starting
94 cache-misses counts the number of cache misses since starting
95 chain-resends number of queries chained to existing outstanding query
96 client-parse-errors counts number of client packets that could not be parsed
97 concurrent-queries shows the number of MThreads currently running
98 dlg-only-drops number of records dropped because of delegation only setting
99 negcache-entries shows the number of entries in the Negative answer cache
100 noerror-answers counts the number of times it answered NOERROR since starting
101 nsspeeds-entries shows the number of entries in the NS speeds map
102 nsset-invalidations number of times an nsset was dropped because it no longer worked
103 nxdomain-answers counts the number of times it answered NXDOMAIN since starting
104 outgoing-timeouts counts the number of timeouts on outgoing UDP queries since starting
105 qa-latency shows the current latency average
106 questions counts all End-user initiated queries with the RD bit set
107 resource-limits counts number of queries that could not be performed because of resource limits
108 server-parse-errors counts number of server replied packets that could not be parsed
109 servfail-answers counts the number of times it answered SERVFAIL since starting
110 spoof-prevents number of times PowerDNS considered itself spoofed, and dropped the data
111 sys-msec number of CPU milliseconds spent in 'system' mode
112 tcp-client-overflow number of times an IP address was denied TCP access because it already had too many connections
113 tcp-outqueries counts the number of outgoing TCP queries since starting
114 tcp-questions counts all incoming TCP queries (since starting)
115 throttled-out counts the number of throttled outgoing UDP queries since starting
116 throttle-entries shows the number of entries in the throttle map
117 unauthorized-tcp number of TCP questions denied because of allow-from restrictions
118 unauthorized-udp number of UDP questions denied because of allow-from restrictions
119 unexpected-packets number of answers from remote servers that were unexpected (might point to spoofing)
120 uptime number of seconds process has been running (since 3.1.5)
121 user-msec number of CPU milliseconds spent in 'user' mode
124 const char* const default_server_fields[] = /* {{{ */
133 "recursing-questions",
139 int default_server_fields_num = STATIC_ARRAY_SIZE (default_server_fields);
141 statname_lookup_t lookup_table[] = /* {{{ */
143 /*********************
144 * Server statistics *
145 *********************/
147 {"recursing-questions", "dns_question", "recurse"},
148 {"tcp-queries", "dns_question", "tcp"},
149 {"udp-queries", "dns_question", "udp"},
152 {"recursing-answers", "dns_answer", "recurse"},
153 {"tcp-answers", "dns_answer", "tcp"},
154 {"udp-answers", "dns_answer", "udp"},
157 {"packetcache-hit", "cache_result", "packet-hit"},
158 {"packetcache-miss", "cache_result", "packet-miss"},
159 {"packetcache-size", "cache_size", "packet"},
160 {"query-cache-hit", "cache_result", "query-hit"},
161 {"query-cache-miss", "cache_result", "query-miss"},
164 {"latency", "latency", NULL},
167 {"corrupt-packets", "io_packets", "corrupt"},
168 {"deferred-cache-inserts", "counter", "cache-deferred_insert"},
169 {"deferred-cache-lookup", "counter", "cache-deferred_lookup"},
170 {"qsize-a", "cache_size", "answers"},
171 {"qsize-q", "cache_size", "questions"},
172 {"servfail-packets", "io_packets", "servfail"},
173 {"timedout-packets", "io_packets", "timeout"},
174 {"udp4-answers", "dns_answer", "udp4"},
175 {"udp4-queries", "dns_question", "queries-udp4"},
176 {"udp6-answers", "dns_answer", "udp6"},
177 {"udp6-queries", "dns_question", "queries-udp6"},
179 /***********************
180 * Recursor statistics *
181 ***********************/
182 /* Answers by return code */
183 {"noerror-answers", "dns_rcode", "NOERROR"},
184 {"nxdomain-answers", "dns_rcode", "NXDOMAIN"},
185 {"servfail-answers", "dns_rcode", "SERVFAIL"},
187 /* CPU utilization */
188 {"sys-msec", "cpu", "system"},
189 {"user-msec", "cpu", "user"},
191 /* Question-to-answer latency */
192 {"qa-latency", "latency", NULL},
195 {"cache-entries", "cache_size", NULL},
196 {"cache-hits", "cache_result", "hit"},
197 {"cache-misses", "cache_result", "miss"},
199 /* Total number of questions.. */
200 {"questions", "dns_qtype", "total"},
202 /* All the other stuff.. */
203 {"all-outqueries", "dns_question", "outgoing"},
204 {"answers0-1", "dns_answer", "0_1"},
205 {"answers1-10", "dns_answer", "1_10"},
206 {"answers10-100", "dns_answer", "10_100"},
207 {"answers100-1000", "dns_answer", "100_1000"},
208 {"answers-slow", "dns_answer", "slow"},
209 {"chain-resends", "dns_question", "chained"},
210 {"client-parse-errors", "counter", "drops-client_parse_error"},
211 {"concurrent-queries", "dns_question", "concurrent"},
212 {"dlg-only-drops", "counter", "drops-delegation_only"},
213 {"negcache-entries", "cache_size", "negative"},
214 {"nsspeeds-entries", "gauge", "entries-ns_speeds"},
215 {"nsset-invalidations", "counter", "ns_set_invalidation"},
216 {"outgoing-timeouts", "counter", "drops-timeout_outgoing"},
217 {"resource-limits", "counter", "drops-resource_limit"},
218 {"server-parse-errors", "counter", "drops-server_parse_error"},
219 {"spoof-prevents", "counter", "drops-spoofed"},
220 {"tcp-client-overflow", "counter", "denied-client_overflow_tcp"},
221 {"tcp-outqueries", "dns_question", "outgoing-tcp"},
222 {"tcp-questions", "dns_question", "incoming-tcp"},
223 {"throttled-out", "dns_question", "outgoing-throttled"},
224 {"throttle-entries", "gauge", "entries-throttle"},
225 {"unauthorized-tcp", "counter", "denied-unauthorized_tcp"},
226 {"unauthorized-udp", "counter", "denied-unauthorized_udp"},
227 {"unexpected-packets", "dns_answer", "unexpected"}
228 /* {"uptime", "", ""} */
230 int lookup_table_length = STATIC_ARRAY_SIZE (lookup_table);
232 static llist_t *list = NULL;
234 #define PDNS_LOCAL_SOCKPATH LOCALSTATEDIR"/run/"PACKAGE_NAME"-powerdns"
235 static char *local_sockpath = NULL;
237 /* TODO: Do this before 4.4:
239 * - Complete list of known pdns -> collectd mappings.
240 * - Update the collectd.conf(5) manpage.
245 /* <http://doc.powerdns.com/recursor-stats.html> */
246 static void submit (const char *plugin_instance, /* {{{ */
247 const char *pdns_type, const char *value)
249 value_list_t vl = VALUE_LIST_INIT;
252 const char *type = NULL;
253 const char *type_instance = NULL;
254 const data_set_t *ds;
258 for (i = 0; i < lookup_table_length; i++)
259 if (strcmp (lookup_table[i].name, pdns_type) == 0)
262 if (lookup_table[i].type == NULL)
265 if (i >= lookup_table_length)
267 INFO ("powerdns plugin: submit: Not found in lookup table: %s = %s;",
272 type = lookup_table[i].type;
273 type_instance = lookup_table[i].type_instance;
275 ds = plugin_get_ds (type);
278 ERROR ("powerdns plugin: The lookup table returned type `%s', "
279 "but I cannot find it via `plugin_get_ds'.",
286 ERROR ("powerdns plugin: type `%s' has %i data sources, "
287 "but I can only handle one.",
292 if (0 != parse_value (value, &values[0], ds->ds[0]))
294 ERROR ("powerdns plugin: Cannot convert `%s' "
295 "to a number.", value);
301 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
302 sstrncpy (vl.plugin, "powerdns", sizeof (vl.plugin));
303 sstrncpy (vl.type, type, sizeof (vl.type));
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 (&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 sstrncpy (sa_unix.sun_path,
334 (local_sockpath != NULL) ? local_sockpath : PDNS_LOCAL_SOCKPATH,
335 sizeof (sa_unix.sun_path));
337 status = unlink (sa_unix.sun_path);
338 if ((status != 0) && (errno != ENOENT))
340 FUNC_ERROR ("unlink");
347 /* We need to bind to a specific path, because this is a datagram socket
348 * and otherwise the daemon cannot answer. */
349 status = bind (sd, (struct sockaddr *) &sa_unix, sizeof (sa_unix));
356 /* Make the socket writeable by the daemon.. */
357 status = chmod (sa_unix.sun_path, 0666);
360 FUNC_ERROR ("chmod");
364 status = connect (sd, (struct sockaddr *) &item->sockaddr,
365 sizeof (item->sockaddr));
368 FUNC_ERROR ("connect");
372 status = send (sd, item->command, strlen (item->command), 0);
379 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
385 buffer_size = status + 1;
390 unlink (sa_unix.sun_path);
395 assert (buffer_size > 0);
396 buffer = (char *) malloc (buffer_size);
399 FUNC_ERROR ("malloc");
403 memcpy (buffer, temp, buffer_size - 1);
404 buffer[buffer_size - 1] = 0;
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 sstrncpy (buffer, "get ", sizeof (buffer));
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 DEBUG ("powerdns plugin: powerdns_read_recursor: item->command = %s;",
650 assert (item->command != NULL);
652 status = powerdns_get_data (item, &buffer, &buffer_size);
655 ERROR ("powerdns plugin: powerdns_get_data failed.");
659 keys_list = strdup (item->command);
660 if (keys_list == NULL)
662 FUNC_ERROR ("strdup");
668 value_saveptr = NULL;
670 /* Skip the `get' at the beginning */
671 strtok_r (keys_list, " \t", &key_saveptr);
674 while ((value = strtok_r (dummy, " \t\n\r", &value_saveptr)) != NULL)
678 key = strtok_r (NULL, " \t", &key_saveptr);
682 submit (item->instance, key, value);
683 } /* while (strtok_r) */
689 } /* }}} int powerdns_read_recursor */
691 static int powerdns_config_add_string (const char *name, /* {{{ */
695 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
697 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
703 *dest = strdup (ci->values[0].value.string);
708 } /* }}} int powerdns_config_add_string */
710 static int powerdns_config_add_collect (list_item_t *li, /* {{{ */
716 if (ci->values_num < 1)
718 WARNING ("powerdns plugin: The `Collect' option needs "
719 "at least one argument.");
723 for (i = 0; i < ci->values_num; i++)
724 if (ci->values[i].type != OCONFIG_TYPE_STRING)
726 WARNING ("powerdns plugin: Only string arguments are allowed to "
727 "the `Collect' option.");
731 temp = (char **) realloc (li->fields,
732 sizeof (char *) * (li->fields_num + ci->values_num));
735 WARNING ("powerdns plugin: realloc failed.");
740 for (i = 0; i < ci->values_num; i++)
742 li->fields[li->fields_num] = strdup (ci->values[i].value.string);
743 if (li->fields[li->fields_num] == NULL)
745 WARNING ("powerdns plugin: strdup failed.");
751 /* Invalidate a previously computed command */
755 } /* }}} int powerdns_config_add_collect */
757 static int powerdns_config_add_server (oconfig_item_t *ci) /* {{{ */
765 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
767 WARNING ("powerdns plugin: `%s' needs exactly one string argument.",
772 item = (list_item_t *) malloc (sizeof (list_item_t));
775 ERROR ("powerdns plugin: malloc failed.");
778 memset (item, '\0', sizeof (list_item_t));
780 item->instance = strdup (ci->values[0].value.string);
781 if (item->instance == NULL)
783 ERROR ("powerdns plugin: strdup failed.");
789 * Set default values for the members of list_item_t
791 if (strcasecmp ("Server", ci->key) == 0)
793 item->server_type = SRV_AUTHORITATIVE;
794 item->func = powerdns_read_server;
795 item->socktype = SOCK_STREAM;
796 socket_temp = strdup (SERVER_SOCKET);
798 else if (strcasecmp ("Recursor", ci->key) == 0)
800 item->server_type = SRV_RECURSOR;
801 item->func = powerdns_read_recursor;
802 item->socktype = SOCK_DGRAM;
803 socket_temp = strdup (RECURSOR_SOCKET);
807 /* We must never get here.. */
813 for (i = 0; i < ci->children_num; i++)
815 oconfig_item_t *option = ci->children + i;
817 if (strcasecmp ("Collect", option->key) == 0)
818 status = powerdns_config_add_collect (item, option);
819 else if (strcasecmp ("Socket", option->key) == 0)
820 status = powerdns_config_add_string ("Socket", &socket_temp, option);
823 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
835 if (socket_temp == NULL)
837 ERROR ("powerdns plugin: socket_temp == NULL.");
842 item->sockaddr.sun_family = AF_UNIX;
843 sstrncpy (item->sockaddr.sun_path, socket_temp,
844 sizeof (item->sockaddr.sun_path));
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 else 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 : */