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, 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;
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_counter (xmlDoc *doc, xmlNode *node, /* {{{ */
349 counter_t *ret_value)
351 char *str_ptr, *end_ptr;
354 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
357 ERROR ("bind plugin: bind_xml_read_counter: xmlNodeListGetString failed.");
362 value = strtoll (str_ptr, &end_ptr, 10);
364 if (str_ptr == end_ptr || errno)
366 if (errno && (value < 0))
367 ERROR ("bind plugin: bind_xml_read_counter: strtoll failed with underflow.");
368 else if (errno && (value > 0))
369 ERROR ("bind plugin: bind_xml_read_counter: strtoll failed with overflow.");
371 ERROR ("bind plugin: bind_xml_read_counter: strtoll failed.");
377 } /* }}} int bind_xml_read_counter */
379 static int bind_xml_read_gauge (xmlDoc *doc, xmlNode *node, /* {{{ */
382 char *str_ptr, *end_ptr;
385 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
388 ERROR ("bind plugin: bind_xml_read_gauge: xmlNodeListGetString failed.");
393 value = strtod (str_ptr, &end_ptr);
395 if (str_ptr == end_ptr || errno)
397 if (errno && (value < 0))
398 ERROR ("bind plugin: bind_xml_read_gauge: strtod failed with underflow.");
399 else if (errno && (value > 0))
400 ERROR ("bind plugin: bind_xml_read_gauge: strtod failed with overflow.");
402 ERROR ("bind plugin: bind_xml_read_gauge: strtod failed.");
406 *ret_value = (gauge_t) value;
408 } /* }}} int bind_xml_read_gauge */
410 static int bind_xml_read_timestamp (const char *xpath_expression, /* {{{ */
411 xmlDoc *doc, xmlXPathContext *xpathCtx, time_t *ret_value)
413 xmlXPathObject *xpathObj = NULL;
419 xpathObj = xmlXPathEvalExpression (BAD_CAST xpath_expression, xpathCtx);
420 if (xpathObj == NULL)
422 ERROR ("bind plugin: Unable to evaluate XPath expression `%s'.",
427 if ((xpathObj->nodesetval == NULL) || (xpathObj->nodesetval->nodeNr < 1))
429 xmlXPathFreeObject (xpathObj);
433 if (xpathObj->nodesetval->nodeNr != 1)
435 NOTICE ("bind plugin: Evaluating the XPath expression `%s' returned "
436 "%i nodes. Only handling the first one.",
437 xpath_expression, xpathObj->nodesetval->nodeNr);
440 node = xpathObj->nodesetval->nodeTab[0];
442 if (node->xmlChildrenNode == NULL)
444 ERROR ("bind plugin: bind_xml_read_timestamp: "
445 "node->xmlChildrenNode == NULL");
446 xmlXPathFreeObject (xpathObj);
450 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
453 ERROR ("bind plugin: bind_xml_read_timestamp: xmlNodeListGetString failed.");
454 xmlXPathFreeObject (xpathObj);
458 memset (&tm, 0, sizeof(tm));
459 tmp = strptime (str_ptr, "%Y-%m-%dT%T", &tm);
463 ERROR ("bind plugin: bind_xml_read_timestamp: strptime failed.");
464 xmlXPathFreeObject (xpathObj);
468 *ret_value = timegm(&tm);
470 xmlXPathFreeObject (xpathObj);
472 } /* }}} int bind_xml_read_timestamp */
475 * bind_parse_generic_name_value
477 * Reads statistics in the form:
480 * <counter>123</counter>
483 static int bind_parse_generic_name_value (const char *xpath_expression, /* {{{ */
484 list_callback_t list_callback,
486 xmlDoc *doc, xmlXPathContext *xpathCtx,
489 xmlXPathObject *xpathObj = NULL;
493 xpathObj = xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
494 if (xpathObj == NULL)
496 ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
502 /* Iterate over all matching nodes. */
503 for (i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr); i++)
505 xmlNode *name_node = NULL;
506 xmlNode *counter = NULL;
510 parent = xpathObj->nodesetval->nodeTab[i];
511 DEBUG ("bind plugin: bind_parse_generic_name_value: parent->name = %s;",
512 (char *) parent->name);
514 /* Iterate over all child nodes. */
515 for (child = parent->xmlChildrenNode;
519 if (child->type != XML_ELEMENT_NODE)
522 if (xmlStrcmp (BAD_CAST "name", child->name) == 0)
524 else if (xmlStrcmp (BAD_CAST "counter", child->name) == 0)
528 if ((name_node != NULL) && (counter != NULL))
530 char *name = (char *) xmlNodeListGetString (doc,
531 name_node->xmlChildrenNode, 1);
535 status = bind_xml_read_counter (doc, counter, &value.counter);
539 status = (*list_callback) (name, value, current_time, user_data);
547 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
548 num_entries, (num_entries == 1) ? "entry" : "entries",
551 xmlXPathFreeObject(xpathObj);
554 } /* }}} int bind_parse_generic_name_value */
557 * bind_parse_generic_value_list
559 * Reads statistics in the form:
567 static int bind_parse_generic_value_list (const char *xpath_expression, /* {{{ */
568 list_callback_t list_callback,
570 xmlDoc *doc, xmlXPathContext *xpathCtx,
571 time_t current_time, int ds_type)
573 xmlXPathObject *xpathObj = NULL;
577 xpathObj = xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
578 if (xpathObj == NULL)
580 ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
586 /* Iterate over all matching nodes. */
587 for (i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr); i++)
591 /* Iterate over all child nodes. */
592 for (child = xpathObj->nodesetval->nodeTab[i]->xmlChildrenNode;
600 if (child->type != XML_ELEMENT_NODE)
603 node_name = (char *) child->name;
605 if (ds_type == DS_TYPE_GAUGE)
606 status = bind_xml_read_gauge (doc, child, &value.gauge);
608 status = bind_xml_read_counter (doc, child, &value.counter);
612 status = (*list_callback) (node_name, value, current_time, user_data);
618 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
619 num_entries, (num_entries == 1) ? "entry" : "entries",
622 xmlXPathFreeObject(xpathObj);
625 } /* }}} int bind_parse_generic_value_list */
627 static int bind_xml_stats_handle_zone (int version, xmlDoc *doc, /* {{{ */
628 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
631 xmlXPathObject *path_obj;
632 char *zone_name = NULL;
636 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
637 if (path_obj == NULL)
639 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
643 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
645 zone_name = (char *) xmlNodeListGetString (doc,
646 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
647 if (zone_name != NULL)
651 if (zone_name == NULL)
653 ERROR ("bind plugin: Could not determine zone name.");
654 xmlXPathFreeObject (path_obj);
658 for (j = 0; j < view->zones_num; j++)
660 if (strcasecmp (zone_name, view->zones[j]) == 0)
669 xmlXPathFreeObject (path_obj);
673 zone_name = view->zones[j];
675 DEBUG ("bind plugin: bind_xml_stats_handle_zone: Found zone `%s'.",
678 { /* Parse the <counters> tag {{{ */
679 char plugin_instance[DATA_MAX_NAME_LEN];
680 translation_table_ptr_t table_ptr =
682 nsstats_translation_table,
683 nsstats_translation_table_length,
687 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-zone-%s",
688 view->name, zone_name);
690 bind_parse_generic_value_list (/* xpath = */ "counters",
691 /* callback = */ bind_xml_table_callback,
692 /* user_data = */ &table_ptr,
693 doc, path_ctx, current_time, DS_TYPE_COUNTER);
696 xmlXPathFreeObject (path_obj);
699 } /* }}} int bind_xml_stats_handle_zone */
701 static int bind_xml_stats_search_zones (int version, xmlDoc *doc, /* {{{ */
702 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
705 xmlXPathObject *zone_nodes = NULL;
706 xmlXPathContext *zone_path_context;
709 zone_path_context = xmlXPathNewContext (doc);
710 if (zone_path_context == NULL)
712 ERROR ("bind plugin: xmlXPathNewContext failed.");
716 zone_nodes = xmlXPathEvalExpression (BAD_CAST "zones/zone", path_ctx);
717 if (zone_nodes == NULL)
719 ERROR ("bind plugin: Cannot find any <view> tags.");
720 xmlXPathFreeContext (zone_path_context);
724 for (i = 0; i < zone_nodes->nodesetval->nodeNr; i++)
728 node = zone_nodes->nodesetval->nodeTab[i];
729 assert (node != NULL);
731 zone_path_context->node = node;
733 bind_xml_stats_handle_zone (version, doc, zone_path_context, node, view,
737 xmlXPathFreeObject (zone_nodes);
738 xmlXPathFreeContext (zone_path_context);
740 } /* }}} int bind_xml_stats_search_zones */
742 static int bind_xml_stats_handle_view (int version, xmlDoc *doc, /* {{{ */
743 xmlXPathContext *path_ctx, xmlNode *node, time_t current_time)
745 xmlXPathObject *path_obj;
746 char *view_name = NULL;
751 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
752 if (path_obj == NULL)
754 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
758 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
760 view_name = (char *) xmlNodeListGetString (doc,
761 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
762 if (view_name != NULL)
766 if (view_name == NULL)
768 ERROR ("bind plugin: Could not determine view name.");
769 xmlXPathFreeObject (path_obj);
773 for (j = 0; j < views_num; j++)
775 if (strcasecmp (view_name, views[j].name) == 0)
780 xmlXPathFreeObject (path_obj);
790 DEBUG ("bind plugin: bind_xml_stats_handle_view: Found view `%s'.",
793 if (view->qtypes != 0) /* {{{ */
795 char plugin_instance[DATA_MAX_NAME_LEN];
796 list_info_ptr_t list_info =
799 /* type = */ "dns_qtype"
802 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-qtypes",
805 bind_parse_generic_name_value (/* xpath = */ "rdtype",
806 /* callback = */ bind_xml_list_callback,
807 /* user_data = */ &list_info,
808 doc, path_ctx, current_time);
811 if (view->resolver_stats != 0) /* {{{ */
813 char plugin_instance[DATA_MAX_NAME_LEN];
814 translation_table_ptr_t table_ptr =
816 resstats_translation_table,
817 resstats_translation_table_length,
821 ssnprintf (plugin_instance, sizeof (plugin_instance),
822 "%s-resolver_stats", view->name);
824 bind_parse_generic_name_value ("resstat",
825 /* callback = */ bind_xml_table_callback,
826 /* user_data = */ &table_ptr,
827 doc, path_ctx, current_time);
830 if (view->cacherrsets != 0) /* {{{ */
832 char plugin_instance[DATA_MAX_NAME_LEN];
833 list_info_ptr_t list_info =
836 /* type = */ "dns_qtype"
839 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-cache_rr_sets",
842 bind_parse_generic_name_value (/* xpath = */ "cache/rrset",
843 /* callback = */ bind_xml_list_callback,
844 /* user_data = */ &list_info,
845 doc, path_ctx, current_time);
848 if (view->zones_num > 0)
849 bind_xml_stats_search_zones (version, doc, path_ctx, node, view,
853 } /* }}} int bind_xml_stats_handle_view */
855 static int bind_xml_stats_search_views (int version, xmlDoc *doc, /* {{{ */
856 xmlXPathContext *xpathCtx, xmlNode *statsnode, time_t current_time)
858 xmlXPathObject *view_nodes = NULL;
859 xmlXPathContext *view_path_context;
862 view_path_context = xmlXPathNewContext (doc);
863 if (view_path_context == NULL)
865 ERROR ("bind plugin: xmlXPathNewContext failed.");
869 view_nodes = xmlXPathEvalExpression (BAD_CAST "views/view", xpathCtx);
870 if (view_nodes == NULL)
872 ERROR ("bind plugin: Cannot find any <view> tags.");
873 xmlXPathFreeContext (view_path_context);
877 for (i = 0; i < view_nodes->nodesetval->nodeNr; i++)
881 node = view_nodes->nodesetval->nodeTab[i];
882 assert (node != NULL);
884 view_path_context->node = node;
886 bind_xml_stats_handle_view (version, doc, view_path_context, node,
890 xmlXPathFreeObject (view_nodes);
891 xmlXPathFreeContext (view_path_context);
893 } /* }}} int bind_xml_stats_search_views */
895 static int bind_xml_stats (int version, xmlDoc *doc, /* {{{ */
896 xmlXPathContext *xpathCtx, xmlNode *statsnode)
898 time_t current_time = 0;
901 xpathCtx->node = statsnode;
903 /* TODO: Check `server/boot-time' to recognize server restarts. */
905 status = bind_xml_read_timestamp ("server/current-time",
906 doc, xpathCtx, ¤t_time);
909 ERROR ("bind plugin: Reading `server/current-time' failed.");
912 DEBUG ("bind plugin: Current server time is %i.", (int) current_time);
914 /* XPath: server/requests/opcode
915 * Variables: QUERY, IQUERY, NOTIFY, UPDATE, ...
919 * <counter>1</counter>
923 if (global_opcodes != 0)
925 list_info_ptr_t list_info =
927 /* plugin instance = */ "global-opcodes",
928 /* type = */ "dns_opcode"
931 bind_parse_generic_name_value (/* xpath = */ "server/requests/opcode",
932 /* callback = */ bind_xml_list_callback,
933 /* user_data = */ &list_info,
934 doc, xpathCtx, current_time);
937 /* XPath: server/queries-in/rdtype
938 * Variables: RESERVED0, A, NS, CNAME, SOA, MR, PTR, HINFO, MX, TXT, RP,
939 * X25, PX, AAAA, LOC, SRV, NAPTR, A6, DS, RRSIG, NSEC, DNSKEY,
940 * SPF, TKEY, IXFR, AXFR, ANY, ..., Others
944 * <counter>1</counter>
948 if (global_qtypes != 0)
950 list_info_ptr_t list_info =
952 /* plugin instance = */ "global-qtypes",
953 /* type = */ "dns_qtype"
956 bind_parse_generic_name_value (/* xpath = */ "server/queries-in/rdtype",
957 /* callback = */ bind_xml_list_callback,
958 /* user_data = */ &list_info,
959 doc, xpathCtx, current_time);
962 /* XPath: server/nsstats, server/nsstat
963 * Variables: Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG,
964 * ReqSIG0, ReqBadSIG, ReqTCP, AuthQryRej, RecQryRej, XfrRej,
965 * UpdateRej, Response, TruncatedResp, RespEDNS0, RespTSIG,
966 * RespSIG0, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral,
967 * QryNxrrset, QrySERVFAIL, QryFORMERR, QryNXDOMAIN, QryRecursion,
968 * QryDuplicate, QryDropped, QryFailure, XfrReqDone, UpdateReqFwd,
969 * UpdateRespFwd, UpdateFwdFail, UpdateDone, UpdateFail,
973 * <Requestv4>1</Requestv4>
974 * <Requestv6>0</Requestv6>
979 * <name>Requestv4</name>
980 * <counter>1</counter>
983 * <name>Requestv6</name>
984 * <counter>0</counter>
988 if (global_server_stats)
990 translation_table_ptr_t table_ptr =
992 nsstats_translation_table,
993 nsstats_translation_table_length,
994 /* plugin_instance = */ "global-server_stats"
999 bind_parse_generic_value_list ("server/nsstats",
1000 /* callback = */ bind_xml_table_callback,
1001 /* user_data = */ &table_ptr,
1002 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1006 bind_parse_generic_name_value ("server/nsstat",
1007 /* callback = */ bind_xml_table_callback,
1008 /* user_data = */ &table_ptr,
1009 doc, xpathCtx, current_time);
1013 /* XPath: server/zonestats, server/zonestat
1014 * Variables: NotifyOutv4, NotifyOutv6, NotifyInv4, NotifyInv6, NotifyRej,
1015 * SOAOutv4, SOAOutv6, AXFRReqv4, AXFRReqv6, IXFRReqv4, IXFRReqv6,
1016 * XfrSuccess, XfrFail
1019 * <NotifyOutv4>0</NotifyOutv4>
1020 * <NotifyOutv6>0</NotifyOutv6>
1025 * <name>NotifyOutv4</name>
1026 * <counter>0</counter>
1029 * <name>NotifyOutv6</name>
1030 * <counter>0</counter>
1034 if (global_zone_maint_stats)
1036 translation_table_ptr_t table_ptr =
1038 zonestats_translation_table,
1039 zonestats_translation_table_length,
1040 /* plugin_instance = */ "global-zone_maint_stats"
1045 bind_parse_generic_value_list ("server/zonestats",
1046 /* callback = */ bind_xml_table_callback,
1047 /* user_data = */ &table_ptr,
1048 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1052 bind_parse_generic_name_value ("server/zonestat",
1053 /* callback = */ bind_xml_table_callback,
1054 /* user_data = */ &table_ptr,
1055 doc, xpathCtx, current_time);
1059 /* XPath: server/resstats
1060 * Variables: Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL,
1061 * FORMERR, OtherError, EDNS0Fail, Mismatch, Truncated, Lame,
1062 * Retry, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail,
1063 * GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk, ValFail
1066 * <Queryv4>0</Queryv4>
1067 * <Queryv6>0</Queryv6>
1072 * <name>Queryv4</name>
1073 * <counter>0</counter>
1076 * <name>Queryv6</name>
1077 * <counter>0</counter>
1081 if (global_resolver_stats != 0)
1083 translation_table_ptr_t table_ptr =
1085 resstats_translation_table,
1086 resstats_translation_table_length,
1087 /* plugin_instance = */ "global-resolver_stats"
1092 bind_parse_generic_value_list ("server/resstats",
1093 /* callback = */ bind_xml_table_callback,
1094 /* user_data = */ &table_ptr,
1095 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1099 bind_parse_generic_name_value ("server/resstat",
1100 /* callback = */ bind_xml_table_callback,
1101 /* user_data = */ &table_ptr,
1102 doc, xpathCtx, current_time);
1106 /* XPath: memory/summary
1107 * Variables: TotalUse, InUse, BlockSize, ContextSize, Lost
1110 * <TotalUse>6587096</TotalUse>
1111 * <InUse>1345424</InUse>
1112 * <BlockSize>5505024</BlockSize>
1113 * <ContextSize>3732456</ContextSize>
1117 if (global_memory_stats != 0)
1119 translation_table_ptr_t table_ptr =
1121 memsummary_translation_table,
1122 memsummary_translation_table_length,
1123 /* plugin_instance = */ "global-memory_stats"
1126 bind_parse_generic_value_list ("memory/summary",
1127 /* callback = */ bind_xml_table_callback,
1128 /* user_data = */ &table_ptr,
1129 doc, xpathCtx, current_time, DS_TYPE_GAUGE);
1133 bind_xml_stats_search_views (version, doc, xpathCtx, statsnode,
1137 } /* }}} int bind_xml_stats */
1139 static int bind_xml (const char *data) /* {{{ */
1142 xmlXPathContext *xpathCtx = NULL;
1143 xmlXPathObject *xpathObj = NULL;
1147 doc = xmlParseMemory (data, strlen (data));
1150 ERROR ("bind plugin: xmlParseMemory failed.");
1154 xpathCtx = xmlXPathNewContext (doc);
1155 if (xpathCtx == NULL)
1157 ERROR ("bind plugin: xmlXPathNewContext failed.");
1162 xpathObj = xmlXPathEvalExpression (BAD_CAST "/isc/bind/statistics", xpathCtx);
1163 if (xpathObj == NULL)
1165 ERROR ("bind plugin: Cannot find the <statistics> tag.");
1166 xmlXPathFreeContext (xpathCtx);
1170 else if (xpathObj->nodesetval == NULL)
1172 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
1173 xmlXPathFreeObject (xpathObj);
1174 xmlXPathFreeContext (xpathCtx);
1179 for (i = 0; i < xpathObj->nodesetval->nodeNr; i++)
1183 int parsed_version = 0;
1185 node = xpathObj->nodesetval->nodeTab[i];
1186 assert (node != NULL);
1188 attr_version = (char *) xmlGetProp (node, BAD_CAST "version");
1189 if (attr_version == NULL)
1191 NOTICE ("bind plugin: Found <statistics> tag doesn't have a "
1192 "`version' attribute.");
1195 DEBUG ("bind plugin: Found: <statistics version=\"%s\">", attr_version);
1197 /* At the time this plugin was written, version "1.0" was used by
1198 * BIND 9.5.0, version "2.0" was used by BIND 9.5.1 and 9.6.0. We assume
1199 * that "1.*" and "2.*" don't introduce structural changes, so we just
1200 * check for the first two characters here. */
1201 if (strncmp ("1.", attr_version, strlen ("1.")) == 0)
1203 else if (strncmp ("2.", attr_version, strlen ("2.")) == 0)
1207 /* TODO: Use the complaint mechanism here. */
1208 NOTICE ("bind plugin: Found <statistics> tag with version `%s'. "
1209 "Unfortunately I have no clue how to parse that. "
1210 "Please open a bug report for this.", attr_version);
1211 xmlFree (attr_version);
1215 ret = bind_xml_stats (parsed_version,
1216 doc, xpathCtx, node);
1218 xmlFree (attr_version);
1219 /* One <statistics> node ought to be enough. */
1223 xmlXPathFreeObject (xpathObj);
1224 xmlXPathFreeContext (xpathCtx);
1228 } /* }}} int bind_xml */
1230 static int bind_config_set_bool (const char *name, int *var, /* {{{ */
1233 if ((ci->values_num != 1) || ( ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1235 WARNING ("bind plugin: The `%s' option needs "
1236 "exactly one boolean argument.", name);
1240 if (ci->values[0].value.boolean)
1245 } /* }}} int bind_config_set_bool */
1247 static int bind_config_add_view_zone (cb_view_t *view, /* {{{ */
1252 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1254 WARNING ("bind plugin: The `Zone' option needs "
1255 "exactly one string argument.");
1259 tmp = (char **) realloc (view->zones,
1260 sizeof (char *) * (view->zones_num + 1));
1263 ERROR ("bind plugin: realloc failed.");
1268 view->zones[view->zones_num] = strdup (ci->values[0].value.string);
1269 if (view->zones[view->zones_num] == NULL)
1271 ERROR ("bind plugin: strdup failed.");
1277 } /* }}} int bind_config_add_view_zone */
1279 static int bind_config_add_view (oconfig_item_t *ci) /* {{{ */
1284 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1286 WARNING ("bind plugin: `View' blocks need exactly one string argument.");
1290 tmp = (cb_view_t *) realloc (views, sizeof (*views) * (views_num + 1));
1293 ERROR ("bind plugin: realloc failed.");
1297 tmp = views + views_num;
1299 memset (tmp, 0, sizeof (*tmp));
1301 tmp->resolver_stats = 1;
1302 tmp->cacherrsets = 1;
1306 tmp->name = strdup (ci->values[0].value.string);
1307 if (tmp->name == NULL)
1309 ERROR ("bind plugin: strdup failed.");
1314 for (i = 0; i < ci->children_num; i++)
1316 oconfig_item_t *child = ci->children + i;
1318 if (strcasecmp ("QTypes", child->key) == 0)
1319 bind_config_set_bool ("QTypes", &tmp->qtypes, child);
1320 else if (strcasecmp ("ResolverStats", child->key) == 0)
1321 bind_config_set_bool ("ResolverStats", &tmp->resolver_stats, child);
1322 else if (strcasecmp ("CacheRRSets", child->key) == 0)
1323 bind_config_set_bool ("CacheRRSets", &tmp->cacherrsets, child);
1324 else if (strcasecmp ("Zone", child->key) == 0)
1325 bind_config_add_view_zone (tmp, child);
1328 WARNING ("bind plugin: Unknown configuration option "
1329 "`%s' in view `%s' will be ignored.", child->key, tmp->name);
1331 } /* for (i = 0; i < ci->children_num; i++) */
1335 } /* }}} int bind_config_add_view */
1337 static int bind_config (oconfig_item_t *ci) /* {{{ */
1341 for (i = 0; i < ci->children_num; i++)
1343 oconfig_item_t *child = ci->children + i;
1345 if (strcasecmp ("Url", child->key) == 0) {
1346 if ((child->values_num != 1) || (child->values[0].type != OCONFIG_TYPE_STRING))
1348 WARNING ("bind plugin: The `Url' option needs "
1349 "exactly one string argument.");
1353 url = strdup (child->values[0].value.string);
1354 } else if (strcasecmp ("OpCodes", child->key) == 0)
1355 bind_config_set_bool ("OpCodes", &global_opcodes, child);
1356 else if (strcasecmp ("QTypes", child->key) == 0)
1357 bind_config_set_bool ("QTypes", &global_qtypes, child);
1358 else if (strcasecmp ("ServerStats", child->key) == 0)
1359 bind_config_set_bool ("ServerStats", &global_server_stats, child);
1360 else if (strcasecmp ("ZoneMaintStats", child->key) == 0)
1361 bind_config_set_bool ("ZoneMaintStats", &global_zone_maint_stats, child);
1362 else if (strcasecmp ("ResolverStats", child->key) == 0)
1363 bind_config_set_bool ("ResolverStats", &global_resolver_stats, child);
1364 else if (strcasecmp ("MemoryStats", child->key) == 0)
1365 bind_config_set_bool ("MemoryStats", &global_memory_stats, child);
1366 else if (strcasecmp ("View", child->key) == 0)
1367 bind_config_add_view (child);
1370 WARNING ("bind plugin: Unknown configuration option "
1371 "`%s' will be ignored.", child->key);
1376 } /* }}} int bind_config */
1378 static int bind_init (void) /* {{{ */
1383 curl = curl_easy_init ();
1386 ERROR ("bind plugin: bind_init: curl_easy_init failed.");
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);
1396 } /* }}} int bind_init */
1398 static int bind_read (void) /* {{{ */
1404 ERROR ("bind plugin: I don't have a CURL object.");
1408 bind_buffer_fill = 0;
1409 if (curl_easy_perform (curl) != 0)
1411 ERROR ("bind plugin: curl_easy_perform failed: %s",
1416 status = bind_xml (bind_buffer);
1421 } /* }}} int bind_read */
1423 static int bind_shutdown (void) /* {{{ */
1427 curl_easy_cleanup (curl);
1432 } /* }}} int bind_shutdown */
1434 void module_register (void)
1436 plugin_register_complex_config ("bind", bind_config);
1437 plugin_register_init ("bind", bind_init);
1438 plugin_register_read ("bind", bind_read);
1439 plugin_register_shutdown ("bind", bind_shutdown);
1440 } /* void module_register */
1442 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */