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 (ds->ds[0].type == DS_TYPE_GAUGE)
296 values[0].gauge = strtod (value, &endptr);
300 ERROR ("powerdns plugin: Cannot convert `%s' "
301 "to a floating point number.", value);
309 values[0].counter = strtoll (value, &endptr, 0);
312 ERROR ("powerdns plugin: Cannot convert `%s' "
313 "to an integer number.", value);
320 vl.time = time (NULL);
321 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
322 sstrncpy (vl.plugin, "powerdns", sizeof (vl.plugin));
323 if (type_instance != NULL)
324 sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
325 sstrncpy (vl.plugin_instance, plugin_instance, sizeof (vl.plugin_instance));
327 plugin_dispatch_values (type, &vl);
328 } /* }}} static void submit */
330 static int powerdns_get_data_dgram (list_item_t *item, /* {{{ */
332 size_t *ret_buffer_size)
339 size_t buffer_size = 0;
341 struct sockaddr_un sa_unix;
343 sd = socket (PF_UNIX, item->socktype, 0);
346 FUNC_ERROR ("socket");
350 memset (&sa_unix, 0, sizeof (sa_unix));
351 sa_unix.sun_family = AF_UNIX;
352 strncpy (sa_unix.sun_path,
353 (local_sockpath != NULL) ? local_sockpath : PDNS_LOCAL_SOCKPATH,
354 sizeof (sa_unix.sun_path));
355 sa_unix.sun_path[sizeof (sa_unix.sun_path) - 1] = 0;
357 status = unlink (sa_unix.sun_path);
358 if ((status != 0) && (errno != ENOENT))
360 FUNC_ERROR ("unlink");
367 /* We need to bind to a specific path, because this is a datagram socket
368 * and otherwise the daemon cannot answer. */
369 status = bind (sd, (struct sockaddr *) &sa_unix, sizeof (sa_unix));
376 /* Make the socket writeable by the daemon.. */
377 status = chmod (sa_unix.sun_path, 0666);
380 FUNC_ERROR ("chmod");
384 status = connect (sd, (struct sockaddr *) &item->sockaddr,
385 sizeof (item->sockaddr));
388 FUNC_ERROR ("connect");
392 status = send (sd, item->command, strlen (item->command), 0);
399 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
405 buffer_size = status + 1;
410 unlink (sa_unix.sun_path);
415 assert (buffer_size > 0);
416 buffer = (char *) malloc (buffer_size);
419 FUNC_ERROR ("malloc");
423 memcpy (buffer, temp, buffer_size - 1);
424 buffer[buffer_size - 1] = 0;
426 *ret_buffer = buffer;
427 *ret_buffer_size = buffer_size;
430 } /* }}} int powerdns_get_data_dgram */
432 static int powerdns_get_data_stream (list_item_t *item, /* {{{ */
434 size_t *ret_buffer_size)
441 size_t buffer_size = 0;
443 sd = socket (PF_UNIX, item->socktype, 0);
446 FUNC_ERROR ("socket");
450 status = connect (sd, (struct sockaddr *) &item->sockaddr,
451 sizeof (item->sockaddr));
454 FUNC_ERROR ("connect");
459 /* strlen + 1, because we need to send the terminating NULL byte, too. */
460 status = send (sd, item->command, strlen (item->command) + 1,
473 status = recv (sd, temp, sizeof (temp), /* flags = */ 0);
479 else if (status == 0)
482 buffer_new = (char *) realloc (buffer, buffer_size + status + 1);
483 if (buffer_new == NULL)
485 FUNC_ERROR ("realloc");
491 memcpy (buffer + buffer_size, temp, status);
492 buffer_size += status;
493 buffer[buffer_size] = 0;
504 assert (status == 0);
505 *ret_buffer = buffer;
506 *ret_buffer_size = buffer_size;
510 } /* }}} int powerdns_get_data_stream */
512 static int powerdns_get_data (list_item_t *item, char **ret_buffer,
513 size_t *ret_buffer_size)
515 if (item->socktype == SOCK_DGRAM)
516 return (powerdns_get_data_dgram (item, ret_buffer, ret_buffer_size));
517 else if (item->socktype == SOCK_STREAM)
518 return (powerdns_get_data_stream (item, ret_buffer, ret_buffer_size));
521 ERROR ("powerdns plugin: Unknown socket type: %i", (int) item->socktype);
524 } /* int powerdns_get_data */
526 static int powerdns_read_server (list_item_t *item) /* {{{ */
529 size_t buffer_size = 0;
538 const char* const *fields;
541 if (item->command == NULL)
542 item->command = strdup ("SHOW *");
543 if (item->command == NULL)
545 ERROR ("powerdns plugin: strdup failed.");
549 status = powerdns_get_data (item, &buffer, &buffer_size);
553 if (item->fields_num != 0)
555 fields = (const char* const *) item->fields;
556 fields_num = item->fields_num;
560 fields = default_server_fields;
561 fields_num = default_server_fields_num;
564 assert (fields != NULL);
565 assert (fields_num > 0);
567 /* 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, */
570 while ((key = strtok_r (dummy, ",", &saveptr)) != NULL)
576 value = strchr (key, '=');
583 if (value[0] == '\0')
586 /* Check if this item was requested. */
587 for (i = 0; i < fields_num; i++)
588 if (strcasecmp (key, fields[i]) == 0)
593 submit (item->instance, key, value);
594 } /* while (strtok_r) */
599 } /* }}} int powerdns_read_server */
602 * powerdns_update_recursor_command
604 * Creates a string that holds the command to be sent to the recursor. This
605 * string is stores in the `command' member of the `list_item_t' passed to the
606 * function. This function is called by `powerdns_read_recursor'.
608 static int powerdns_update_recursor_command (list_item_t *li) /* {{{ */
616 if (li->fields_num < 1)
618 sstrncpy (buffer, RECURSOR_COMMAND, sizeof (buffer));
622 sstrncpy (buffer, "get ", sizeof (buffer));
623 status = strjoin (&buffer[4], sizeof (buffer) - strlen ("get "),
624 li->fields, li->fields_num,
625 /* seperator = */ " ");
628 ERROR ("powerdns plugin: strjoin failed.");
633 buffer[sizeof (buffer) - 1] = 0;
634 li->command = strdup (buffer);
635 if (li->command == NULL)
637 ERROR ("powerdns plugin: strdup failed.");
642 } /* }}} int powerdns_update_recursor_command */
644 static int powerdns_read_recursor (list_item_t *item) /* {{{ */
647 size_t buffer_size = 0;
658 if (item->command == NULL)
660 status = powerdns_update_recursor_command (item);
663 ERROR ("powerdns plugin: powerdns_update_recursor_command failed.");
667 DEBUG ("powerdns plugin: powerdns_read_recursor: item->command = %s;",
670 assert (item->command != NULL);
672 status = powerdns_get_data (item, &buffer, &buffer_size);
675 ERROR ("powerdns plugin: powerdns_get_data failed.");
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_AUTHORITATIVE;
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 item->sockaddr.sun_family = AF_UNIX;
863 sstrncpy (item->sockaddr.sun_path, socket_temp, UNIX_PATH_MAX);
865 e = llentry_create (item->instance, item);
868 ERROR ("powerdns plugin: llentry_create failed.");
872 llist_append (list, e);
883 DEBUG ("powerdns plugin: Add server: instance = %s;", item->instance);
886 } /* }}} int powerdns_config_add_server */
888 static int powerdns_config (oconfig_item_t *ci) /* {{{ */
892 DEBUG ("powerdns plugin: powerdns_config (ci = %p);", (void *) ci);
896 list = llist_create ();
900 ERROR ("powerdns plugin: `llist_create' failed.");
905 for (i = 0; i < ci->children_num; i++)
907 oconfig_item_t *option = ci->children + i;
909 if ((strcasecmp ("Server", option->key) == 0)
910 || (strcasecmp ("Recursor", option->key) == 0))
911 powerdns_config_add_server (option);
912 else if (strcasecmp ("LocalSocket", option->key) == 0)
914 char *temp = strdup (option->key);
917 sfree (local_sockpath);
918 local_sockpath = temp;
922 ERROR ("powerdns plugin: Option `%s' not allowed here.", option->key);
924 } /* for (i = 0; i < ci->children_num; i++) */
927 } /* }}} int powerdns_config */
929 static int powerdns_read (void)
933 for (e = llist_head (list); e != NULL; e = e->next)
935 list_item_t *item = e->value;
940 } /* static int powerdns_read */
942 static int powerdns_shutdown (void)
949 for (e = llist_head (list); e != NULL; e = e->next)
951 list_item_t *item = (list_item_t *) e->value;
954 sfree (item->instance);
955 sfree (item->command);
959 llist_destroy (list);
963 } /* static int powerdns_shutdown */
965 void module_register (void)
967 plugin_register_complex_config ("powerdns", powerdns_config);
968 plugin_register_read ("powerdns", powerdns_read);
969 plugin_register_shutdown ("powerdns", powerdns_shutdown );
970 } /* void module_register */
972 /* vim: set sw=2 sts=2 ts=8 fdm=marker : */