2 * collectd - src/bind.c
3 * Copyright (C) 2009 Bruno Prémont
4 * Copyright (C) 2009 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 * Bruno Prémont <bonbons at linux-vserver.org>
21 * Florian Forster <octo at verplant.org>
24 /* Set to C99 and POSIX code */
25 #ifndef _ISOC99_SOURCE
26 # define _ISOC99_SOURCE
29 # define _POSIX_SOURCE
31 #ifndef _POSIX_C_SOURCE
32 # define _POSIX_C_SOURCE 200112L
38 # define _XOPEN_SOURCE 600
47 #include "configfile.h"
49 #include <curl/curl.h>
50 #include <libxml/parser.h>
51 #include <libxml/xpath.h>
53 #ifndef BIND_DEFAULT_URL
54 # define BIND_DEFAULT_URL "http://localhost:8053/"
58 * Some types used for the callback functions. `translation_table_ptr_t' and
59 * `list_info_ptr_t' are passed to the callbacks in the `void *user_data'
62 typedef int (*list_callback_t) (const char *name, counter_t value,
63 time_t current_time, void *user_data);
76 typedef struct cb_view_s cb_view_t;
78 struct translation_info_s
82 const char *type_instance;
84 typedef struct translation_info_s translation_info_t;
86 struct translation_table_ptr_s
88 const translation_info_t *table;
90 const char *plugin_instance;
92 typedef struct translation_table_ptr_s translation_table_ptr_t;
94 struct list_info_ptr_s
96 const char *plugin_instance;
99 typedef struct list_info_ptr_s list_info_ptr_t;
101 static char *url = NULL;
102 static int global_opcodes = 1;
103 static int global_qtypes = 1;
104 static int global_server_stats = 1;
105 static int global_zone_maint_stats = 1;
106 static int global_resolver_stats = 0;
107 static int global_memory_stats = 1;
109 static cb_view_t *views = NULL;
110 static size_t views_num = 0;
112 static CURL *curl = NULL;
114 static char *bind_buffer = NULL;
115 static size_t bind_buffer_size = 0;
116 static size_t bind_buffer_fill = 0;
117 static char bind_curl_error[CURL_ERROR_SIZE];
119 /* Translation table for the `nsstats' values. */
120 static const translation_info_t nsstats_translation_table[] = /* {{{ */
123 { "Requestv4", "dns_request", "IPv4" },
124 { "Requestv6", "dns_request", "IPv6" },
125 { "ReqEdns0", "dns_request", "EDNS0" },
126 { "ReqBadEDNSVer", "dns_request", "BadEDNSVer" },
127 { "ReqTSIG", "dns_request", "TSIG" },
128 { "ReqSIG0", "dns_request", "SIG0" },
129 { "ReqBadSIG", "dns_request", "BadSIG" },
130 { "ReqTCP", "dns_request", "TCP" },
132 { "AuthQryRej", "dns_reject", "authorative" },
133 { "RecQryRej", "dns_reject", "recursive" },
134 { "XfrRej", "dns_reject", "transer" },
135 { "UpdateRej", "dns_reject", "update" },
137 { "Response", "dns_response", "normal" },
138 { "TruncatedResp", "dns_response", "truncated" },
139 { "RespEDNS0", "dns_response", "EDNS0" },
140 { "RespTSIG", "dns_response", "TSIG" },
141 { "RespSIG0", "dns_response", "SIG0" },
143 { "QryAuthAns", "dns_query", "authorative" },
144 { "QryNoauthAns", "dns_query", "nonauth" },
145 { "QryReferral", "dns_query", "referral" },
146 { "QryRecursion", "dns_query", "recursion" },
147 { "QryDuplicate", "dns_query", "dupliate" },
148 { "QryDropped", "dns_query", "dropped" },
149 { "QryFailure", "dns_query", "failure" },
151 { "QrySuccess", "dns_rcode", "tx-NOERROR" },
152 { "QryNxrrset", "dns_rcode", "tx-NXRRSET" },
153 { "QrySERVFAIL", "dns_rcode", "tx-SERVFAIL" },
154 { "QryFORMERR", "dns_rcode", "tx-FORMERR" },
155 { "QryNXDOMAIN", "dns_rcode", "tx-NXDOMAIN" }
157 { "XfrReqDone", "type", "type_instance" },
158 { "UpdateReqFwd", "type", "type_instance" },
159 { "UpdateRespFwd", "type", "type_instance" },
160 { "UpdateFwdFail", "type", "type_instance" },
161 { "UpdateDone", "type", "type_instance" },
162 { "UpdateFail", "type", "type_instance" },
163 { "UpdateBadPrereq", "type", "type_instance" },
166 static int nsstats_translation_table_length =
167 STATIC_ARRAY_SIZE (nsstats_translation_table);
170 /* Translation table for the `zonestats' values. */
171 static const translation_info_t zonestats_translation_table[] = /* {{{ */
174 { "NotifyOutv4", "dns_notify", "tx-IPv4" },
175 { "NotifyOutv6", "dns_notify", "tx-IPv6" },
176 { "NotifyInv4", "dns_notify", "rx-IPv4" },
177 { "NotifyInv6", "dns_notify", "rx-IPv6" },
178 { "NotifyRej", "dns_notify", "rejected" },
179 /* SOA/AXFS/IXFS requests */
180 { "SOAOutv4", "dns_opcode", "SOA-IPv4" },
181 { "SOAOutv6", "dns_opcode", "SOA-IPv4" },
182 { "AXFRReqv4", "dns_opcode", "AXFR-IPv4" },
183 { "AXFRReqv6", "dns_opcode", "AXFR-IPv6" },
184 { "IXFRReqv4", "dns_opcode", "IXFR-IPv4" },
185 { "IXFRReqv6", "dns_opcode", "IXFR-IPv6" },
186 /* Domain transfers */
187 { "XfrSuccess", "dns_transfer", "success" },
188 { "XfrFail", "dns_transfer", "failure" }
190 static int zonestats_translation_table_length =
191 STATIC_ARRAY_SIZE (zonestats_translation_table);
194 /* Translation table for the `resstats' values. */
195 static const translation_info_t resstats_translation_table[] = /* {{{ */
197 /* Generic resolver information */
198 { "Queryv4", "dns_query", "IPv4" },
199 { "Queryv6", "dns_query", "IPv6" },
200 { "Responsev4", "dns_response", "IPv4" },
201 { "Responsev6", "dns_response", "IPv6" },
202 /* Received response codes */
203 { "NXDOMAIN", "dns_rcode", "rx-NXDOMAIN" },
204 { "SERVFAIL", "dns_rcode", "rx-SERVFAIL" },
205 { "FORMERR", "dns_rcode", "rx-FORMERR" },
206 { "OtherError", "dns_rcode", "rx-OTHER" },
207 { "EDNS0Fail", "dns_rcode", "rx-EDNS0Fail"},
208 /* Received responses */
209 { "Mismatch", "dns_response", "mismatch" },
210 { "Truncated", "dns_response", "truncated" },
211 { "Lame", "dns_response", "lame" },
212 { "Retry", "dns_query", "retry" },
214 { "GlueFetchv4", "type", "type_instance" },
215 { "GlueFetchv6", "type", "type_instance" },
216 { "GlueFetchv4Fail", "type", "type_instance" },
217 { "GlueFetchv6Fail", "type", "type_instance" },
219 /* DNSSEC information */
220 { "ValAttempt", "dns_resolver", "DNSSEC-attempt" },
221 { "ValOk", "dns_resolver", "DNSSEC-okay" },
222 { "ValNegOk", "dns_resolver", "DNSSEC-negokay" },
223 { "ValFail", "dns_resolver", "DNSSEC-fail" }
225 static int resstats_translation_table_length =
226 STATIC_ARRAY_SIZE (resstats_translation_table);
229 /* Translation table for the `memory/summary' values. */
230 static const translation_info_t memsummary_translation_table[] = /* {{{ */
232 { "TotalUse", "memory", "TotalUse" },
233 { "InUse", "memory", "InUse" },
234 { "BlockSize", "memory", "BlockSize" },
235 { "ContextSize", "memory", "ContextSize" },
236 { "Lost", "memory", "Lost" }
238 static int memsummary_translation_table_length =
239 STATIC_ARRAY_SIZE (memsummary_translation_table);
242 static void remove_special (char *buffer, size_t buffer_size) /* {{{ */
246 for (i = 0; i < buffer_size; i++)
250 if ((!isalnum ((int) buffer[i])) && (buffer[i] != '-'))
253 } /* }}} void remove_special */
255 static void submit_counter(time_t ts, const char *plugin_instance, /* {{{ */
256 const char *type, const char *type_instance, counter_t value)
259 value_list_t vl = VALUE_LIST_INIT;
261 values[0].counter = value;
266 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
267 sstrncpy(vl.plugin, "bind", sizeof(vl.plugin));
268 if (plugin_instance) {
269 sstrncpy(vl.plugin_instance, plugin_instance,
270 sizeof(vl.plugin_instance));
271 remove_special (vl.plugin_instance, sizeof (vl.plugin_instance));
273 sstrncpy(vl.type, type, sizeof(vl.type));
275 sstrncpy(vl.type_instance, type_instance,
276 sizeof(vl.type_instance));
277 remove_special (vl.plugin_instance, sizeof (vl.plugin_instance));
279 plugin_dispatch_values(&vl);
280 } /* }}} void submit_counter */
282 static size_t bind_curl_callback (void *buf, size_t size, /* {{{ */
283 size_t nmemb, void __attribute__((unused)) *stream)
285 size_t len = size * nmemb;
290 if ((bind_buffer_fill + len) >= bind_buffer_size)
294 temp = realloc(bind_buffer, bind_buffer_fill + len + 1);
297 ERROR ("bind plugin: realloc failed.");
301 bind_buffer_size = bind_buffer_fill + len + 1;
304 memcpy (bind_buffer + bind_buffer_fill, (char *) buf, len);
305 bind_buffer_fill += len;
306 bind_buffer[bind_buffer_fill] = 0;
309 } /* }}} size_t bind_curl_callback */
312 * Callback, that's called with a translation table.
313 * (Plugin instance is fixed, type and type instance come from lookup table.)
315 static int bind_xml_table_callback (const char *name, counter_t value, /* {{{ */
316 time_t current_time, void *user_data)
318 translation_table_ptr_t *table = (translation_table_ptr_t *) user_data;
324 for (i = 0; i < table->table_length; i++)
326 if (strcmp (table->table[i].xml_name, name) != 0)
329 submit_counter (current_time,
330 table->plugin_instance,
331 table->table[i].type,
332 table->table[i].type_instance,
338 } /* }}} int bind_xml_table_callback */
341 * Callback, that's used for lists.
342 * (Plugin instance and type are fixed, xml name is used as type instance.)
344 static int bind_xml_list_callback (const char *name, /* {{{ */
345 counter_t value, time_t current_time, void *user_data)
347 list_info_ptr_t *list_info = (list_info_ptr_t *) user_data;
349 if (list_info == NULL)
352 submit_counter (current_time,
353 list_info->plugin_instance,
355 /* type instance = */ name,
359 } /* }}} int bind_xml_list_callback */
361 static int bind_xml_read_counter (xmlDoc *doc, xmlNode *node, /* {{{ */
362 counter_t *ret_value)
364 char *str_ptr, *end_ptr;
367 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
370 ERROR ("bind plugin: bind_xml_read_counter: xmlNodeListGetString failed.");
375 value = strtoll (str_ptr, &end_ptr, 10);
377 if (str_ptr == end_ptr || errno)
379 if (errno && (value < 0))
380 ERROR ("bind plugin: bind_xml_read_counter: strtoll failed with underflow.");
381 else if (errno && (value > 0))
382 ERROR ("bind plugin: bind_xml_read_counter: strtoll failed with overflow.");
384 ERROR ("bind plugin: bind_xml_read_counter: strtoll failed.");
390 } /* }}} int bind_xml_read_counter */
392 static int bind_xml_read_timestamp (const char *xpath_expression, /* {{{ */
393 xmlDoc *doc, xmlXPathContext *xpathCtx, time_t *ret_value)
395 xmlXPathObject *xpathObj = NULL;
401 xpathObj = xmlXPathEvalExpression (BAD_CAST xpath_expression, xpathCtx);
402 if (xpathObj == NULL)
404 ERROR ("bind plugin: Unable to evaluate XPath expression `%s'.",
409 if ((xpathObj->nodesetval == NULL) || (xpathObj->nodesetval->nodeNr < 1))
411 xmlXPathFreeObject (xpathObj);
415 if (xpathObj->nodesetval->nodeNr != 1)
417 NOTICE ("bind plugin: Evaluating the XPath expression `%s' returned "
418 "%i nodes. Only handling the first one.",
419 xpath_expression, xpathObj->nodesetval->nodeNr);
422 node = xpathObj->nodesetval->nodeTab[0];
424 if (node->xmlChildrenNode == NULL)
426 ERROR ("bind plugin: bind_xml_read_timestamp: "
427 "node->xmlChildrenNode == NULL");
428 xmlXPathFreeObject (xpathObj);
432 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
435 ERROR ("bind plugin: bind_xml_read_timestamp: xmlNodeListGetString failed.");
436 xmlXPathFreeObject (xpathObj);
440 memset (&tm, 0, sizeof(tm));
441 tmp = strptime (str_ptr, "%Y-%m-%dT%T", &tm);
445 ERROR ("bind plugin: bind_xml_read_timestamp: strptime failed.");
446 xmlXPathFreeObject (xpathObj);
450 *ret_value = timegm(&tm);
452 xmlXPathFreeObject (xpathObj);
454 } /* }}} int bind_xml_read_timestamp */
457 * bind_parse_generic_name_value
459 * Reads statistics in the form:
465 static int bind_parse_generic_name_value (const char *xpath_expression, /* {{{ */
466 list_callback_t list_callback,
468 xmlDoc *doc, xmlXPathContext *xpathCtx,
471 xmlXPathObject *xpathObj = NULL;
475 xpathObj = xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
476 if (xpathObj == NULL)
478 ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
484 /* Iterate over all matching nodes. */
485 for (i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr); i++)
487 xmlNode *name_node = NULL;
488 xmlNode *counter = NULL;
491 /* Iterate over all child nodes. */
492 for (child = xpathObj->nodesetval->nodeTab[i]->xmlChildrenNode;
496 if (child->type != XML_ELEMENT_NODE)
499 if (xmlStrcmp (BAD_CAST "name", child->name) == 0)
501 else if (xmlStrcmp (BAD_CAST "counter", child->name) == 0)
505 if ((name_node != NULL) && (counter != NULL))
507 char *name = (char *) xmlNodeListGetString (doc,
508 name_node->xmlChildrenNode, 1);
512 status = bind_xml_read_counter (doc, counter, &value);
516 status = (*list_callback) (name, value, current_time, user_data);
524 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
525 num_entries, (num_entries == 1) ? "entry" : "entries",
528 xmlXPathFreeObject(xpathObj);
531 } /* }}} int bind_parse_generic_name_value */
534 * bind_parse_generic_value_list
536 * Reads statistics in the form:
544 static int bind_parse_generic_value_list (const char *xpath_expression, /* {{{ */
545 list_callback_t list_callback,
547 xmlDoc *doc, xmlXPathContext *xpathCtx,
550 xmlXPathObject *xpathObj = NULL;
554 xpathObj = xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
555 if (xpathObj == NULL)
557 ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
563 /* Iterate over all matching nodes. */
564 for (i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr); i++)
568 /* Iterate over all child nodes. */
569 for (child = xpathObj->nodesetval->nodeTab[i]->xmlChildrenNode;
577 if (child->type != XML_ELEMENT_NODE)
580 node_name = (char *) child->name;
581 status = bind_xml_read_counter (doc, child, &value);
585 status = (*list_callback) (node_name, value, current_time, user_data);
591 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
592 num_entries, (num_entries == 1) ? "entry" : "entries",
595 xmlXPathFreeObject(xpathObj);
598 } /* }}} int bind_parse_generic_value_list */
600 static int bind_xml_stats_handle_zone (int version, xmlDoc *doc, /* {{{ */
601 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
604 xmlXPathObject *path_obj;
605 char *zone_name = NULL;
609 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
610 if (path_obj == NULL)
612 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
616 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
618 zone_name = (char *) xmlNodeListGetString (doc,
619 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
620 if (zone_name != NULL)
624 if (zone_name == NULL)
626 ERROR ("bind plugin: Could not determine zone name.");
627 xmlXPathFreeObject (path_obj);
631 for (j = 0; j < view->zones_num; j++)
633 if (strcasecmp (zone_name, view->zones[j]) == 0)
642 xmlXPathFreeObject (path_obj);
646 zone_name = view->zones[j];
648 DEBUG ("bind plugin: bind_xml_stats_handle_zone: Found zone `%s'.",
651 { /* Parse the <counters> tag {{{ */
652 char plugin_instance[DATA_MAX_NAME_LEN];
653 translation_table_ptr_t table_ptr =
655 nsstats_translation_table,
656 nsstats_translation_table_length,
660 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-zone-%s",
661 view->name, zone_name);
663 bind_parse_generic_value_list (/* xpath = */ "counters",
664 /* callback = */ bind_xml_table_callback,
665 /* user_data = */ &table_ptr,
666 doc, path_ctx, current_time);
669 xmlXPathFreeObject (path_obj);
672 } /* }}} int bind_xml_stats_handle_zone */
674 static int bind_xml_stats_search_zones (int version, xmlDoc *doc, /* {{{ */
675 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
678 xmlXPathObject *zone_nodes = NULL;
679 xmlXPathContext *zone_path_context;
682 zone_path_context = xmlXPathNewContext (doc);
683 if (zone_path_context == NULL)
685 ERROR ("bind plugin: xmlXPathNewContext failed.");
689 zone_nodes = xmlXPathEvalExpression (BAD_CAST "zones/zone", path_ctx);
690 if (zone_nodes == NULL)
692 ERROR ("bind plugin: Cannot find any <view> tags.");
693 xmlXPathFreeContext (zone_path_context);
697 for (i = 0; i < zone_nodes->nodesetval->nodeNr; i++)
701 node = zone_nodes->nodesetval->nodeTab[i];
702 assert (node != NULL);
704 zone_path_context->node = node;
706 bind_xml_stats_handle_zone (version, doc, zone_path_context, node, view,
710 xmlXPathFreeObject (zone_nodes);
711 xmlXPathFreeContext (zone_path_context);
713 } /* }}} int bind_xml_stats_search_zones */
715 static int bind_xml_stats_handle_view (int version, xmlDoc *doc, /* {{{ */
716 xmlXPathContext *path_ctx, xmlNode *node, time_t current_time)
718 xmlXPathObject *path_obj;
719 char *view_name = NULL;
724 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
725 if (path_obj == NULL)
727 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
731 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
733 view_name = (char *) xmlNodeListGetString (doc,
734 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
735 if (view_name != NULL)
739 if (view_name == NULL)
741 ERROR ("bind plugin: Could not determine view name.");
742 xmlXPathFreeObject (path_obj);
746 for (j = 0; j < views_num; j++)
748 if (strcasecmp (view_name, views[j].name) == 0)
753 xmlXPathFreeObject (path_obj);
763 DEBUG ("bind plugin: bind_xml_stats_handle_view: Found view `%s'.",
766 if (view->qtypes != 0) /* {{{ */
768 char plugin_instance[DATA_MAX_NAME_LEN];
769 list_info_ptr_t list_info =
772 /* type = */ "dns_qtype"
775 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-qtypes",
778 bind_parse_generic_name_value (/* xpath = */ "rdtype",
779 /* callback = */ bind_xml_list_callback,
780 /* user_data = */ &list_info,
781 doc, path_ctx, current_time);
784 if (view->resolver_stats != 0) /* {{{ */
786 char plugin_instance[DATA_MAX_NAME_LEN];
787 translation_table_ptr_t table_ptr =
789 resstats_translation_table,
790 resstats_translation_table_length,
794 ssnprintf (plugin_instance, sizeof (plugin_instance),
795 "%s-resolver_stats", view->name);
797 bind_parse_generic_name_value ("resstat",
798 /* callback = */ bind_xml_table_callback,
799 /* user_data = */ &table_ptr,
800 doc, path_ctx, current_time);
803 if (view->cacherrsets != 0) /* {{{ */
805 char plugin_instance[DATA_MAX_NAME_LEN];
806 list_info_ptr_t list_info =
809 /* type = */ "dns_qtype"
812 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-cache_rr_sets",
815 bind_parse_generic_name_value (/* xpath = */ "cache/rrset",
816 /* callback = */ bind_xml_list_callback,
817 /* user_data = */ &list_info,
818 doc, path_ctx, current_time);
821 if (view->zones_num > 0)
822 bind_xml_stats_search_zones (version, doc, path_ctx, node, view,
826 } /* }}} int bind_xml_stats_handle_view */
828 static int bind_xml_stats_search_views (int version, xmlDoc *doc, /* {{{ */
829 xmlXPathContext *xpathCtx, xmlNode *statsnode, time_t current_time)
831 xmlXPathObject *view_nodes = NULL;
832 xmlXPathContext *view_path_context;
835 view_path_context = xmlXPathNewContext (doc);
836 if (view_path_context == NULL)
838 ERROR ("bind plugin: xmlXPathNewContext failed.");
842 view_nodes = xmlXPathEvalExpression (BAD_CAST "views/view", xpathCtx);
843 if (view_nodes == NULL)
845 ERROR ("bind plugin: Cannot find any <view> tags.");
846 xmlXPathFreeContext (view_path_context);
850 for (i = 0; i < view_nodes->nodesetval->nodeNr; i++)
854 node = view_nodes->nodesetval->nodeTab[i];
855 assert (node != NULL);
857 view_path_context->node = node;
859 bind_xml_stats_handle_view (version, doc, view_path_context, node,
863 xmlXPathFreeObject (view_nodes);
864 xmlXPathFreeContext (view_path_context);
866 } /* }}} int bind_xml_stats_search_views */
868 static int bind_xml_stats (int version, xmlDoc *doc, /* {{{ */
869 xmlXPathContext *xpathCtx, xmlNode *statsnode)
871 time_t current_time = 0;
874 xpathCtx->node = statsnode;
876 /* TODO: Check `server/boot-time' to recognize server restarts. */
878 status = bind_xml_read_timestamp ("server/current-time",
879 doc, xpathCtx, ¤t_time);
882 ERROR ("bind plugin: Reading `server/current-time' failed.");
885 DEBUG ("bind plugin: Current server time is %i.", (int) current_time);
887 /* XPath: server/requests/opcode
888 * Variables: QUERY, IQUERY, NOTIFY, UPDATE, ...
892 * <counter>1</counter>
896 if (global_opcodes != 0)
898 list_info_ptr_t list_info =
900 /* plugin instance = */ "global-opcodes",
901 /* type = */ "dns_opcode"
904 bind_parse_generic_name_value (/* xpath = */ "server/requests/opcode",
905 /* callback = */ bind_xml_list_callback,
906 /* user_data = */ &list_info,
907 doc, xpathCtx, current_time);
910 /* XPath: server/queries-in/rdtype
911 * Variables: RESERVED0, A, NS, CNAME, SOA, MR, PTR, HINFO, MX, TXT, RP,
912 * X25, PX, AAAA, LOC, SRV, NAPTR, A6, DS, RRSIG, NSEC, DNSKEY,
913 * SPF, TKEY, IXFR, AXFR, ANY, ..., Others
917 * <counter>1</counter>
921 if (global_qtypes != 0)
923 list_info_ptr_t list_info =
925 /* plugin instance = */ "global-qtypes",
926 /* type = */ "dns_qtype"
929 bind_parse_generic_name_value (/* xpath = */ "server/queries-in/rdtype",
930 /* callback = */ bind_xml_list_callback,
931 /* user_data = */ &list_info,
932 doc, xpathCtx, current_time);
935 /* XPath: server/nsstats, server/nsstat
936 * Variables: Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG,
937 * ReqSIG0, ReqBadSIG, ReqTCP, AuthQryRej, RecQryRej, XfrRej,
938 * UpdateRej, Response, TruncatedResp, RespEDNS0, RespTSIG,
939 * RespSIG0, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral,
940 * QryNxrrset, QrySERVFAIL, QryFORMERR, QryNXDOMAIN, QryRecursion,
941 * QryDuplicate, QryDropped, QryFailure, XfrReqDone, UpdateReqFwd,
942 * UpdateRespFwd, UpdateFwdFail, UpdateDone, UpdateFail,
946 * <Requestv4>1</Requestv4>
947 * <Requestv6>0</Requestv6>
952 * <name>Requestv4</name>
953 * <counter>1</counter>
956 * <name>Requestv6</name>
957 * <counter>0</counter>
961 if (global_server_stats)
963 translation_table_ptr_t table_ptr =
965 nsstats_translation_table,
966 nsstats_translation_table_length,
967 /* plugin_instance = */ "global-server_stats"
972 bind_parse_generic_value_list ("server/nsstats",
973 /* callback = */ bind_xml_table_callback,
974 /* user_data = */ &table_ptr,
975 doc, xpathCtx, current_time);
979 bind_parse_generic_name_value ("server/nsstat",
980 /* callback = */ bind_xml_table_callback,
981 /* user_data = */ &table_ptr,
982 doc, xpathCtx, current_time);
986 /* XPath: server/zonestats, server/zonestat
987 * Variables: NotifyOutv4, NotifyOutv6, NotifyInv4, NotifyInv6, NotifyRej,
988 * SOAOutv4, SOAOutv6, AXFRReqv4, AXFRReqv6, IXFRReqv4, IXFRReqv6,
989 * XfrSuccess, XfrFail
992 * <NotifyOutv4>0</NotifyOutv4>
993 * <NotifyOutv6>0</NotifyOutv6>
998 * <name>NotifyOutv4</name>
999 * <counter>0</counter>
1002 * <name>NotifyOutv6</name>
1003 * <counter>0</counter>
1007 if (global_zone_maint_stats)
1009 translation_table_ptr_t table_ptr =
1011 zonestats_translation_table,
1012 zonestats_translation_table_length,
1013 /* plugin_instance = */ "global-zone_maint_stats"
1018 bind_parse_generic_value_list ("server/zonestats",
1019 /* callback = */ bind_xml_table_callback,
1020 /* user_data = */ &table_ptr,
1021 doc, xpathCtx, current_time);
1025 bind_parse_generic_name_value ("server/zonestat",
1026 /* callback = */ bind_xml_table_callback,
1027 /* user_data = */ &table_ptr,
1028 doc, xpathCtx, current_time);
1032 /* XPath: server/resstats
1033 * Variables: Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL,
1034 * FORMERR, OtherError, EDNS0Fail, Mismatch, Truncated, Lame,
1035 * Retry, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail,
1036 * GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk, ValFail
1039 * <Queryv4>0</Queryv4>
1040 * <Queryv6>0</Queryv6>
1045 * <name>Queryv4</name>
1046 * <counter>0</counter>
1049 * <name>Queryv6</name>
1050 * <counter>0</counter>
1054 if (global_resolver_stats != 0)
1056 translation_table_ptr_t table_ptr =
1058 resstats_translation_table,
1059 resstats_translation_table_length,
1060 /* plugin_instance = */ "global-resolver_stats"
1065 bind_parse_generic_value_list ("server/resstats",
1066 /* callback = */ bind_xml_table_callback,
1067 /* user_data = */ &table_ptr,
1068 doc, xpathCtx, current_time);
1072 bind_parse_generic_name_value ("server/resstat",
1073 /* callback = */ bind_xml_table_callback,
1074 /* user_data = */ &table_ptr,
1075 doc, xpathCtx, current_time);
1079 /* XPath: memory/summary
1080 * Variables: TotalUse, InUse, BlockSize, ContextSize, Lost
1083 * <TotalUse>6587096</TotalUse>
1084 * <InUse>1345424</InUse>
1085 * <BlockSize>5505024</BlockSize>
1086 * <ContextSize>3732456</ContextSize>
1090 if (global_memory_stats != 0)
1092 translation_table_ptr_t table_ptr =
1094 memsummary_translation_table,
1095 memsummary_translation_table_length,
1096 /* plugin_instance = */ "global-memory_stats"
1099 bind_parse_generic_value_list ("memory/summary",
1100 /* callback = */ bind_xml_table_callback,
1101 /* user_data = */ &table_ptr,
1102 doc, xpathCtx, current_time);
1106 bind_xml_stats_search_views (version, doc, xpathCtx, statsnode,
1110 } /* }}} int bind_xml_stats */
1112 static int bind_xml (const char *data) /* {{{ */
1115 xmlXPathContext *xpathCtx = NULL;
1116 xmlXPathObject *xpathObj = NULL;
1120 doc = xmlParseMemory (data, strlen (data));
1123 ERROR ("bind plugin: xmlParseMemory failed.");
1127 xpathCtx = xmlXPathNewContext (doc);
1128 if (xpathCtx == NULL)
1130 ERROR ("bind plugin: xmlXPathNewContext failed.");
1135 xpathObj = xmlXPathEvalExpression (BAD_CAST "/isc/bind/statistics", xpathCtx);
1136 if (xpathObj == NULL)
1138 ERROR ("bind plugin: Cannot find the <statistics> tag.");
1139 xmlXPathFreeContext (xpathCtx);
1143 else if (xpathObj->nodesetval == NULL)
1145 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
1146 xmlXPathFreeObject (xpathObj);
1147 xmlXPathFreeContext (xpathCtx);
1152 for (i = 0; i < xpathObj->nodesetval->nodeNr; i++)
1156 int parsed_version = 0;
1158 node = xpathObj->nodesetval->nodeTab[i];
1159 assert (node != NULL);
1161 attr_version = (char *) xmlGetProp (node, BAD_CAST "version");
1162 if (attr_version == NULL)
1164 NOTICE ("bind plugin: Found <statistics> tag doesn't have a "
1165 "`version' attribute.");
1168 DEBUG ("bind plugin: Found: <statistics version=\"%s\">", attr_version);
1170 /* At the time this plugin was written, version "1.0" was used by
1171 * BIND 9.5.0, version "2.0" was used by BIND 9.5.1 and 9.6.0. We assume
1172 * that "1.*" and "2.*" don't introduce structural changes, so we just
1173 * check for the first two characters here. */
1174 if (strncmp ("1.", attr_version, strlen ("1.")) == 0)
1176 else if (strncmp ("2.", attr_version, strlen ("2.")) == 0)
1180 /* TODO: Use the complaint mechanism here. */
1181 NOTICE ("bind plugin: Found <statistics> tag with version `%s'. "
1182 "Unfortunately I have no clue how to parse that. "
1183 "Please open a bug report for this.", attr_version);
1184 xmlFree (attr_version);
1188 ret = bind_xml_stats (parsed_version,
1189 doc, xpathCtx, node);
1191 xmlFree (attr_version);
1192 /* One <statistics> node ought to be enough. */
1196 xmlXPathFreeObject (xpathObj);
1197 xmlXPathFreeContext (xpathCtx);
1201 } /* }}} int bind_xml */
1203 static int bind_config_set_bool (const char *name, int *var, /* {{{ */
1206 if ((ci->values_num != 1) || ( ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1208 WARNING ("bind plugin: The `%s' option needs "
1209 "exactly one boolean argument.", name);
1213 if (ci->values[0].value.boolean)
1218 } /* }}} int bind_config_set_bool */
1220 static int bind_config_add_view_zone (cb_view_t *view, /* {{{ */
1225 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1227 WARNING ("bind plugin: The `Zone' option needs "
1228 "exactly one string argument.");
1232 tmp = (char **) realloc (view->zones,
1233 sizeof (char *) * (view->zones_num + 1));
1236 ERROR ("bind plugin: realloc failed.");
1241 view->zones[view->zones_num] = strdup (ci->values[0].value.string);
1242 if (view->zones[view->zones_num] == NULL)
1244 ERROR ("bind plugin: strdup failed.");
1250 } /* }}} int bind_config_add_view_zone */
1252 static int bind_config_add_view (oconfig_item_t *ci) /* {{{ */
1257 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1259 WARNING ("bind plugin: `View' blocks need exactly one string argument.");
1263 tmp = (cb_view_t *) realloc (views, sizeof (*views) * (views_num + 1));
1266 ERROR ("bind plugin: realloc failed.");
1270 tmp = views + views_num;
1272 memset (tmp, 0, sizeof (*tmp));
1274 tmp->resolver_stats = 1;
1275 tmp->cacherrsets = 1;
1279 tmp->name = strdup (ci->values[0].value.string);
1280 if (tmp->name == NULL)
1282 ERROR ("bind plugin: strdup failed.");
1287 for (i = 0; i < ci->children_num; i++)
1289 oconfig_item_t *child = ci->children + i;
1291 if (strcasecmp ("QTypes", child->key) == 0)
1292 bind_config_set_bool ("QTypes", &tmp->qtypes, child);
1293 else if (strcasecmp ("ResolverStats", child->key) == 0)
1294 bind_config_set_bool ("ResolverStats", &tmp->resolver_stats, child);
1295 else if (strcasecmp ("CacheRRSets", child->key) == 0)
1296 bind_config_set_bool ("CacheRRSets", &tmp->cacherrsets, child);
1297 else if (strcasecmp ("Zone", child->key) == 0)
1298 bind_config_add_view_zone (tmp, child);
1301 WARNING ("bind plugin: Unknown configuration option "
1302 "`%s' in view `%s' will be ignored.", child->key, tmp->name);
1304 } /* for (i = 0; i < ci->children_num; i++) */
1308 } /* }}} int bind_config_add_view */
1310 static int bind_config (oconfig_item_t *ci) /* {{{ */
1314 for (i = 0; i < ci->children_num; i++)
1316 oconfig_item_t *child = ci->children + i;
1318 if (strcasecmp ("OpCodes", child->key) == 0)
1319 bind_config_set_bool ("OpCodes", &global_opcodes, child);
1320 else if (strcasecmp ("QTypes", child->key) == 0)
1321 bind_config_set_bool ("QTypes", &global_qtypes, child);
1322 else if (strcasecmp ("ServerStats", child->key) == 0)
1323 bind_config_set_bool ("ServerStats", &global_server_stats, child);
1324 else if (strcasecmp ("ZoneMaintStats", child->key) == 0)
1325 bind_config_set_bool ("ZoneMaintStats", &global_zone_maint_stats, child);
1326 else if (strcasecmp ("ResolverStats", child->key) == 0)
1327 bind_config_set_bool ("ResolverStats", &global_resolver_stats, child);
1328 else if (strcasecmp ("MemoryStats", child->key) == 0)
1329 bind_config_set_bool ("MemoryStats", &global_resolver_stats, child);
1330 else if (strcasecmp ("View", child->key) == 0)
1331 bind_config_add_view (child);
1334 WARNING ("bind plugin: Unknown configuration option "
1335 "`%s' will be ignored.", child->key);
1340 } /* }}} int bind_config */
1342 static int bind_init (void) /* {{{ */
1347 curl = curl_easy_init ();
1350 ERROR ("bind plugin: bind_init: curl_easy_init failed.");
1354 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, bind_curl_callback);
1355 curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
1356 curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, bind_curl_error);
1357 curl_easy_setopt (curl, CURLOPT_URL, (url != NULL) ? url : BIND_DEFAULT_URL);
1360 } /* }}} int bind_init */
1362 static int bind_read (void) /* {{{ */
1368 ERROR ("bind plugin: I don't have a CURL object.");
1372 bind_buffer_fill = 0;
1373 if (curl_easy_perform (curl) != 0)
1375 ERROR ("bind plugin: curl_easy_perform failed: %s",
1380 status = bind_xml (bind_buffer);
1385 } /* }}} int bind_read */
1387 static int bind_shutdown (void) /* {{{ */
1391 curl_easy_cleanup (curl);
1396 } /* }}} int bind_shutdown */
1398 void module_register (void)
1400 plugin_register_complex_config ("bind", bind_config);
1401 plugin_register_init ("bind", bind_init);
1402 plugin_register_read ("bind", bind_read);
1403 plugin_register_shutdown ("bind", bind_shutdown);
1404 } /* void module_register */
1406 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */