2 * collectd - src/bind.c
3 * Copyright (C) 2009 Bruno Prémont
4 * Copyright (C) 2009,2010 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 collectd.org>
26 #if STRPTIME_NEEDS_STANDARDS
27 # ifndef _ISOC99_SOURCE
28 # define _ISOC99_SOURCE 1
30 # ifndef _POSIX_C_SOURCE
31 # define _POSIX_C_SOURCE 200112L
33 # ifndef _XOPEN_SOURCE
34 # define _XOPEN_SOURCE 500
36 #endif /* STRPTIME_NEEDS_STANDARDS */
41 #include "configfile.h"
43 /* Some versions of libcurl don't include this themselves and then don't have
44 * fd_set available. */
46 # include <sys/select.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, value_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", "transfer" },
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-IPv6" },
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 submit (time_t ts, const char *plugin_instance, /* {{{ */
243 const char *type, const char *type_instance, value_t value)
246 value_list_t vl = VALUE_LIST_INIT;
252 vl.time = TIME_T_TO_CDTIME_T (ts);
253 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
254 sstrncpy(vl.plugin, "bind", sizeof(vl.plugin));
255 if (plugin_instance) {
256 sstrncpy(vl.plugin_instance, plugin_instance,
257 sizeof(vl.plugin_instance));
258 replace_special (vl.plugin_instance, sizeof (vl.plugin_instance));
260 sstrncpy(vl.type, type, sizeof(vl.type));
262 sstrncpy(vl.type_instance, type_instance,
263 sizeof(vl.type_instance));
264 replace_special (vl.plugin_instance, sizeof (vl.plugin_instance));
266 plugin_dispatch_values(&vl);
267 } /* }}} void submit */
269 static size_t bind_curl_callback (void *buf, size_t size, /* {{{ */
270 size_t nmemb, void __attribute__((unused)) *stream)
272 size_t len = size * nmemb;
277 if ((bind_buffer_fill + len) >= bind_buffer_size)
281 temp = realloc(bind_buffer, bind_buffer_fill + len + 1);
284 ERROR ("bind plugin: realloc failed.");
288 bind_buffer_size = bind_buffer_fill + len + 1;
291 memcpy (bind_buffer + bind_buffer_fill, (char *) buf, len);
292 bind_buffer_fill += len;
293 bind_buffer[bind_buffer_fill] = 0;
296 } /* }}} size_t bind_curl_callback */
299 * Callback, that's called with a translation table.
300 * (Plugin instance is fixed, type and type instance come from lookup table.)
302 static int bind_xml_table_callback (const char *name, value_t value, /* {{{ */
303 time_t current_time, void *user_data)
305 translation_table_ptr_t *table = (translation_table_ptr_t *) user_data;
311 for (i = 0; i < table->table_length; i++)
313 if (strcmp (table->table[i].xml_name, name) != 0)
316 submit (current_time,
317 table->plugin_instance,
318 table->table[i].type,
319 table->table[i].type_instance,
325 } /* }}} int bind_xml_table_callback */
328 * Callback, that's used for lists.
329 * (Plugin instance and type are fixed, xml name is used as type instance.)
331 static int bind_xml_list_callback (const char *name, /* {{{ */
332 value_t value, time_t current_time, void *user_data)
334 list_info_ptr_t *list_info = (list_info_ptr_t *) user_data;
336 if (list_info == NULL)
339 submit (current_time,
340 list_info->plugin_instance,
342 /* type instance = */ name,
346 } /* }}} int bind_xml_list_callback */
348 static int bind_xml_read_derive (xmlDoc *doc, xmlNode *node, /* {{{ */
355 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
358 ERROR ("bind plugin: bind_xml_read_derive: xmlNodeListGetString failed.");
362 status = parse_value (str_ptr, &value, DS_TYPE_DERIVE);
365 ERROR ("bind plugin: Parsing string \"%s\" to derive value failed.",
370 *ret_value = value.derive;
372 } /* }}} int bind_xml_read_derive */
374 static int bind_xml_read_gauge (xmlDoc *doc, xmlNode *node, /* {{{ */
377 char *str_ptr, *end_ptr;
380 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
383 ERROR ("bind plugin: bind_xml_read_gauge: xmlNodeListGetString failed.");
388 value = strtod (str_ptr, &end_ptr);
390 if (str_ptr == end_ptr || errno)
392 if (errno && (value < 0))
393 ERROR ("bind plugin: bind_xml_read_gauge: strtod failed with underflow.");
394 else if (errno && (value > 0))
395 ERROR ("bind plugin: bind_xml_read_gauge: strtod failed with overflow.");
397 ERROR ("bind plugin: bind_xml_read_gauge: strtod failed.");
401 *ret_value = (gauge_t) value;
403 } /* }}} int bind_xml_read_gauge */
405 static int bind_xml_read_timestamp (const char *xpath_expression, /* {{{ */
406 xmlDoc *doc, xmlXPathContext *xpathCtx, time_t *ret_value)
408 xmlXPathObject *xpathObj = NULL;
414 xpathObj = xmlXPathEvalExpression (BAD_CAST xpath_expression, xpathCtx);
415 if (xpathObj == NULL)
417 ERROR ("bind plugin: Unable to evaluate XPath expression `%s'.",
422 if ((xpathObj->nodesetval == NULL) || (xpathObj->nodesetval->nodeNr < 1))
424 xmlXPathFreeObject (xpathObj);
428 if (xpathObj->nodesetval->nodeNr != 1)
430 NOTICE ("bind plugin: Evaluating the XPath expression `%s' returned "
431 "%i nodes. Only handling the first one.",
432 xpath_expression, xpathObj->nodesetval->nodeNr);
435 node = xpathObj->nodesetval->nodeTab[0];
437 if (node->xmlChildrenNode == NULL)
439 ERROR ("bind plugin: bind_xml_read_timestamp: "
440 "node->xmlChildrenNode == NULL");
441 xmlXPathFreeObject (xpathObj);
445 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
448 ERROR ("bind plugin: bind_xml_read_timestamp: xmlNodeListGetString failed.");
449 xmlXPathFreeObject (xpathObj);
453 memset (&tm, 0, sizeof(tm));
454 tmp = strptime (str_ptr, "%Y-%m-%dT%T", &tm);
458 ERROR ("bind plugin: bind_xml_read_timestamp: strptime failed.");
459 xmlXPathFreeObject (xpathObj);
463 *ret_value = mktime(&tm);
465 xmlXPathFreeObject (xpathObj);
467 } /* }}} int bind_xml_read_timestamp */
470 * bind_parse_generic_name_value
472 * Reads statistics in the form:
475 * <counter>123</counter>
478 static int bind_parse_generic_name_value (const char *xpath_expression, /* {{{ */
479 list_callback_t list_callback,
481 xmlDoc *doc, xmlXPathContext *xpathCtx,
482 time_t current_time, int ds_type)
484 xmlXPathObject *xpathObj = NULL;
488 xpathObj = xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
489 if (xpathObj == NULL)
491 ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
497 /* Iterate over all matching nodes. */
498 for (i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr); i++)
500 xmlNode *name_node = NULL;
501 xmlNode *counter = NULL;
505 parent = xpathObj->nodesetval->nodeTab[i];
506 DEBUG ("bind plugin: bind_parse_generic_name_value: parent->name = %s;",
507 (char *) parent->name);
509 /* Iterate over all child nodes. */
510 for (child = parent->xmlChildrenNode;
514 if (child->type != XML_ELEMENT_NODE)
517 if (xmlStrcmp (BAD_CAST "name", child->name) == 0)
519 else if (xmlStrcmp (BAD_CAST "counter", child->name) == 0)
523 if ((name_node != NULL) && (counter != NULL))
525 char *name = (char *) xmlNodeListGetString (doc,
526 name_node->xmlChildrenNode, 1);
530 if (ds_type == DS_TYPE_GAUGE)
531 status = bind_xml_read_gauge (doc, counter, &value.gauge);
533 status = bind_xml_read_derive (doc, counter, &value.derive);
537 status = (*list_callback) (name, value, current_time, user_data);
545 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
546 num_entries, (num_entries == 1) ? "entry" : "entries",
549 xmlXPathFreeObject(xpathObj);
552 } /* }}} int bind_parse_generic_name_value */
555 * bind_parse_generic_value_list
557 * Reads statistics in the form:
565 static int bind_parse_generic_value_list (const char *xpath_expression, /* {{{ */
566 list_callback_t list_callback,
568 xmlDoc *doc, xmlXPathContext *xpathCtx,
569 time_t current_time, int ds_type)
571 xmlXPathObject *xpathObj = NULL;
575 xpathObj = xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
576 if (xpathObj == NULL)
578 ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
584 /* Iterate over all matching nodes. */
585 for (i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr); i++)
589 /* Iterate over all child nodes. */
590 for (child = xpathObj->nodesetval->nodeTab[i]->xmlChildrenNode;
598 if (child->type != XML_ELEMENT_NODE)
601 node_name = (char *) child->name;
603 if (ds_type == DS_TYPE_GAUGE)
604 status = bind_xml_read_gauge (doc, child, &value.gauge);
606 status = bind_xml_read_derive (doc, child, &value.derive);
610 status = (*list_callback) (node_name, value, current_time, user_data);
616 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
617 num_entries, (num_entries == 1) ? "entry" : "entries",
620 xmlXPathFreeObject(xpathObj);
623 } /* }}} int bind_parse_generic_value_list */
625 static int bind_xml_stats_handle_zone (int version, xmlDoc *doc, /* {{{ */
626 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
629 xmlXPathObject *path_obj;
630 char *zone_name = NULL;
634 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
635 if (path_obj == NULL)
637 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
641 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
643 zone_name = (char *) xmlNodeListGetString (doc,
644 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
645 if (zone_name != NULL)
649 if (zone_name == NULL)
651 ERROR ("bind plugin: Could not determine zone name.");
652 xmlXPathFreeObject (path_obj);
656 for (j = 0; j < view->zones_num; j++)
658 if (strcasecmp (zone_name, view->zones[j]) == 0)
667 xmlXPathFreeObject (path_obj);
671 zone_name = view->zones[j];
673 DEBUG ("bind plugin: bind_xml_stats_handle_zone: Found zone `%s'.",
676 { /* Parse the <counters> tag {{{ */
677 char plugin_instance[DATA_MAX_NAME_LEN];
678 translation_table_ptr_t table_ptr =
680 nsstats_translation_table,
681 nsstats_translation_table_length,
685 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-zone-%s",
686 view->name, zone_name);
688 bind_parse_generic_value_list (/* xpath = */ "counters",
689 /* callback = */ bind_xml_table_callback,
690 /* user_data = */ &table_ptr,
691 doc, path_ctx, current_time, DS_TYPE_COUNTER);
694 xmlXPathFreeObject (path_obj);
697 } /* }}} int bind_xml_stats_handle_zone */
699 static int bind_xml_stats_search_zones (int version, xmlDoc *doc, /* {{{ */
700 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
703 xmlXPathObject *zone_nodes = NULL;
704 xmlXPathContext *zone_path_context;
707 zone_path_context = xmlXPathNewContext (doc);
708 if (zone_path_context == NULL)
710 ERROR ("bind plugin: xmlXPathNewContext failed.");
714 zone_nodes = xmlXPathEvalExpression (BAD_CAST "zones/zone", path_ctx);
715 if (zone_nodes == NULL)
717 ERROR ("bind plugin: Cannot find any <view> tags.");
718 xmlXPathFreeContext (zone_path_context);
722 for (i = 0; i < zone_nodes->nodesetval->nodeNr; i++)
726 node = zone_nodes->nodesetval->nodeTab[i];
727 assert (node != NULL);
729 zone_path_context->node = node;
731 bind_xml_stats_handle_zone (version, doc, zone_path_context, node, view,
735 xmlXPathFreeObject (zone_nodes);
736 xmlXPathFreeContext (zone_path_context);
738 } /* }}} int bind_xml_stats_search_zones */
740 static int bind_xml_stats_handle_view (int version, xmlDoc *doc, /* {{{ */
741 xmlXPathContext *path_ctx, xmlNode *node, time_t current_time)
743 xmlXPathObject *path_obj;
744 char *view_name = NULL;
749 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
750 if (path_obj == NULL)
752 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
756 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
758 view_name = (char *) xmlNodeListGetString (doc,
759 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
760 if (view_name != NULL)
764 if (view_name == NULL)
766 ERROR ("bind plugin: Could not determine view name.");
767 xmlXPathFreeObject (path_obj);
771 for (j = 0; j < views_num; j++)
773 if (strcasecmp (view_name, views[j].name) == 0)
778 xmlXPathFreeObject (path_obj);
788 DEBUG ("bind plugin: bind_xml_stats_handle_view: Found view `%s'.",
791 if (view->qtypes != 0) /* {{{ */
793 char plugin_instance[DATA_MAX_NAME_LEN];
794 list_info_ptr_t list_info =
797 /* type = */ "dns_qtype"
800 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-qtypes",
803 bind_parse_generic_name_value (/* xpath = */ "rdtype",
804 /* callback = */ bind_xml_list_callback,
805 /* user_data = */ &list_info,
806 doc, path_ctx, current_time, DS_TYPE_COUNTER);
809 if (view->resolver_stats != 0) /* {{{ */
811 char plugin_instance[DATA_MAX_NAME_LEN];
812 translation_table_ptr_t table_ptr =
814 resstats_translation_table,
815 resstats_translation_table_length,
819 ssnprintf (plugin_instance, sizeof (plugin_instance),
820 "%s-resolver_stats", view->name);
822 bind_parse_generic_name_value ("resstat",
823 /* callback = */ bind_xml_table_callback,
824 /* user_data = */ &table_ptr,
825 doc, path_ctx, current_time, DS_TYPE_COUNTER);
828 /* Record types in the cache */
829 if (view->cacherrsets != 0) /* {{{ */
831 char plugin_instance[DATA_MAX_NAME_LEN];
832 list_info_ptr_t list_info =
835 /* type = */ "dns_qtype_cached"
838 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-cache_rr_sets",
841 bind_parse_generic_name_value (/* xpath = */ "cache/rrset",
842 /* callback = */ bind_xml_list_callback,
843 /* user_data = */ &list_info,
844 doc, path_ctx, current_time, DS_TYPE_GAUGE);
847 if (view->zones_num > 0)
848 bind_xml_stats_search_zones (version, doc, path_ctx, node, view,
852 } /* }}} int bind_xml_stats_handle_view */
854 static int bind_xml_stats_search_views (int version, xmlDoc *doc, /* {{{ */
855 xmlXPathContext *xpathCtx, xmlNode *statsnode, time_t current_time)
857 xmlXPathObject *view_nodes = NULL;
858 xmlXPathContext *view_path_context;
861 view_path_context = xmlXPathNewContext (doc);
862 if (view_path_context == NULL)
864 ERROR ("bind plugin: xmlXPathNewContext failed.");
868 view_nodes = xmlXPathEvalExpression (BAD_CAST "views/view", xpathCtx);
869 if (view_nodes == NULL)
871 ERROR ("bind plugin: Cannot find any <view> tags.");
872 xmlXPathFreeContext (view_path_context);
876 for (i = 0; i < view_nodes->nodesetval->nodeNr; i++)
880 node = view_nodes->nodesetval->nodeTab[i];
881 assert (node != NULL);
883 view_path_context->node = node;
885 bind_xml_stats_handle_view (version, doc, view_path_context, node,
889 xmlXPathFreeObject (view_nodes);
890 xmlXPathFreeContext (view_path_context);
892 } /* }}} int bind_xml_stats_search_views */
894 static int bind_xml_stats (int version, xmlDoc *doc, /* {{{ */
895 xmlXPathContext *xpathCtx, xmlNode *statsnode)
897 time_t current_time = 0;
900 xpathCtx->node = statsnode;
902 /* TODO: Check `server/boot-time' to recognize server restarts. */
904 status = bind_xml_read_timestamp ("server/current-time",
905 doc, xpathCtx, ¤t_time);
908 ERROR ("bind plugin: Reading `server/current-time' failed.");
911 DEBUG ("bind plugin: Current server time is %i.", (int) current_time);
913 /* XPath: server/requests/opcode
914 * Variables: QUERY, IQUERY, NOTIFY, UPDATE, ...
918 * <counter>1</counter>
922 if (global_opcodes != 0)
924 list_info_ptr_t list_info =
926 /* plugin instance = */ "global-opcodes",
927 /* type = */ "dns_opcode"
930 bind_parse_generic_name_value (/* xpath = */ "server/requests/opcode",
931 /* callback = */ bind_xml_list_callback,
932 /* user_data = */ &list_info,
933 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
936 /* XPath: server/queries-in/rdtype
937 * Variables: RESERVED0, A, NS, CNAME, SOA, MR, PTR, HINFO, MX, TXT, RP,
938 * X25, PX, AAAA, LOC, SRV, NAPTR, A6, DS, RRSIG, NSEC, DNSKEY,
939 * SPF, TKEY, IXFR, AXFR, ANY, ..., Others
943 * <counter>1</counter>
947 if (global_qtypes != 0)
949 list_info_ptr_t list_info =
951 /* plugin instance = */ "global-qtypes",
952 /* type = */ "dns_qtype"
955 bind_parse_generic_name_value (/* xpath = */ "server/queries-in/rdtype",
956 /* callback = */ bind_xml_list_callback,
957 /* user_data = */ &list_info,
958 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
961 /* XPath: server/nsstats, server/nsstat
962 * Variables: Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG,
963 * ReqSIG0, ReqBadSIG, ReqTCP, AuthQryRej, RecQryRej, XfrRej,
964 * UpdateRej, Response, TruncatedResp, RespEDNS0, RespTSIG,
965 * RespSIG0, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral,
966 * QryNxrrset, QrySERVFAIL, QryFORMERR, QryNXDOMAIN, QryRecursion,
967 * QryDuplicate, QryDropped, QryFailure, XfrReqDone, UpdateReqFwd,
968 * UpdateRespFwd, UpdateFwdFail, UpdateDone, UpdateFail,
972 * <Requestv4>1</Requestv4>
973 * <Requestv6>0</Requestv6>
978 * <name>Requestv4</name>
979 * <counter>1</counter>
982 * <name>Requestv6</name>
983 * <counter>0</counter>
987 if (global_server_stats)
989 translation_table_ptr_t table_ptr =
991 nsstats_translation_table,
992 nsstats_translation_table_length,
993 /* plugin_instance = */ "global-server_stats"
998 bind_parse_generic_value_list ("server/nsstats",
999 /* callback = */ bind_xml_table_callback,
1000 /* user_data = */ &table_ptr,
1001 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1005 bind_parse_generic_name_value ("server/nsstat",
1006 /* callback = */ bind_xml_table_callback,
1007 /* user_data = */ &table_ptr,
1008 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1012 /* XPath: server/zonestats, server/zonestat
1013 * Variables: NotifyOutv4, NotifyOutv6, NotifyInv4, NotifyInv6, NotifyRej,
1014 * SOAOutv4, SOAOutv6, AXFRReqv4, AXFRReqv6, IXFRReqv4, IXFRReqv6,
1015 * XfrSuccess, XfrFail
1018 * <NotifyOutv4>0</NotifyOutv4>
1019 * <NotifyOutv6>0</NotifyOutv6>
1024 * <name>NotifyOutv4</name>
1025 * <counter>0</counter>
1028 * <name>NotifyOutv6</name>
1029 * <counter>0</counter>
1033 if (global_zone_maint_stats)
1035 translation_table_ptr_t table_ptr =
1037 zonestats_translation_table,
1038 zonestats_translation_table_length,
1039 /* plugin_instance = */ "global-zone_maint_stats"
1044 bind_parse_generic_value_list ("server/zonestats",
1045 /* callback = */ bind_xml_table_callback,
1046 /* user_data = */ &table_ptr,
1047 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1051 bind_parse_generic_name_value ("server/zonestat",
1052 /* callback = */ bind_xml_table_callback,
1053 /* user_data = */ &table_ptr,
1054 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1058 /* XPath: server/resstats
1059 * Variables: Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL,
1060 * FORMERR, OtherError, EDNS0Fail, Mismatch, Truncated, Lame,
1061 * Retry, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail,
1062 * GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk, ValFail
1065 * <Queryv4>0</Queryv4>
1066 * <Queryv6>0</Queryv6>
1071 * <name>Queryv4</name>
1072 * <counter>0</counter>
1075 * <name>Queryv6</name>
1076 * <counter>0</counter>
1080 if (global_resolver_stats != 0)
1082 translation_table_ptr_t table_ptr =
1084 resstats_translation_table,
1085 resstats_translation_table_length,
1086 /* plugin_instance = */ "global-resolver_stats"
1091 bind_parse_generic_value_list ("server/resstats",
1092 /* callback = */ bind_xml_table_callback,
1093 /* user_data = */ &table_ptr,
1094 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1098 bind_parse_generic_name_value ("server/resstat",
1099 /* callback = */ bind_xml_table_callback,
1100 /* user_data = */ &table_ptr,
1101 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1105 /* XPath: memory/summary
1106 * Variables: TotalUse, InUse, BlockSize, ContextSize, Lost
1109 * <TotalUse>6587096</TotalUse>
1110 * <InUse>1345424</InUse>
1111 * <BlockSize>5505024</BlockSize>
1112 * <ContextSize>3732456</ContextSize>
1116 if (global_memory_stats != 0)
1118 translation_table_ptr_t table_ptr =
1120 memsummary_translation_table,
1121 memsummary_translation_table_length,
1122 /* plugin_instance = */ "global-memory_stats"
1125 bind_parse_generic_value_list ("memory/summary",
1126 /* callback = */ bind_xml_table_callback,
1127 /* user_data = */ &table_ptr,
1128 doc, xpathCtx, current_time, DS_TYPE_GAUGE);
1132 bind_xml_stats_search_views (version, doc, xpathCtx, statsnode,
1136 } /* }}} int bind_xml_stats */
1138 static int bind_xml (const char *data) /* {{{ */
1141 xmlXPathContext *xpathCtx = NULL;
1142 xmlXPathObject *xpathObj = NULL;
1146 doc = xmlParseMemory (data, strlen (data));
1149 ERROR ("bind plugin: xmlParseMemory failed.");
1153 xpathCtx = xmlXPathNewContext (doc);
1154 if (xpathCtx == NULL)
1156 ERROR ("bind plugin: xmlXPathNewContext failed.");
1161 xpathObj = xmlXPathEvalExpression (BAD_CAST "/isc/bind/statistics", xpathCtx);
1162 if (xpathObj == NULL)
1164 ERROR ("bind plugin: Cannot find the <statistics> tag.");
1165 xmlXPathFreeContext (xpathCtx);
1169 else if (xpathObj->nodesetval == NULL)
1171 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
1172 xmlXPathFreeObject (xpathObj);
1173 xmlXPathFreeContext (xpathCtx);
1178 for (i = 0; i < xpathObj->nodesetval->nodeNr; i++)
1182 int parsed_version = 0;
1184 node = xpathObj->nodesetval->nodeTab[i];
1185 assert (node != NULL);
1187 attr_version = (char *) xmlGetProp (node, BAD_CAST "version");
1188 if (attr_version == NULL)
1190 NOTICE ("bind plugin: Found <statistics> tag doesn't have a "
1191 "`version' attribute.");
1194 DEBUG ("bind plugin: Found: <statistics version=\"%s\">", attr_version);
1196 /* At the time this plugin was written, version "1.0" was used by
1197 * BIND 9.5.0, version "2.0" was used by BIND 9.5.1 and 9.6.0. We assume
1198 * that "1.*" and "2.*" don't introduce structural changes, so we just
1199 * check for the first two characters here. */
1200 if (strncmp ("1.", attr_version, strlen ("1.")) == 0)
1202 else if (strncmp ("2.", attr_version, strlen ("2.")) == 0)
1206 /* TODO: Use the complaint mechanism here. */
1207 NOTICE ("bind plugin: Found <statistics> tag with version `%s'. "
1208 "Unfortunately I have no clue how to parse that. "
1209 "Please open a bug report for this.", attr_version);
1210 xmlFree (attr_version);
1214 ret = bind_xml_stats (parsed_version,
1215 doc, xpathCtx, node);
1217 xmlFree (attr_version);
1218 /* One <statistics> node ought to be enough. */
1222 xmlXPathFreeObject (xpathObj);
1223 xmlXPathFreeContext (xpathCtx);
1227 } /* }}} int bind_xml */
1229 static int bind_config_set_bool (const char *name, int *var, /* {{{ */
1232 if ((ci->values_num != 1) || ( ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1234 WARNING ("bind plugin: The `%s' option needs "
1235 "exactly one boolean argument.", name);
1239 if (ci->values[0].value.boolean)
1244 } /* }}} int bind_config_set_bool */
1246 static int bind_config_add_view_zone (cb_view_t *view, /* {{{ */
1251 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1253 WARNING ("bind plugin: The `Zone' option needs "
1254 "exactly one string argument.");
1258 tmp = (char **) realloc (view->zones,
1259 sizeof (char *) * (view->zones_num + 1));
1262 ERROR ("bind plugin: realloc failed.");
1267 view->zones[view->zones_num] = strdup (ci->values[0].value.string);
1268 if (view->zones[view->zones_num] == NULL)
1270 ERROR ("bind plugin: strdup failed.");
1276 } /* }}} int bind_config_add_view_zone */
1278 static int bind_config_add_view (oconfig_item_t *ci) /* {{{ */
1283 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1285 WARNING ("bind plugin: `View' blocks need exactly one string argument.");
1289 tmp = (cb_view_t *) realloc (views, sizeof (*views) * (views_num + 1));
1292 ERROR ("bind plugin: realloc failed.");
1296 tmp = views + views_num;
1298 memset (tmp, 0, sizeof (*tmp));
1300 tmp->resolver_stats = 1;
1301 tmp->cacherrsets = 1;
1305 tmp->name = strdup (ci->values[0].value.string);
1306 if (tmp->name == NULL)
1308 ERROR ("bind plugin: strdup failed.");
1313 for (i = 0; i < ci->children_num; i++)
1315 oconfig_item_t *child = ci->children + i;
1317 if (strcasecmp ("QTypes", child->key) == 0)
1318 bind_config_set_bool ("QTypes", &tmp->qtypes, child);
1319 else if (strcasecmp ("ResolverStats", child->key) == 0)
1320 bind_config_set_bool ("ResolverStats", &tmp->resolver_stats, child);
1321 else if (strcasecmp ("CacheRRSets", child->key) == 0)
1322 bind_config_set_bool ("CacheRRSets", &tmp->cacherrsets, child);
1323 else if (strcasecmp ("Zone", child->key) == 0)
1324 bind_config_add_view_zone (tmp, child);
1327 WARNING ("bind plugin: Unknown configuration option "
1328 "`%s' in view `%s' will be ignored.", child->key, tmp->name);
1330 } /* for (i = 0; i < ci->children_num; i++) */
1334 } /* }}} int bind_config_add_view */
1336 static int bind_config (oconfig_item_t *ci) /* {{{ */
1340 for (i = 0; i < ci->children_num; i++)
1342 oconfig_item_t *child = ci->children + i;
1344 if (strcasecmp ("Url", child->key) == 0) {
1345 if ((child->values_num != 1) || (child->values[0].type != OCONFIG_TYPE_STRING))
1347 WARNING ("bind plugin: The `Url' option needs "
1348 "exactly one string argument.");
1352 url = strdup (child->values[0].value.string);
1353 } else if (strcasecmp ("OpCodes", child->key) == 0)
1354 bind_config_set_bool ("OpCodes", &global_opcodes, child);
1355 else if (strcasecmp ("QTypes", child->key) == 0)
1356 bind_config_set_bool ("QTypes", &global_qtypes, child);
1357 else if (strcasecmp ("ServerStats", child->key) == 0)
1358 bind_config_set_bool ("ServerStats", &global_server_stats, child);
1359 else if (strcasecmp ("ZoneMaintStats", child->key) == 0)
1360 bind_config_set_bool ("ZoneMaintStats", &global_zone_maint_stats, child);
1361 else if (strcasecmp ("ResolverStats", child->key) == 0)
1362 bind_config_set_bool ("ResolverStats", &global_resolver_stats, child);
1363 else if (strcasecmp ("MemoryStats", child->key) == 0)
1364 bind_config_set_bool ("MemoryStats", &global_memory_stats, child);
1365 else if (strcasecmp ("View", child->key) == 0)
1366 bind_config_add_view (child);
1369 WARNING ("bind plugin: Unknown configuration option "
1370 "`%s' will be ignored.", child->key);
1375 } /* }}} int bind_config */
1377 static int bind_init (void) /* {{{ */
1382 curl = curl_easy_init ();
1385 ERROR ("bind plugin: bind_init: curl_easy_init failed.");
1389 curl_easy_setopt (curl, CURLOPT_NOSIGNAL, 1);
1390 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, bind_curl_callback);
1391 curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
1392 curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, bind_curl_error);
1393 curl_easy_setopt (curl, CURLOPT_URL, (url != NULL) ? url : BIND_DEFAULT_URL);
1394 curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1);
1397 } /* }}} int bind_init */
1399 static int bind_read (void) /* {{{ */
1405 ERROR ("bind plugin: I don't have a CURL object.");
1409 bind_buffer_fill = 0;
1410 if (curl_easy_perform (curl) != 0)
1412 ERROR ("bind plugin: curl_easy_perform failed: %s",
1417 status = bind_xml (bind_buffer);
1422 } /* }}} int bind_read */
1424 static int bind_shutdown (void) /* {{{ */
1428 curl_easy_cleanup (curl);
1433 } /* }}} int bind_shutdown */
1435 void module_register (void)
1437 plugin_register_complex_config ("bind", bind_config);
1438 plugin_register_init ("bind", bind_init);
1439 plugin_register_read ("bind", bind_read);
1440 plugin_register_shutdown ("bind", bind_shutdown);
1441 } /* void module_register */
1443 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */