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 /* FIXME: Enabled by default for backwards compatibility. */
102 /* TODO: Remove time parsing code. */
103 static _Bool config_parse_time = 1;
105 static char *url = NULL;
106 static int global_opcodes = 1;
107 static int global_qtypes = 1;
108 static int global_server_stats = 1;
109 static int global_zone_maint_stats = 1;
110 static int global_resolver_stats = 0;
111 static int global_memory_stats = 1;
113 static cb_view_t *views = NULL;
114 static size_t views_num = 0;
116 static CURL *curl = NULL;
118 static char *bind_buffer = NULL;
119 static size_t bind_buffer_size = 0;
120 static size_t bind_buffer_fill = 0;
121 static char bind_curl_error[CURL_ERROR_SIZE];
123 /* Translation table for the `nsstats' values. */
124 static const translation_info_t nsstats_translation_table[] = /* {{{ */
127 { "Requestv4", "dns_request", "IPv4" },
128 { "Requestv6", "dns_request", "IPv6" },
129 { "ReqEdns0", "dns_request", "EDNS0" },
130 { "ReqBadEDNSVer", "dns_request", "BadEDNSVer" },
131 { "ReqTSIG", "dns_request", "TSIG" },
132 { "ReqSIG0", "dns_request", "SIG0" },
133 { "ReqBadSIG", "dns_request", "BadSIG" },
134 { "ReqTCP", "dns_request", "TCP" },
136 { "AuthQryRej", "dns_reject", "authorative" },
137 { "RecQryRej", "dns_reject", "recursive" },
138 { "XfrRej", "dns_reject", "transfer" },
139 { "UpdateRej", "dns_reject", "update" },
141 { "Response", "dns_response", "normal" },
142 { "TruncatedResp", "dns_response", "truncated" },
143 { "RespEDNS0", "dns_response", "EDNS0" },
144 { "RespTSIG", "dns_response", "TSIG" },
145 { "RespSIG0", "dns_response", "SIG0" },
147 { "QryAuthAns", "dns_query", "authorative" },
148 { "QryNoauthAns", "dns_query", "nonauth" },
149 { "QryReferral", "dns_query", "referral" },
150 { "QryRecursion", "dns_query", "recursion" },
151 { "QryDuplicate", "dns_query", "dupliate" },
152 { "QryDropped", "dns_query", "dropped" },
153 { "QryFailure", "dns_query", "failure" },
155 { "QrySuccess", "dns_rcode", "tx-NOERROR" },
156 { "QryNxrrset", "dns_rcode", "tx-NXRRSET" },
157 { "QrySERVFAIL", "dns_rcode", "tx-SERVFAIL" },
158 { "QryFORMERR", "dns_rcode", "tx-FORMERR" },
159 { "QryNXDOMAIN", "dns_rcode", "tx-NXDOMAIN" }
161 { "XfrReqDone", "type", "type_instance" },
162 { "UpdateReqFwd", "type", "type_instance" },
163 { "UpdateRespFwd", "type", "type_instance" },
164 { "UpdateFwdFail", "type", "type_instance" },
165 { "UpdateDone", "type", "type_instance" },
166 { "UpdateFail", "type", "type_instance" },
167 { "UpdateBadPrereq", "type", "type_instance" },
170 static int nsstats_translation_table_length =
171 STATIC_ARRAY_SIZE (nsstats_translation_table);
174 /* Translation table for the `zonestats' values. */
175 static const translation_info_t zonestats_translation_table[] = /* {{{ */
178 { "NotifyOutv4", "dns_notify", "tx-IPv4" },
179 { "NotifyOutv6", "dns_notify", "tx-IPv6" },
180 { "NotifyInv4", "dns_notify", "rx-IPv4" },
181 { "NotifyInv6", "dns_notify", "rx-IPv6" },
182 { "NotifyRej", "dns_notify", "rejected" },
183 /* SOA/AXFS/IXFS requests */
184 { "SOAOutv4", "dns_opcode", "SOA-IPv4" },
185 { "SOAOutv6", "dns_opcode", "SOA-IPv6" },
186 { "AXFRReqv4", "dns_opcode", "AXFR-IPv4" },
187 { "AXFRReqv6", "dns_opcode", "AXFR-IPv6" },
188 { "IXFRReqv4", "dns_opcode", "IXFR-IPv4" },
189 { "IXFRReqv6", "dns_opcode", "IXFR-IPv6" },
190 /* Domain transfers */
191 { "XfrSuccess", "dns_transfer", "success" },
192 { "XfrFail", "dns_transfer", "failure" }
194 static int zonestats_translation_table_length =
195 STATIC_ARRAY_SIZE (zonestats_translation_table);
198 /* Translation table for the `resstats' values. */
199 static const translation_info_t resstats_translation_table[] = /* {{{ */
201 /* Generic resolver information */
202 { "Queryv4", "dns_query", "IPv4" },
203 { "Queryv6", "dns_query", "IPv6" },
204 { "Responsev4", "dns_response", "IPv4" },
205 { "Responsev6", "dns_response", "IPv6" },
206 /* Received response codes */
207 { "NXDOMAIN", "dns_rcode", "rx-NXDOMAIN" },
208 { "SERVFAIL", "dns_rcode", "rx-SERVFAIL" },
209 { "FORMERR", "dns_rcode", "rx-FORMERR" },
210 { "OtherError", "dns_rcode", "rx-OTHER" },
211 { "EDNS0Fail", "dns_rcode", "rx-EDNS0Fail"},
212 /* Received responses */
213 { "Mismatch", "dns_response", "mismatch" },
214 { "Truncated", "dns_response", "truncated" },
215 { "Lame", "dns_response", "lame" },
216 { "Retry", "dns_query", "retry" },
218 { "GlueFetchv4", "type", "type_instance" },
219 { "GlueFetchv6", "type", "type_instance" },
220 { "GlueFetchv4Fail", "type", "type_instance" },
221 { "GlueFetchv6Fail", "type", "type_instance" },
223 /* DNSSEC information */
224 { "ValAttempt", "dns_resolver", "DNSSEC-attempt" },
225 { "ValOk", "dns_resolver", "DNSSEC-okay" },
226 { "ValNegOk", "dns_resolver", "DNSSEC-negokay" },
227 { "ValFail", "dns_resolver", "DNSSEC-fail" }
229 static int resstats_translation_table_length =
230 STATIC_ARRAY_SIZE (resstats_translation_table);
233 /* Translation table for the `memory/summary' values. */
234 static const translation_info_t memsummary_translation_table[] = /* {{{ */
236 { "TotalUse", "memory", "TotalUse" },
237 { "InUse", "memory", "InUse" },
238 { "BlockSize", "memory", "BlockSize" },
239 { "ContextSize", "memory", "ContextSize" },
240 { "Lost", "memory", "Lost" }
242 static int memsummary_translation_table_length =
243 STATIC_ARRAY_SIZE (memsummary_translation_table);
246 static void submit (time_t ts, const char *plugin_instance, /* {{{ */
247 const char *type, const char *type_instance, value_t value)
250 value_list_t vl = VALUE_LIST_INIT;
256 if (config_parse_time)
257 vl.time = TIME_T_TO_CDTIME_T (ts);
258 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
259 sstrncpy(vl.plugin, "bind", sizeof(vl.plugin));
260 if (plugin_instance) {
261 sstrncpy(vl.plugin_instance, plugin_instance,
262 sizeof(vl.plugin_instance));
263 replace_special (vl.plugin_instance, sizeof (vl.plugin_instance));
265 sstrncpy(vl.type, type, sizeof(vl.type));
267 sstrncpy(vl.type_instance, type_instance,
268 sizeof(vl.type_instance));
269 replace_special (vl.plugin_instance, sizeof (vl.plugin_instance));
271 plugin_dispatch_values(&vl);
272 } /* }}} void submit */
274 static size_t bind_curl_callback (void *buf, size_t size, /* {{{ */
275 size_t nmemb, void __attribute__((unused)) *stream)
277 size_t len = size * nmemb;
282 if ((bind_buffer_fill + len) >= bind_buffer_size)
286 temp = realloc(bind_buffer, bind_buffer_fill + len + 1);
289 ERROR ("bind plugin: realloc failed.");
293 bind_buffer_size = bind_buffer_fill + len + 1;
296 memcpy (bind_buffer + bind_buffer_fill, (char *) buf, len);
297 bind_buffer_fill += len;
298 bind_buffer[bind_buffer_fill] = 0;
301 } /* }}} size_t bind_curl_callback */
304 * Callback, that's called with a translation table.
305 * (Plugin instance is fixed, type and type instance come from lookup table.)
307 static int bind_xml_table_callback (const char *name, value_t value, /* {{{ */
308 time_t current_time, void *user_data)
310 translation_table_ptr_t *table = (translation_table_ptr_t *) user_data;
316 for (i = 0; i < table->table_length; i++)
318 if (strcmp (table->table[i].xml_name, name) != 0)
321 submit (current_time,
322 table->plugin_instance,
323 table->table[i].type,
324 table->table[i].type_instance,
330 } /* }}} int bind_xml_table_callback */
333 * Callback, that's used for lists.
334 * (Plugin instance and type are fixed, xml name is used as type instance.)
336 static int bind_xml_list_callback (const char *name, /* {{{ */
337 value_t value, time_t current_time, void *user_data)
339 list_info_ptr_t *list_info = (list_info_ptr_t *) user_data;
341 if (list_info == NULL)
344 submit (current_time,
345 list_info->plugin_instance,
347 /* type instance = */ name,
351 } /* }}} int bind_xml_list_callback */
353 static int bind_xml_read_derive (xmlDoc *doc, xmlNode *node, /* {{{ */
360 str_ptr = (char *) xmlNodeListGetString (doc, node->xmlChildrenNode, 1);
363 ERROR ("bind plugin: bind_xml_read_derive: xmlNodeListGetString failed.");
367 status = parse_value (str_ptr, &value, DS_TYPE_DERIVE);
370 ERROR ("bind plugin: Parsing string \"%s\" to derive value failed.",
375 *ret_value = value.derive;
377 } /* }}} int bind_xml_read_derive */
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 = mktime(&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,
487 time_t current_time, int ds_type)
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 if (ds_type == DS_TYPE_GAUGE)
536 status = bind_xml_read_gauge (doc, counter, &value.gauge);
538 status = bind_xml_read_derive (doc, counter, &value.derive);
542 status = (*list_callback) (name, value, current_time, user_data);
550 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
551 num_entries, (num_entries == 1) ? "entry" : "entries",
554 xmlXPathFreeObject(xpathObj);
557 } /* }}} int bind_parse_generic_name_value */
560 * bind_parse_generic_value_list
562 * Reads statistics in the form:
570 static int bind_parse_generic_value_list (const char *xpath_expression, /* {{{ */
571 list_callback_t list_callback,
573 xmlDoc *doc, xmlXPathContext *xpathCtx,
574 time_t current_time, int ds_type)
576 xmlXPathObject *xpathObj = NULL;
580 xpathObj = xmlXPathEvalExpression(BAD_CAST xpath_expression, xpathCtx);
581 if (xpathObj == NULL)
583 ERROR("bind plugin: Unable to evaluate XPath expression `%s'.",
589 /* Iterate over all matching nodes. */
590 for (i = 0; xpathObj->nodesetval && (i < xpathObj->nodesetval->nodeNr); i++)
594 /* Iterate over all child nodes. */
595 for (child = xpathObj->nodesetval->nodeTab[i]->xmlChildrenNode;
603 if (child->type != XML_ELEMENT_NODE)
606 node_name = (char *) child->name;
608 if (ds_type == DS_TYPE_GAUGE)
609 status = bind_xml_read_gauge (doc, child, &value.gauge);
611 status = bind_xml_read_derive (doc, child, &value.derive);
615 status = (*list_callback) (node_name, value, current_time, user_data);
621 DEBUG ("bind plugin: Found %d %s for XPath expression `%s'",
622 num_entries, (num_entries == 1) ? "entry" : "entries",
625 xmlXPathFreeObject(xpathObj);
628 } /* }}} int bind_parse_generic_value_list */
630 static int bind_xml_stats_handle_zone (int version, xmlDoc *doc, /* {{{ */
631 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
634 xmlXPathObject *path_obj;
635 char *zone_name = NULL;
639 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
640 if (path_obj == NULL)
642 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
646 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
648 zone_name = (char *) xmlNodeListGetString (doc,
649 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
650 if (zone_name != NULL)
654 if (zone_name == NULL)
656 ERROR ("bind plugin: Could not determine zone name.");
657 xmlXPathFreeObject (path_obj);
661 for (j = 0; j < view->zones_num; j++)
663 if (strcasecmp (zone_name, view->zones[j]) == 0)
672 xmlXPathFreeObject (path_obj);
676 zone_name = view->zones[j];
678 DEBUG ("bind plugin: bind_xml_stats_handle_zone: Found zone `%s'.",
681 { /* Parse the <counters> tag {{{ */
682 char plugin_instance[DATA_MAX_NAME_LEN];
683 translation_table_ptr_t table_ptr =
685 nsstats_translation_table,
686 nsstats_translation_table_length,
690 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-zone-%s",
691 view->name, zone_name);
693 bind_parse_generic_value_list (/* xpath = */ "counters",
694 /* callback = */ bind_xml_table_callback,
695 /* user_data = */ &table_ptr,
696 doc, path_ctx, current_time, DS_TYPE_COUNTER);
699 xmlXPathFreeObject (path_obj);
702 } /* }}} int bind_xml_stats_handle_zone */
704 static int bind_xml_stats_search_zones (int version, xmlDoc *doc, /* {{{ */
705 xmlXPathContext *path_ctx, xmlNode *node, cb_view_t *view,
708 xmlXPathObject *zone_nodes = NULL;
709 xmlXPathContext *zone_path_context;
712 zone_path_context = xmlXPathNewContext (doc);
713 if (zone_path_context == NULL)
715 ERROR ("bind plugin: xmlXPathNewContext failed.");
719 zone_nodes = xmlXPathEvalExpression (BAD_CAST "zones/zone", path_ctx);
720 if (zone_nodes == NULL)
722 ERROR ("bind plugin: Cannot find any <view> tags.");
723 xmlXPathFreeContext (zone_path_context);
727 for (i = 0; i < zone_nodes->nodesetval->nodeNr; i++)
731 node = zone_nodes->nodesetval->nodeTab[i];
732 assert (node != NULL);
734 zone_path_context->node = node;
736 bind_xml_stats_handle_zone (version, doc, zone_path_context, node, view,
740 xmlXPathFreeObject (zone_nodes);
741 xmlXPathFreeContext (zone_path_context);
743 } /* }}} int bind_xml_stats_search_zones */
745 static int bind_xml_stats_handle_view (int version, xmlDoc *doc, /* {{{ */
746 xmlXPathContext *path_ctx, xmlNode *node, time_t current_time)
748 xmlXPathObject *path_obj;
749 char *view_name = NULL;
754 path_obj = xmlXPathEvalExpression (BAD_CAST "name", path_ctx);
755 if (path_obj == NULL)
757 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
761 for (i = 0; path_obj->nodesetval && (i < path_obj->nodesetval->nodeNr); i++)
763 view_name = (char *) xmlNodeListGetString (doc,
764 path_obj->nodesetval->nodeTab[i]->xmlChildrenNode, 1);
765 if (view_name != NULL)
769 if (view_name == NULL)
771 ERROR ("bind plugin: Could not determine view name.");
772 xmlXPathFreeObject (path_obj);
776 for (j = 0; j < views_num; j++)
778 if (strcasecmp (view_name, views[j].name) == 0)
783 xmlXPathFreeObject (path_obj);
793 DEBUG ("bind plugin: bind_xml_stats_handle_view: Found view `%s'.",
796 if (view->qtypes != 0) /* {{{ */
798 char plugin_instance[DATA_MAX_NAME_LEN];
799 list_info_ptr_t list_info =
802 /* type = */ "dns_qtype"
805 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-qtypes",
808 bind_parse_generic_name_value (/* xpath = */ "rdtype",
809 /* callback = */ bind_xml_list_callback,
810 /* user_data = */ &list_info,
811 doc, path_ctx, current_time, DS_TYPE_COUNTER);
814 if (view->resolver_stats != 0) /* {{{ */
816 char plugin_instance[DATA_MAX_NAME_LEN];
817 translation_table_ptr_t table_ptr =
819 resstats_translation_table,
820 resstats_translation_table_length,
824 ssnprintf (plugin_instance, sizeof (plugin_instance),
825 "%s-resolver_stats", view->name);
827 bind_parse_generic_name_value ("resstat",
828 /* callback = */ bind_xml_table_callback,
829 /* user_data = */ &table_ptr,
830 doc, path_ctx, current_time, DS_TYPE_COUNTER);
833 /* Record types in the cache */
834 if (view->cacherrsets != 0) /* {{{ */
836 char plugin_instance[DATA_MAX_NAME_LEN];
837 list_info_ptr_t list_info =
840 /* type = */ "dns_qtype_cached"
843 ssnprintf (plugin_instance, sizeof (plugin_instance), "%s-cache_rr_sets",
846 bind_parse_generic_name_value (/* xpath = */ "cache/rrset",
847 /* callback = */ bind_xml_list_callback,
848 /* user_data = */ &list_info,
849 doc, path_ctx, current_time, DS_TYPE_GAUGE);
852 if (view->zones_num > 0)
853 bind_xml_stats_search_zones (version, doc, path_ctx, node, view,
857 } /* }}} int bind_xml_stats_handle_view */
859 static int bind_xml_stats_search_views (int version, xmlDoc *doc, /* {{{ */
860 xmlXPathContext *xpathCtx, xmlNode *statsnode, time_t current_time)
862 xmlXPathObject *view_nodes = NULL;
863 xmlXPathContext *view_path_context;
866 view_path_context = xmlXPathNewContext (doc);
867 if (view_path_context == NULL)
869 ERROR ("bind plugin: xmlXPathNewContext failed.");
873 view_nodes = xmlXPathEvalExpression (BAD_CAST "views/view", xpathCtx);
874 if (view_nodes == NULL)
876 ERROR ("bind plugin: Cannot find any <view> tags.");
877 xmlXPathFreeContext (view_path_context);
881 for (i = 0; i < view_nodes->nodesetval->nodeNr; i++)
885 node = view_nodes->nodesetval->nodeTab[i];
886 assert (node != NULL);
888 view_path_context->node = node;
890 bind_xml_stats_handle_view (version, doc, view_path_context, node,
894 xmlXPathFreeObject (view_nodes);
895 xmlXPathFreeContext (view_path_context);
897 } /* }}} int bind_xml_stats_search_views */
899 static int bind_xml_stats (int version, xmlDoc *doc, /* {{{ */
900 xmlXPathContext *xpathCtx, xmlNode *statsnode)
902 time_t current_time = 0;
905 xpathCtx->node = statsnode;
907 /* TODO: Check `server/boot-time' to recognize server restarts. */
909 status = bind_xml_read_timestamp ("server/current-time",
910 doc, xpathCtx, ¤t_time);
913 ERROR ("bind plugin: Reading `server/current-time' failed.");
916 DEBUG ("bind plugin: Current server time is %i.", (int) current_time);
918 /* XPath: server/requests/opcode
919 * Variables: QUERY, IQUERY, NOTIFY, UPDATE, ...
923 * <counter>1</counter>
927 if (global_opcodes != 0)
929 list_info_ptr_t list_info =
931 /* plugin instance = */ "global-opcodes",
932 /* type = */ "dns_opcode"
935 bind_parse_generic_name_value (/* xpath = */ "server/requests/opcode",
936 /* callback = */ bind_xml_list_callback,
937 /* user_data = */ &list_info,
938 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
941 /* XPath: server/queries-in/rdtype
942 * Variables: RESERVED0, A, NS, CNAME, SOA, MR, PTR, HINFO, MX, TXT, RP,
943 * X25, PX, AAAA, LOC, SRV, NAPTR, A6, DS, RRSIG, NSEC, DNSKEY,
944 * SPF, TKEY, IXFR, AXFR, ANY, ..., Others
948 * <counter>1</counter>
952 if (global_qtypes != 0)
954 list_info_ptr_t list_info =
956 /* plugin instance = */ "global-qtypes",
957 /* type = */ "dns_qtype"
960 bind_parse_generic_name_value (/* xpath = */ "server/queries-in/rdtype",
961 /* callback = */ bind_xml_list_callback,
962 /* user_data = */ &list_info,
963 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
966 /* XPath: server/nsstats, server/nsstat
967 * Variables: Requestv4, Requestv6, ReqEdns0, ReqBadEDNSVer, ReqTSIG,
968 * ReqSIG0, ReqBadSIG, ReqTCP, AuthQryRej, RecQryRej, XfrRej,
969 * UpdateRej, Response, TruncatedResp, RespEDNS0, RespTSIG,
970 * RespSIG0, QrySuccess, QryAuthAns, QryNoauthAns, QryReferral,
971 * QryNxrrset, QrySERVFAIL, QryFORMERR, QryNXDOMAIN, QryRecursion,
972 * QryDuplicate, QryDropped, QryFailure, XfrReqDone, UpdateReqFwd,
973 * UpdateRespFwd, UpdateFwdFail, UpdateDone, UpdateFail,
977 * <Requestv4>1</Requestv4>
978 * <Requestv6>0</Requestv6>
983 * <name>Requestv4</name>
984 * <counter>1</counter>
987 * <name>Requestv6</name>
988 * <counter>0</counter>
992 if (global_server_stats)
994 translation_table_ptr_t table_ptr =
996 nsstats_translation_table,
997 nsstats_translation_table_length,
998 /* plugin_instance = */ "global-server_stats"
1003 bind_parse_generic_value_list ("server/nsstats",
1004 /* callback = */ bind_xml_table_callback,
1005 /* user_data = */ &table_ptr,
1006 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1010 bind_parse_generic_name_value ("server/nsstat",
1011 /* callback = */ bind_xml_table_callback,
1012 /* user_data = */ &table_ptr,
1013 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1017 /* XPath: server/zonestats, server/zonestat
1018 * Variables: NotifyOutv4, NotifyOutv6, NotifyInv4, NotifyInv6, NotifyRej,
1019 * SOAOutv4, SOAOutv6, AXFRReqv4, AXFRReqv6, IXFRReqv4, IXFRReqv6,
1020 * XfrSuccess, XfrFail
1023 * <NotifyOutv4>0</NotifyOutv4>
1024 * <NotifyOutv6>0</NotifyOutv6>
1029 * <name>NotifyOutv4</name>
1030 * <counter>0</counter>
1033 * <name>NotifyOutv6</name>
1034 * <counter>0</counter>
1038 if (global_zone_maint_stats)
1040 translation_table_ptr_t table_ptr =
1042 zonestats_translation_table,
1043 zonestats_translation_table_length,
1044 /* plugin_instance = */ "global-zone_maint_stats"
1049 bind_parse_generic_value_list ("server/zonestats",
1050 /* callback = */ bind_xml_table_callback,
1051 /* user_data = */ &table_ptr,
1052 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1056 bind_parse_generic_name_value ("server/zonestat",
1057 /* callback = */ bind_xml_table_callback,
1058 /* user_data = */ &table_ptr,
1059 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1063 /* XPath: server/resstats
1064 * Variables: Queryv4, Queryv6, Responsev4, Responsev6, NXDOMAIN, SERVFAIL,
1065 * FORMERR, OtherError, EDNS0Fail, Mismatch, Truncated, Lame,
1066 * Retry, GlueFetchv4, GlueFetchv6, GlueFetchv4Fail,
1067 * GlueFetchv6Fail, ValAttempt, ValOk, ValNegOk, ValFail
1070 * <Queryv4>0</Queryv4>
1071 * <Queryv6>0</Queryv6>
1076 * <name>Queryv4</name>
1077 * <counter>0</counter>
1080 * <name>Queryv6</name>
1081 * <counter>0</counter>
1085 if (global_resolver_stats != 0)
1087 translation_table_ptr_t table_ptr =
1089 resstats_translation_table,
1090 resstats_translation_table_length,
1091 /* plugin_instance = */ "global-resolver_stats"
1096 bind_parse_generic_value_list ("server/resstats",
1097 /* callback = */ bind_xml_table_callback,
1098 /* user_data = */ &table_ptr,
1099 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1103 bind_parse_generic_name_value ("server/resstat",
1104 /* callback = */ bind_xml_table_callback,
1105 /* user_data = */ &table_ptr,
1106 doc, xpathCtx, current_time, DS_TYPE_COUNTER);
1110 /* XPath: memory/summary
1111 * Variables: TotalUse, InUse, BlockSize, ContextSize, Lost
1114 * <TotalUse>6587096</TotalUse>
1115 * <InUse>1345424</InUse>
1116 * <BlockSize>5505024</BlockSize>
1117 * <ContextSize>3732456</ContextSize>
1121 if (global_memory_stats != 0)
1123 translation_table_ptr_t table_ptr =
1125 memsummary_translation_table,
1126 memsummary_translation_table_length,
1127 /* plugin_instance = */ "global-memory_stats"
1130 bind_parse_generic_value_list ("memory/summary",
1131 /* callback = */ bind_xml_table_callback,
1132 /* user_data = */ &table_ptr,
1133 doc, xpathCtx, current_time, DS_TYPE_GAUGE);
1137 bind_xml_stats_search_views (version, doc, xpathCtx, statsnode,
1141 } /* }}} int bind_xml_stats */
1143 static int bind_xml (const char *data) /* {{{ */
1146 xmlXPathContext *xpathCtx = NULL;
1147 xmlXPathObject *xpathObj = NULL;
1151 doc = xmlParseMemory (data, strlen (data));
1154 ERROR ("bind plugin: xmlParseMemory failed.");
1158 xpathCtx = xmlXPathNewContext (doc);
1159 if (xpathCtx == NULL)
1161 ERROR ("bind plugin: xmlXPathNewContext failed.");
1166 xpathObj = xmlXPathEvalExpression (BAD_CAST "/isc/bind/statistics", xpathCtx);
1167 if (xpathObj == NULL)
1169 ERROR ("bind plugin: Cannot find the <statistics> tag.");
1170 xmlXPathFreeContext (xpathCtx);
1174 else if (xpathObj->nodesetval == NULL)
1176 ERROR ("bind plugin: xmlXPathEvalExpression failed.");
1177 xmlXPathFreeObject (xpathObj);
1178 xmlXPathFreeContext (xpathCtx);
1183 for (i = 0; i < xpathObj->nodesetval->nodeNr; i++)
1187 int parsed_version = 0;
1189 node = xpathObj->nodesetval->nodeTab[i];
1190 assert (node != NULL);
1192 attr_version = (char *) xmlGetProp (node, BAD_CAST "version");
1193 if (attr_version == NULL)
1195 NOTICE ("bind plugin: Found <statistics> tag doesn't have a "
1196 "`version' attribute.");
1199 DEBUG ("bind plugin: Found: <statistics version=\"%s\">", attr_version);
1201 /* At the time this plugin was written, version "1.0" was used by
1202 * BIND 9.5.0, version "2.0" was used by BIND 9.5.1 and 9.6.0. We assume
1203 * that "1.*" and "2.*" don't introduce structural changes, so we just
1204 * check for the first two characters here. */
1205 if (strncmp ("1.", attr_version, strlen ("1.")) == 0)
1207 else if (strncmp ("2.", attr_version, strlen ("2.")) == 0)
1211 /* TODO: Use the complaint mechanism here. */
1212 NOTICE ("bind plugin: Found <statistics> tag with version `%s'. "
1213 "Unfortunately I have no clue how to parse that. "
1214 "Please open a bug report for this.", attr_version);
1215 xmlFree (attr_version);
1219 ret = bind_xml_stats (parsed_version,
1220 doc, xpathCtx, node);
1222 xmlFree (attr_version);
1223 /* One <statistics> node ought to be enough. */
1227 xmlXPathFreeObject (xpathObj);
1228 xmlXPathFreeContext (xpathCtx);
1232 } /* }}} int bind_xml */
1234 static int bind_config_set_bool (const char *name, int *var, /* {{{ */
1237 if ((ci->values_num != 1) || ( ci->values[0].type != OCONFIG_TYPE_BOOLEAN))
1239 WARNING ("bind plugin: The `%s' option needs "
1240 "exactly one boolean argument.", name);
1244 if (ci->values[0].value.boolean)
1249 } /* }}} int bind_config_set_bool */
1251 static int bind_config_add_view_zone (cb_view_t *view, /* {{{ */
1256 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1258 WARNING ("bind plugin: The `Zone' option needs "
1259 "exactly one string argument.");
1263 tmp = (char **) realloc (view->zones,
1264 sizeof (char *) * (view->zones_num + 1));
1267 ERROR ("bind plugin: realloc failed.");
1272 view->zones[view->zones_num] = strdup (ci->values[0].value.string);
1273 if (view->zones[view->zones_num] == NULL)
1275 ERROR ("bind plugin: strdup failed.");
1281 } /* }}} int bind_config_add_view_zone */
1283 static int bind_config_add_view (oconfig_item_t *ci) /* {{{ */
1288 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING))
1290 WARNING ("bind plugin: `View' blocks need exactly one string argument.");
1294 tmp = (cb_view_t *) realloc (views, sizeof (*views) * (views_num + 1));
1297 ERROR ("bind plugin: realloc failed.");
1301 tmp = views + views_num;
1303 memset (tmp, 0, sizeof (*tmp));
1305 tmp->resolver_stats = 1;
1306 tmp->cacherrsets = 1;
1310 tmp->name = strdup (ci->values[0].value.string);
1311 if (tmp->name == NULL)
1313 ERROR ("bind plugin: strdup failed.");
1318 for (i = 0; i < ci->children_num; i++)
1320 oconfig_item_t *child = ci->children + i;
1322 if (strcasecmp ("QTypes", child->key) == 0)
1323 bind_config_set_bool ("QTypes", &tmp->qtypes, child);
1324 else if (strcasecmp ("ResolverStats", child->key) == 0)
1325 bind_config_set_bool ("ResolverStats", &tmp->resolver_stats, child);
1326 else if (strcasecmp ("CacheRRSets", child->key) == 0)
1327 bind_config_set_bool ("CacheRRSets", &tmp->cacherrsets, child);
1328 else if (strcasecmp ("Zone", child->key) == 0)
1329 bind_config_add_view_zone (tmp, child);
1332 WARNING ("bind plugin: Unknown configuration option "
1333 "`%s' in view `%s' will be ignored.", child->key, tmp->name);
1335 } /* for (i = 0; i < ci->children_num; i++) */
1339 } /* }}} int bind_config_add_view */
1341 static int bind_config (oconfig_item_t *ci) /* {{{ */
1345 for (i = 0; i < ci->children_num; i++)
1347 oconfig_item_t *child = ci->children + i;
1349 if (strcasecmp ("Url", child->key) == 0) {
1350 if ((child->values_num != 1) || (child->values[0].type != OCONFIG_TYPE_STRING))
1352 WARNING ("bind plugin: The `Url' option needs "
1353 "exactly one string argument.");
1357 url = strdup (child->values[0].value.string);
1358 } else if (strcasecmp ("OpCodes", child->key) == 0)
1359 bind_config_set_bool ("OpCodes", &global_opcodes, child);
1360 else if (strcasecmp ("QTypes", child->key) == 0)
1361 bind_config_set_bool ("QTypes", &global_qtypes, child);
1362 else if (strcasecmp ("ServerStats", child->key) == 0)
1363 bind_config_set_bool ("ServerStats", &global_server_stats, child);
1364 else if (strcasecmp ("ZoneMaintStats", child->key) == 0)
1365 bind_config_set_bool ("ZoneMaintStats", &global_zone_maint_stats, child);
1366 else if (strcasecmp ("ResolverStats", child->key) == 0)
1367 bind_config_set_bool ("ResolverStats", &global_resolver_stats, child);
1368 else if (strcasecmp ("MemoryStats", child->key) == 0)
1369 bind_config_set_bool ("MemoryStats", &global_memory_stats, child);
1370 else if (strcasecmp ("View", child->key) == 0)
1371 bind_config_add_view (child);
1372 else if (strcasecmp ("ParseTime", child->key) == 0)
1373 cf_util_get_boolean (child, &config_parse_time);
1376 WARNING ("bind plugin: Unknown configuration option "
1377 "`%s' will be ignored.", child->key);
1382 } /* }}} int bind_config */
1384 static int bind_init (void) /* {{{ */
1389 curl = curl_easy_init ();
1392 ERROR ("bind plugin: bind_init: curl_easy_init failed.");
1396 curl_easy_setopt (curl, CURLOPT_NOSIGNAL, 1);
1397 curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, bind_curl_callback);
1398 curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
1399 curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, bind_curl_error);
1400 curl_easy_setopt (curl, CURLOPT_URL, (url != NULL) ? url : BIND_DEFAULT_URL);
1401 curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1);
1404 } /* }}} int bind_init */
1406 static int bind_read (void) /* {{{ */
1412 ERROR ("bind plugin: I don't have a CURL object.");
1416 bind_buffer_fill = 0;
1417 if (curl_easy_perform (curl) != 0)
1419 ERROR ("bind plugin: curl_easy_perform failed: %s",
1424 status = bind_xml (bind_buffer);
1429 } /* }}} int bind_read */
1431 static int bind_shutdown (void) /* {{{ */
1435 curl_easy_cleanup (curl);
1440 } /* }}} int bind_shutdown */
1442 void module_register (void)
1444 plugin_register_complex_config ("bind", bind_config);
1445 plugin_register_init ("bind", bind_init);
1446 plugin_register_read ("bind", bind_read);
1447 plugin_register_shutdown ("bind", bind_shutdown);
1448 } /* void module_register */
1450 /* vim: set sw=2 sts=2 ts=8 et fdm=marker : */