2 * daemon/stats.h - collect runtime performance indicators.
4 * Copyright (c) 2007, NLnet Labs. All rights reserved.
6 * This software is open source.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
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.
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.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
39 * This file describes the data structure used to collect runtime performance
40 * numbers. These 'statistics' may be of interest to the operator.
43 #ifndef DAEMON_STATS_H
44 #define DAEMON_STATS_H
45 #include "util/timehist.h"
46 #include <ldns/buffer.h>
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
62 /** per worker statistics */
64 /** number of queries from clients received. */
66 /** number of queries that had a cache-miss. */
67 size_t num_queries_missed_cache;
68 /** number of prefetch queries - cachehits with prefetch */
69 size_t num_queries_prefetch;
72 * Sum of the querylistsize of the worker for
73 * every query that missed cache. To calculate average.
75 size_t sum_query_list_size;
76 /** max value of query list size reached. */
77 size_t max_query_list_size;
79 /** Extended stats below (bool) */
83 size_t qtype[STATS_QTYPE_NUM];
84 /** bigger qtype values not in array */
87 size_t qclass[STATS_QCLASS_NUM];
88 /** bigger qclass values not in array */
91 size_t qopcode[STATS_OPCODE_NUM];
92 /** number of queries over TCP */
94 /** number of queries over IPv6 */
96 /** number of queries with QR bit */
98 /** number of queries with AA bit */
100 /** number of queries with TC bit */
102 /** number of queries with RD bit */
104 /** number of queries with RA bit */
106 /** number of queries with Z bit */
108 /** number of queries with AD bit */
110 /** number of queries with CD bit */
112 /** number of queries with EDNS OPT record */
114 /** number of queries with EDNS with DO flag */
117 size_t ans_rcode[STATS_RCODE_NUM];
118 /** answers with pseudo rcode 'nodata' */
119 size_t ans_rcode_nodata;
120 /** answers that were secure (AD) */
122 /** answers that were bogus (withheld as SERVFAIL) */
124 /** rrsets marked bogus by validator */
126 /** unwanted traffic received on server-facing ports */
127 size_t unwanted_replies;
128 /** unwanted traffic received on client-facing ports */
129 size_t unwanted_queries;
131 /** histogram data exported to array
132 * if the array is the same size, no data is lost, and
133 * if all histograms are same size (is so by default) then
134 * adding up works well. */
135 size_t hist[NUM_BUCKETS_HIST];
139 * Statistics to send over the control pipe when asked
140 * This struct is made to be memcpied, sent in binary.
143 /** the thread stats */
144 struct server_stats svr;
146 /** mesh stats: current number of states */
147 size_t mesh_num_states;
148 /** mesh stats: current number of reply (user) states */
149 size_t mesh_num_reply_states;
150 /** mesh stats: number of reply states overwritten with a new one */
152 /** mesh stats: number of incoming queries dropped */
154 /** mesh stats: replies sent */
155 size_t mesh_replies_sent;
156 /** mesh stats: sum of waiting times for the replies */
157 struct timeval mesh_replies_sum_wait;
158 /** mesh stats: median of waiting times for replies (in sec) */
159 double mesh_time_median;
163 * Initialize server stats to 0.
164 * @param stats: what to init (this is alloced by the caller).
165 * @param cfg: with extended statistics option.
167 void server_stats_init(struct server_stats* stats, struct config_file* cfg);
169 /** add query if it missed the cache */
170 void server_stats_querymiss(struct server_stats* stats, struct worker* worker);
172 /** add query if was cached and also resulted in a prefetch */
173 void server_stats_prefetch(struct server_stats* stats, struct worker* worker);
175 /** display the stats to the log */
176 void server_stats_log(struct server_stats* stats, struct worker* worker,
180 * Obtain the stats info for a given thread. Uses pipe to communicate.
181 * @param worker: the worker that is executing (the first worker).
182 * @param who: on who to get the statistics info.
183 * @param s: the stats block to fill in.
184 * @param reset: if stats can be reset.
186 void server_stats_obtain(struct worker* worker, struct worker* who,
187 struct stats_info* s, int reset);
190 * Compile stats into structure for this thread worker.
191 * Also clears the statistics counters (if that is set by config file).
192 * @param worker: the worker to compile stats for, also the executing worker.
193 * @param s: stats block.
194 * @param reset: if true, depending on config stats are reset.
195 * if false, statistics are not reset.
197 void server_stats_compile(struct worker* worker, struct stats_info* s,
201 * Send stats over comm tube in reply to query cmd
202 * @param worker: this worker.
203 * @param reset: if true, depending on config stats are reset.
204 * if false, statistics are not reset.
206 void server_stats_reply(struct worker* worker, int reset);
210 * @param total: sum of the two entries.
211 * @param a: to add to it.
213 void server_stats_add(struct stats_info* total, struct stats_info* a);
216 * Add stats for this query
217 * @param stats: the stats
218 * @param c: commpoint with type and buffer.
219 * @param qtype: query type
220 * @param qclass: query class
221 * @param edns: edns record
222 * @param repinfo: reply info with remote address
224 void server_stats_insquery(struct server_stats* stats, struct comm_point* c,
225 uint16_t qtype, uint16_t qclass, struct edns_data* edns,
226 struct comm_reply* repinfo);
229 * Add rcode for this query.
230 * @param stats: the stats
231 * @param buf: buffer with rcode. If buffer is length0: not counted.
233 void server_stats_insrcode(struct server_stats* stats, ldns_buffer* buf);
235 #endif /* DAEMON_STATS_H */