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
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.
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"
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 outgoing queries over TCP */
96 /** number of queries over IPv6 */
98 /** number of queries with QR bit */
100 /** number of queries with AA bit */
102 /** number of queries with TC bit */
104 /** number of queries with RD bit */
106 /** number of queries with RA bit */
108 /** number of queries with Z bit */
110 /** number of queries with AD bit */
112 /** number of queries with CD bit */
114 /** number of queries with EDNS OPT record */
116 /** number of queries with EDNS with DO flag */
119 size_t ans_rcode[STATS_RCODE_NUM];
120 /** answers with pseudo rcode 'nodata' */
121 size_t ans_rcode_nodata;
122 /** answers that were secure (AD) */
124 /** answers that were bogus (withheld as SERVFAIL) */
126 /** rrsets marked bogus by validator */
128 /** unwanted traffic received on server-facing ports */
129 size_t unwanted_replies;
130 /** unwanted traffic received on client-facing ports */
131 size_t unwanted_queries;
132 /** usage of tcp accept list */
133 size_t tcp_accept_usage;
135 /** histogram data exported to array
136 * if the array is the same size, no data is lost, and
137 * if all histograms are same size (is so by default) then
138 * adding up works well. */
139 size_t hist[NUM_BUCKETS_HIST];
141 /** number of message cache entries */
142 size_t msg_cache_count;
143 /** number of rrset cache entries */
144 size_t rrset_cache_count;
145 /** number of infra cache entries */
146 size_t infra_cache_count;
147 /** number of key cache entries */
148 size_t key_cache_count;
152 * Statistics to send over the control pipe when asked
153 * This struct is made to be memcpied, sent in binary.
156 /** the thread stats */
157 struct server_stats svr;
159 /** mesh stats: current number of states */
160 size_t mesh_num_states;
161 /** mesh stats: current number of reply (user) states */
162 size_t mesh_num_reply_states;
163 /** mesh stats: number of reply states overwritten with a new one */
165 /** mesh stats: number of incoming queries dropped */
167 /** mesh stats: replies sent */
168 size_t mesh_replies_sent;
169 /** mesh stats: sum of waiting times for the replies */
170 struct timeval mesh_replies_sum_wait;
171 /** mesh stats: median of waiting times for replies (in sec) */
172 double mesh_time_median;
176 * Initialize server stats to 0.
177 * @param stats: what to init (this is alloced by the caller).
178 * @param cfg: with extended statistics option.
180 void server_stats_init(struct server_stats* stats, struct config_file* cfg);
182 /** add query if it missed the cache */
183 void server_stats_querymiss(struct server_stats* stats, struct worker* worker);
185 /** add query if was cached and also resulted in a prefetch */
186 void server_stats_prefetch(struct server_stats* stats, struct worker* worker);
188 /** display the stats to the log */
189 void server_stats_log(struct server_stats* stats, struct worker* worker,
193 * Obtain the stats info for a given thread. Uses pipe to communicate.
194 * @param worker: the worker that is executing (the first worker).
195 * @param who: on who to get the statistics info.
196 * @param s: the stats block to fill in.
197 * @param reset: if stats can be reset.
199 void server_stats_obtain(struct worker* worker, struct worker* who,
200 struct stats_info* s, int reset);
203 * Compile stats into structure for this thread worker.
204 * Also clears the statistics counters (if that is set by config file).
205 * @param worker: the worker to compile stats for, also the executing worker.
206 * @param s: stats block.
207 * @param reset: if true, depending on config stats are reset.
208 * if false, statistics are not reset.
210 void server_stats_compile(struct worker* worker, struct stats_info* s,
214 * Send stats over comm tube in reply to query cmd
215 * @param worker: this worker.
216 * @param reset: if true, depending on config stats are reset.
217 * if false, statistics are not reset.
219 void server_stats_reply(struct worker* worker, int reset);
223 * @param total: sum of the two entries.
224 * @param a: to add to it.
226 void server_stats_add(struct stats_info* total, struct stats_info* a);
229 * Add stats for this query
230 * @param stats: the stats
231 * @param c: commpoint with type and buffer.
232 * @param qtype: query type
233 * @param qclass: query class
234 * @param edns: edns record
235 * @param repinfo: reply info with remote address
237 void server_stats_insquery(struct server_stats* stats, struct comm_point* c,
238 uint16_t qtype, uint16_t qclass, struct edns_data* edns,
239 struct comm_reply* repinfo);
242 * Add rcode for this query.
243 * @param stats: the stats
244 * @param buf: buffer with rcode. If buffer is length0: not counted.
246 void server_stats_insrcode(struct server_stats* stats, struct sldns_buffer* buf);
248 #endif /* DAEMON_STATS_H */