forked from circonus-labs/reconnoiter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
noit_check.h
368 lines (321 loc) · 12.7 KB
/
noit_check.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
/*
* Copyright (c) 2007, OmniTI Computer Consulting, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name OmniTI Computer Consulting, Inc. nor the names
* of its contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _NOIT_CHECK_H
#define _NOIT_CHECK_H
#include "noit_defines.h"
#include <uuid/uuid.h>
#include <netinet/in.h>
#include "eventer/eventer.h"
#include "utils/noit_hash.h"
#include "utils/noit_skiplist.h"
#include "utils/noit_hooks.h"
#include "noit_conf.h"
#include "noit_console.h"
/*
* Checks:
* attrs:
* UUID
* host (target)
* check (module)
* name (identifying the check to the user if
* multiple checks of the same module are specified)
* config (params for the module)
* period (ms)
* timeout (ms)
* transient:
* eventer_t (fire)
* stats_t [inprogress, last]
* closure
*/
/* The check is currently in-flight (running) */
#define NP_RUNNING 0x00000001
/* The check has been killed by the scheduling system */
#define NP_KILLED 0x00000002
/* The check is disable and should not be run */
#define NP_DISABLED 0x00000004
/* The check is not sufficiently configured to operate */
#define NP_UNCONFIG 0x00000008
/* The check is a transient copy of another check */
#define NP_TRANSIENT 0x00000010
/* The check requires name service resolution */
#define NP_RESOLVE 0x00000020
/* Name service resolution has been compelted for the check */
#define NP_RESOLVED 0x00000040
/* This check should have 'S' lines suppressed from logging */
#define NP_SUPPRESS_STATUS 0x00001000
/* This check should have 'M' lines suppressed from logging */
#define NP_SUPPRESS_METRICS 0x00002000
/* The check should lookup IPv6 records before IPv4 */
#define NP_PREFER_IPV6 0x00004000
/* Do no fallback to IPv6 from IPv4 and vice versa */
#define NP_SINGLE_RESOLVE 0x00008000
/* Indicates that the check is receiving data passively
* and it does not do anything during invocation to collect metrics
*/
#define NP_PASSIVE_COLLECTION 0x00010000
#define PREFER_IPV4 "prefer-ipv4"
#define PREFER_IPV6 "prefer-ipv6"
#define FORCE_IPV4 "force-ipv4"
#define FORCE_IPV6 "force-ipv6"
#define NP_UNKNOWN '0' /* stats_t.{available,state} */
#define NP_AVAILABLE 'A' /* stats_t.available */
#define NP_UNAVAILABLE 'U' /* stats_t.available */
#define NP_BAD 'B' /* stats_t.state */
#define NP_GOOD 'G' /* stats_t.state */
typedef enum {
METRIC_GUESS = '0',
METRIC_INT32 = 'i',
METRIC_UINT32 = 'I',
METRIC_INT64 = 'l',
METRIC_UINT64 = 'L',
METRIC_DOUBLE = 'n',
METRIC_STRING = 's'
} metric_type_t;
typedef struct {
char *metric_name;
metric_type_t metric_type;
union {
double *n;
int32_t *i;
u_int32_t *I;
int64_t *l;
u_int64_t *L;
char *s;
void *vp; /* used for clever assignments */
} metric_value;
} metric_t;
typedef struct {
struct timeval whence;
int8_t available;
int8_t state;
u_int32_t duration;
char *status;
noit_hash_table metrics;
} stats_t;
typedef struct dep_list {
struct noit_check *check;
struct dep_list *next;
} dep_list_t;
typedef struct noit_check {
uuid_t checkid;
int8_t target_family;
union {
struct in_addr addr;
struct in6_addr addr6;
} target_addr;
char *target;
char *module;
char *name;
char *filterset;
noit_hash_table *config;
char *oncheck; /* target`name of the check that fires us */
u_int32_t period; /* period of checks in milliseconds */
u_int32_t timeout; /* timeout of check in milliseconds */
u_int32_t flags; /* NP_KILLED, NP_RUNNING, NP_TRANSIENT */
dep_list_t *causal_checks;
eventer_t fire_event;
struct timeval last_fire_time;
struct {
stats_t current;
stats_t previous;
} stats;
u_int32_t generation; /* This can roll, we don't care */
void *closure;
noit_skiplist *feeds;
char target_ip[INET6_ADDRSTRLEN];
void **module_metadata;
noit_hash_table **module_configs;
struct timeval initial_schedule_time;
} noit_check_t;
#define NOIT_CHECK_LIVE(a) ((a)->fire_event != NULL)
#define NOIT_CHECK_DISABLED(a) ((a)->flags & NP_DISABLED)
#define NOIT_CHECK_CONFIGURED(a) (((a)->flags & NP_UNCONFIG) == 0)
#define NOIT_CHECK_RUNNING(a) ((a)->flags & NP_RUNNING)
#define NOIT_CHECK_KILLED(a) ((a)->flags & NP_KILLED)
#define NOIT_CHECK_SHOULD_RESOLVE(a) ((a)->flags & NP_RESOLVE)
/* It is resolved if it is resolved or never needed to be resolved */
#define NOIT_CHECK_RESOLVED(a) (((a)->flags & NP_RESOLVED) || (((a)->flags & NP_RESOLVE) == 0))
#define NOIT_CHECK_PREFER_V6(a) ((a)->flags & NP_PREFER_IPV6)
#define NOIT_CHECK_SINGLE_RESOLVE(a) ((a)->flags & NP_SINGLE_RESOLVE)
API_EXPORT(void) noit_poller_init();
API_EXPORT(u_int64_t) noit_check_completion_count();
API_EXPORT(int) noit_poller_check_count();
API_EXPORT(int) noit_poller_transient_check_count();
API_EXPORT(void) noit_poller_reload(const char *xpath); /* NULL for all */
API_EXPORT(void) noit_poller_process_checks(const char *xpath);
API_EXPORT(void) noit_poller_make_causal_map();
API_EXPORT(void)
noit_check_fake_last_check(noit_check_t *check,
struct timeval *lc, struct timeval *_now);
API_EXPORT(int)
noit_poller_schedule(const char *target,
const char *module,
const char *name,
const char *filterset,
noit_hash_table *config,
noit_hash_table **mconfig,
u_int32_t period,
u_int32_t timeout,
const char *oncheck,
int flags,
uuid_t in,
uuid_t out);
API_EXPORT(int)
noit_check_resolve(noit_check_t *check);
API_EXPORT(int)
noit_check_update(noit_check_t *new_check,
const char *target,
const char *name,
const char *filterset,
noit_hash_table *config,
noit_hash_table **mconfig,
u_int32_t period,
u_int32_t timeout,
const char *oncheck,
int flags);
API_EXPORT(noit_boolean)
noit_check_is_valid_target(const char *str);
API_EXPORT(int)
noit_check_activate(noit_check_t *check);
API_EXPORT(int)
noit_poller_deschedule(uuid_t in);
API_EXPORT(noit_check_t *)
noit_poller_lookup(uuid_t in);
API_EXPORT(noit_check_t *)
noit_poller_lookup_by_name(char *target, char *name);
API_EXPORT(int)
noit_poller_lookup_by_ip_module(const char *ip, const char *mod,
noit_check_t **checks, int nchecks);
API_EXPORT(int)
noit_poller_target_do(const char *target, int (*f)(noit_check_t *, void *),
void *closure);
API_EXPORT(int)
noit_check_xpath(char *xpath, int len,
const char *base, const char *arg);
API_EXPORT(void)
noit_check_stats_clear(noit_check_t *check, stats_t *s);
struct _noit_module;
/* This if for modules (passive) than cannot be watched... */
API_EXPORT(void)
noit_check_passive_set_stats(noit_check_t *check,
stats_t *newstate);
/* This is for normal (active) modules... */
API_EXPORT(void)
noit_check_set_stats(noit_check_t *check,
stats_t *newstate);
API_EXPORT(metric_t *)
noit_stats_get_metric(noit_check_t *check, stats_t *, const char *);
API_EXPORT(void)
noit_stats_set_metric(noit_check_t *check,
stats_t *, const char *, metric_type_t, const void *);
API_EXPORT(void)
noit_stats_set_metric_coerce(noit_check_t *check,
stats_t *, const char *, metric_type_t,
const char *);
API_EXPORT(void)
noit_stats_log_immediate_metric(noit_check_t *check,
const char *name, metric_type_t type,
void *value);
API_EXPORT(const char *)
noit_check_available_string(int16_t available);
API_EXPORT(const char *)
noit_check_state_string(int16_t state);
API_EXPORT(int)
noit_calc_rtype_flag(char *resolve_rtype);
API_EXPORT(int)
noit_stats_snprint_metric_value(char *b, int l, metric_t *m);
API_EXPORT(int)
noit_stats_snprint_metric(char *b, int l, metric_t *m);
API_EXPORT(noit_check_t *)
noit_check_clone(uuid_t in);
API_EXPORT(void)
noit_poller_free_check(noit_check_t *checker);
API_EXPORT(noit_check_t *)
noit_check_watch(uuid_t in, int period);
API_EXPORT(noit_check_t *)
noit_check_get_watch(uuid_t in, int period);
API_EXPORT(void)
noit_check_transient_add_feed(noit_check_t *check, const char *feed);
API_EXPORT(void)
noit_check_transient_remove_feed(noit_check_t *check, const char *feed);
API_EXPORT(int)
noit_check_register_module(const char *);
API_EXPORT(int)
noit_check_registered_module_cnt();
API_EXPORT(const char *)
noit_check_registered_module(int);
API_EXPORT(void)
noit_check_set_module_metadata(noit_check_t *, int, void *, void (*freefunc)(void *));
API_EXPORT(void)
noit_check_set_module_config(noit_check_t *, int, noit_hash_table *);
API_EXPORT(void *)
noit_check_get_module_metadata(noit_check_t *, int);
API_EXPORT(noit_hash_table *)
noit_check_get_module_config(noit_check_t *, int);
/* These are from noit_check_log.c */
API_EXPORT(void) noit_check_log_check(noit_check_t *check);
API_EXPORT(void) noit_check_log_status(noit_check_t *check);
API_EXPORT(void) noit_check_log_delete(noit_check_t *check);
API_EXPORT(void) noit_check_log_bundle(noit_check_t *check);
API_EXPORT(void) noit_check_log_metrics(noit_check_t *check);
API_EXPORT(void) noit_check_log_metric(noit_check_t *check,
struct timeval *whence, metric_t *m);
API_EXPORT(void) noit_check_extended_id_split(const char *in, int len,
char *target, int target_len,
char *module, int module_len,
char *name, int name_len,
char *uuid, int uuid_len);
API_EXPORT(char *)
noit_console_check_opts(noit_console_closure_t ncct,
noit_console_state_stack_t *stack,
noit_console_state_t *dstate,
int argc, char **argv, int idx);
API_EXPORT(char *)
noit_console_conf_check_opts(noit_console_closure_t ncct,
noit_console_state_stack_t *stack,
noit_console_state_t *dstate,
int argc, char **argv, int idx);
API_EXPORT(void) check_slots_inc_tv(struct timeval *tv);
API_EXPORT(void) check_slots_dec_tv(struct timeval *tv);
NOIT_HOOK_PROTO(check_stats_set_metric,
(noit_check_t *check, stats_t *stats, metric_t *m),
void *, closure,
(void *closure, noit_check_t *check, stats_t *stats, metric_t *m))
NOIT_HOOK_PROTO(check_passive_log_stats,
(noit_check_t *check),
void *, closure,
(void *closure, noit_check_t *check))
NOIT_HOOK_PROTO(check_log_stats,
(noit_check_t *check),
void *, closure,
(void *closure, noit_check_t *check))
#endif