contrib/unbound/daemon/stats.h

   1 /*
   2  * daemon/stats.h - collect runtime performance indicators.
   3  *
   4  * Copyright (c) 2007, NLnet Labs. All rights reserved.
   5  *
   6  * This software is open source.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * Redistributions of source code must retain the above copyright notice,
  13  * this list of conditions and the following disclaimer.
  14  *
  15  * Redistributions in binary form must reproduce the above copyright notice,
  16  * this list of conditions and the following disclaimer in the documentation
  17  * and/or other materials provided with the distribution.
  18  *
  19  * Neither the name of the NLNET LABS nor the names of its contributors may
  20  * be used to endorse or promote products derived from this software without
  21  * specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  29  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  30  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 /**
  37  * \file
  38  *
  39  * This file describes the data structure used to collect runtime performance
  40  * numbers. These 'statistics' may be of interest to the operator.
  41  */
  42
  43 #ifndef DAEMON_STATS_H
  44 #define DAEMON_STATS_H
  45 #include "util/timehist.h"
  46 struct worker;
  47 struct config_file;
  48 struct comm_point;
  49 struct comm_reply;
  50 struct edns_data;
  51 struct sldns_buffer;
  52
  53 /** number of qtype that is stored for in array */
  54 #define STATS_QTYPE_NUM 256
  55 /** number of qclass that is stored for in array */
  56 #define STATS_QCLASS_NUM 256
  57 /** number of rcodes in stats */
  58 #define STATS_RCODE_NUM 16
  59 /** number of opcodes in stats */
  60 #define STATS_OPCODE_NUM 16
  61
  62 /** per worker statistics */
  63 struct server_stats {
  64         /** number of queries from clients received. */
  65         size_t num_queries;
  66         /** number of queries that have been dropped/ratelimited by ip. */
  67         size_t num_queries_ip_ratelimited;
  68         /** number of queries that had a cache-miss. */
  69         size_t num_queries_missed_cache;
  70         /** number of prefetch queries - cachehits with prefetch */
  71         size_t num_queries_prefetch;
  72
  73         /**
  74          * Sum of the querylistsize of the worker for
  75          * every query that missed cache. To calculate average.
  76          */
  77         size_t sum_query_list_size;
  78         /** max value of query list size reached. */
  79         size_t max_query_list_size;
  80
  81         /** Extended stats below (bool) */
  82         int extended;
  83
  84         /** qtype stats */
  85         size_t qtype[STATS_QTYPE_NUM];
  86         /** bigger qtype values not in array */
  87         size_t qtype_big;
  88         /** qclass stats */
  89         size_t qclass[STATS_QCLASS_NUM];
  90         /** bigger qclass values not in array */
  91         size_t qclass_big;
  92         /** query opcodes */
  93         size_t qopcode[STATS_OPCODE_NUM];
  94         /** number of queries over TCP */
  95         size_t qtcp;
  96         /** number of outgoing queries over TCP */
  97         size_t qtcp_outgoing;
  98         /** number of queries over IPv6 */
  99         size_t qipv6;
 100         /** number of queries with QR bit */
 101         size_t qbit_QR;
 102         /** number of queries with AA bit */
 103         size_t qbit_AA;
 104         /** number of queries with TC bit */
 105         size_t qbit_TC;
 106         /** number of queries with RD bit */
 107         size_t qbit_RD;
 108         /** number of queries with RA bit */
 109         size_t qbit_RA;
 110         /** number of queries with Z bit */
 111         size_t qbit_Z;
 112         /** number of queries with AD bit */
 113         size_t qbit_AD;
 114         /** number of queries with CD bit */
 115         size_t qbit_CD;
 116         /** number of queries with EDNS OPT record */
 117         size_t qEDNS;
 118         /** number of queries with EDNS with DO flag */
 119         size_t qEDNS_DO;
 120         /** answer rcodes */
 121         size_t ans_rcode[STATS_RCODE_NUM];
 122         /** answers with pseudo rcode 'nodata' */
 123         size_t ans_rcode_nodata;
 124         /** answers that were secure (AD) */
 125         size_t ans_secure;
 126         /** answers that were bogus (withheld as SERVFAIL) */
 127         size_t ans_bogus;
 128         /** rrsets marked bogus by validator */
 129         size_t rrset_bogus;
 130         /** unwanted traffic received on server-facing ports */
 131         size_t unwanted_replies;
 132         /** unwanted traffic received on client-facing ports */
 133         size_t unwanted_queries;
 134         /** usage of tcp accept list */
 135         size_t tcp_accept_usage;
 136         /** answers served from expired cache */
 137         size_t zero_ttl_responses;
 138         /** histogram data exported to array
 139          * if the array is the same size, no data is lost, and
 140          * if all histograms are same size (is so by default) then
 141          * adding up works well. */
 142         size_t hist[NUM_BUCKETS_HIST];
 143
 144         /** number of message cache entries */
 145         size_t msg_cache_count;
 146         /** number of rrset cache entries */
 147         size_t rrset_cache_count;
 148         /** number of infra cache entries */
 149         size_t infra_cache_count;
 150         /** number of key cache entries */
 151         size_t key_cache_count;
 152 };
 153
 154 /**
 155  * Statistics to send over the control pipe when asked
 156  * This struct is made to be memcpied, sent in binary.
 157  */
 158 struct stats_info {
 159         /** the thread stats */
 160         struct server_stats svr;
 161
 162         /** mesh stats: current number of states */
 163         size_t mesh_num_states;
 164         /** mesh stats: current number of reply (user) states */
 165         size_t mesh_num_reply_states;
 166         /** mesh stats: number of reply states overwritten with a new one */
 167         size_t mesh_jostled;
 168         /** mesh stats: number of incoming queries dropped */
 169         size_t mesh_dropped;
 170         /** mesh stats: replies sent */
 171         size_t mesh_replies_sent;
 172         /** mesh stats: sum of waiting times for the replies */
 173         struct timeval mesh_replies_sum_wait;
 174         /** mesh stats: median of waiting times for replies (in sec) */
 175         double mesh_time_median;
 176 };
 177
 178 /**
 179  * Initialize server stats to 0.
 180  * @param stats: what to init (this is alloced by the caller).
 181  * @param cfg: with extended statistics option.
 182  */
 183 void server_stats_init(struct server_stats* stats, struct config_file* cfg);
 184
 185 /** add query if it missed the cache */
 186 void server_stats_querymiss(struct server_stats* stats, struct worker* worker);
 187
 188 /** add query if was cached and also resulted in a prefetch */
 189 void server_stats_prefetch(struct server_stats* stats, struct worker* worker);
 190
 191 /** display the stats to the log */
 192 void server_stats_log(struct server_stats* stats, struct worker* worker,
 193         int threadnum);
 194
 195 /**
 196  * Obtain the stats info for a given thread. Uses pipe to communicate.
 197  * @param worker: the worker that is executing (the first worker).
 198  * @param who: on who to get the statistics info.
 199  * @param s: the stats block to fill in.
 200  * @param reset: if stats can be reset.
 201  */
 202 void server_stats_obtain(struct worker* worker, struct worker* who,
 203         struct stats_info* s, int reset);
 204
 205 /**
 206  * Compile stats into structure for this thread worker.
 207  * Also clears the statistics counters (if that is set by config file).
 208  * @param worker: the worker to compile stats for, also the executing worker.
 209  * @param s: stats block.
 210  * @param reset: if true, depending on config stats are reset.
 211  *      if false, statistics are not reset.
 212  */
 213 void server_stats_compile(struct worker* worker, struct stats_info* s,
 214         int reset);
 215
 216 /**
 217  * Send stats over comm tube in reply to query cmd
 218  * @param worker: this worker.
 219  * @param reset: if true, depending on config stats are reset.
 220  *      if false, statistics are not reset.
 221  */
 222 void server_stats_reply(struct worker* worker, int reset);
 223
 224 /**
 225  * Addup stat blocks.
 226  * @param total: sum of the two entries.
 227  * @param a: to add to it.
 228  */
 229 void server_stats_add(struct stats_info* total, struct stats_info* a);
 230
 231 /**
 232  * Add stats for this query
 233  * @param stats: the stats
 234  * @param c: commpoint with type and buffer.
 235  * @param qtype: query type
 236  * @param qclass: query class
 237  * @param edns: edns record
 238  * @param repinfo: reply info with remote address
 239  */
 240 void server_stats_insquery(struct server_stats* stats, struct comm_point* c,
 241         uint16_t qtype, uint16_t qclass, struct edns_data* edns,
 242         struct comm_reply* repinfo);
 243
 244 /**
 245  * Add rcode for this query.
 246  * @param stats: the stats
 247  * @param buf: buffer with rcode. If buffer is length0: not counted.
 248  */
 249 void server_stats_insrcode(struct server_stats* stats, struct sldns_buffer* buf);
 250
 251 #endif /* DAEMON_STATS_H */