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
|
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef NETDATA_QUERIES_RRDR_H
#define NETDATA_QUERIES_RRDR_H
#include "libnetdata/libnetdata.h"
#include "web/api/queries/query.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef enum tier_query_fetch {
TIER_QUERY_FETCH_SUM,
TIER_QUERY_FETCH_MIN,
TIER_QUERY_FETCH_MAX,
TIER_QUERY_FETCH_AVERAGE
} TIER_QUERY_FETCH;
typedef enum rrdr_options {
RRDR_OPTION_NONZERO = (1 << 0), // don't output dimensions with just zero values
RRDR_OPTION_REVERSED = (1 << 1), // output the rows in reverse order (oldest to newest)
RRDR_OPTION_ABSOLUTE = (1 << 2), // values positive, for DATASOURCE_SSV before summing
RRDR_OPTION_DIMS_MIN2MAX = (1 << 3), // when adding dimensions, use max - min, instead of sum
RRDR_OPTION_DIMS_AVERAGE = (1 << 4), // when adding dimensions, use average, instead of sum
RRDR_OPTION_DIMS_MIN = (1 << 5), // when adding dimensions, use minimum, instead of sum
RRDR_OPTION_DIMS_MAX = (1 << 6), // when adding dimensions, use maximum, instead of sum
RRDR_OPTION_SECONDS = (1 << 7), // output seconds, instead of dates
RRDR_OPTION_MILLISECONDS = (1 << 8), // output milliseconds, instead of dates
RRDR_OPTION_NULL2ZERO = (1 << 9), // do not show nulls, convert them to zeros
RRDR_OPTION_OBJECTSROWS = (1 << 10), // each row of values should be an object, not an array
RRDR_OPTION_GOOGLE_JSON = (1 << 11), // comply with google JSON/JSONP specs
RRDR_OPTION_JSON_WRAP = (1 << 12), // wrap the response in a JSON header with info about the result
RRDR_OPTION_LABEL_QUOTES = (1 << 13), // in CSV output, wrap header labels in double quotes
RRDR_OPTION_PERCENTAGE = (1 << 14), // give values as percentage of total
RRDR_OPTION_NOT_ALIGNED = (1 << 15), // do not align charts for persistent timeframes
RRDR_OPTION_DISPLAY_ABS = (1 << 16), // for badges, display the absolute value, but calculate colors with sign
RRDR_OPTION_MATCH_IDS = (1 << 17), // when filtering dimensions, match only IDs
RRDR_OPTION_MATCH_NAMES = (1 << 18), // when filtering dimensions, match only names
RRDR_OPTION_NATURAL_POINTS = (1 << 19), // return the natural points of the database
RRDR_OPTION_VIRTUAL_POINTS = (1 << 20), // return virtual points
RRDR_OPTION_ANOMALY_BIT = (1 << 21), // Return the anomaly bit stored in each collected_number
RRDR_OPTION_RETURN_RAW = (1 << 22), // Return raw data for aggregating across multiple nodes
RRDR_OPTION_RETURN_JWAR = (1 << 23), // Return anomaly rates in jsonwrap
RRDR_OPTION_SELECTED_TIER = (1 << 24), // Use the selected tier for the query
RRDR_OPTION_ALL_DIMENSIONS = (1 << 25), // Return the full dimensions list
RRDR_OPTION_SHOW_DETAILS = (1 << 26), // v2 returns detailed object tree
RRDR_OPTION_DEBUG = (1 << 27), // v2 returns request description
RRDR_OPTION_MINIFY = (1 << 28), // remove JSON spaces and newlines from JSON output
RRDR_OPTION_GROUP_BY_LABELS = (1 << 29), // v2 returns flattened labels per dimension of the chart
// internal ones - not to be exposed to the API
RRDR_OPTION_INTERNAL_AR = (1 << 31), // internal use only, to let the formatters know we want to render the anomaly rate
} RRDR_OPTIONS;
typedef enum context_v2_options {
CONTEXT_V2_OPTION_MINIFY = (1 << 0), // remove JSON spaces and newlines from JSON output
CONTEXT_V2_OPTION_DEBUG = (1 << 1), // show the request
CONTEXT_V2_OPTION_ALERTS_WITH_CONFIGURATIONS = (1 << 2), // include alert configurations (used by /api/v2/alert_transitions)
CONTEXT_V2_OPTION_ALERTS_WITH_INSTANCES = (1 << 3), // include alert instances (used by /api/v2/alerts)
CONTEXT_V2_OPTION_ALERTS_WITH_VALUES = (1 << 4), // include alert latest values (used by /api/v2/alerts)
CONTEXT_V2_OPTION_ALERTS_WITH_SUMMARY = (1 << 5), // include alerts summary counters (used by /api/v2/alerts)
} CONTEXTS_V2_OPTIONS;
typedef enum context_v2_alert_status {
CONTEXT_V2_ALERT_UNINITIALIZED = (1 << 5), // include UNINITIALIZED alerts
CONTEXT_V2_ALERT_UNDEFINED = (1 << 6), // include UNDEFINED alerts
CONTEXT_V2_ALERT_CLEAR = (1 << 7), // include CLEAR alerts
CONTEXT_V2_ALERT_RAISED = (1 << 8), // include WARNING & CRITICAL alerts
CONTEXT_V2_ALERT_WARNING = (1 << 9), // include WARNING alerts
CONTEXT_V2_ALERT_CRITICAL = (1 << 10), // include CRITICAL alerts
} CONTEXTS_V2_ALERT_STATUS;
#define CONTEXTS_V2_ALERT_STATUSES (CONTEXT_V2_ALERT_UNINITIALIZED|CONTEXT_V2_ALERT_UNDEFINED|CONTEXT_V2_ALERT_CLEAR|CONTEXT_V2_ALERT_RAISED|CONTEXT_V2_ALERT_WARNING|CONTEXT_V2_ALERT_CRITICAL)
typedef enum __attribute__ ((__packed__)) rrdr_value_flag {
// IMPORTANT:
// THIS IS AN AGREED BIT MAP BETWEEN AGENT, CLOUD FRONT-END AND CLOUD BACK-END
// DO NOT CHANGE THE MAPPINGS !
RRDR_VALUE_NOTHING = 0, // no flag set (a good default)
RRDR_VALUE_EMPTY = (1 << 0), // the database value is empty
RRDR_VALUE_RESET = (1 << 1), // the database value is marked as reset (overflown)
RRDR_VALUE_PARTIAL = (1 << 2), // the database provides partial data about this point (used in group-by)
} RRDR_VALUE_FLAGS;
typedef enum __attribute__ ((__packed__)) rrdr_dimension_flag {
RRDR_DIMENSION_DEFAULT = 0,
RRDR_DIMENSION_HIDDEN = (1 << 0), // the dimension is hidden (not to be presented to callers)
RRDR_DIMENSION_NONZERO = (1 << 1), // the dimension is non zero (contains non-zero values)
RRDR_DIMENSION_SELECTED = (1 << 2), // the dimension has been selected for query
RRDR_DIMENSION_QUERIED = (1 << 3), // the dimension has been queried
RRDR_DIMENSION_FAILED = (1 << 4), // the dimension failed to be queried
RRDR_DIMENSION_GROUPED = (1 << 5), // the dimension has been grouped in this RRDR
} RRDR_DIMENSION_FLAGS;
// RRDR result options
typedef enum __attribute__ ((__packed__)) rrdr_result_flags {
RRDR_RESULT_FLAG_ABSOLUTE = (1 << 0), // the query uses absolute time-frames
// (can be cached by browsers and proxies)
RRDR_RESULT_FLAG_RELATIVE = (1 << 1), // the query uses relative time-frames
// (should not to be cached by browsers and proxies)
RRDR_RESULT_FLAG_CANCEL = (1 << 2), // the query needs to be cancelled
} RRDR_RESULT_FLAGS;
#define RRDR_DVIEW_ANOMALY_COUNT_MULTIPLIER 1000.0
typedef struct rrdresult {
size_t d; // the number of dimensions
size_t n; // the number of values in the arrays (number of points per dimension)
size_t rows; // the number of actual rows used
RRDR_DIMENSION_FLAGS *od; // the options for the dimensions
STRING **di; // array of d dimension ids
STRING **dn; // array of d dimension names
STRING **du; // array of d dimension units
uint32_t *dgbs; // array of d dimension group by slots - NOT ALLOCATED when RRDR is created
uint32_t *dgbc; // array of d dimension group by counts - NOT ALLOCATED when RRDR is created
uint32_t *dp; // array of d dimension priority - NOT ALLOCATED when RRDR is created
DICTIONARY **dl; // array of d dimension labels - NOT ALLOCATED when RRDR is created
STORAGE_POINT *dqp; // array of d dimensions query points - NOT ALLOCATED when RRDR is created
STORAGE_POINT *dview; // array of d dimensions group by view - NOT ALLOCATED when RRDR is created
NETDATA_DOUBLE *vh; // array of n x d hidden values, while grouping - NOT ALLOCATED when RRDR is created
DICTIONARY *label_keys;
time_t *t; // array of n timestamps
NETDATA_DOUBLE *v; // array n x d values
RRDR_VALUE_FLAGS *o; // array n x d options for each value returned
NETDATA_DOUBLE *ar; // array n x d of anomaly rates (0 - 100)
uint32_t *gbc; // array n x d of group by count - NOT ALLOCATED when RRDR is created
struct {
size_t group; // how many collected values were grouped for each row - NEEDED BY GROUPING FUNCTIONS
time_t after;
time_t before;
time_t update_every; // what is the suggested update frequency in seconds
NETDATA_DOUBLE min;
NETDATA_DOUBLE max;
RRDR_RESULT_FLAGS flags; // RRDR_RESULT_FLAG_*
} view;
struct {
size_t db_points_read;
size_t result_points_generated;
} stats;
struct {
void *data; // the internal data of the grouping function
// grouping function pointers
RRDR_TIME_GROUPING add_flush;
void (*create)(struct rrdresult *r, const char *options);
void (*reset)(struct rrdresult *r);
void (*free)(struct rrdresult *r);
void (*add)(struct rrdresult *r, NETDATA_DOUBLE value);
NETDATA_DOUBLE (*flush)(struct rrdresult *r, RRDR_VALUE_FLAGS *rrdr_value_options_ptr);
TIER_QUERY_FETCH tier_query_fetch; // which value to use from STORAGE_POINT
size_t points_wanted; // used by SES and DES
size_t resampling_group; // used by AVERAGE
NETDATA_DOUBLE resampling_divisor; // used by AVERAGE
} time_grouping;
struct {
struct rrdresult *r;
} group_by;
struct {
time_t max_update_every;
time_t expected_after;
time_t trimmed_after;
} partial_data_trimming;
struct {
ONEWAYALLOC *owa; // the allocator used
struct query_target *qt; // the QUERY_TARGET
size_t contexts; // temp needed between json_wrapper_begin2() and json_wrapper_end2()
size_t queries_count; // temp needed to know if a query is the first executed
#ifdef NETDATA_INTERNAL_CHECKS
const char *log;
#endif
struct query_target *release_with_rrdr_qt;
} internal;
} RRDR;
#define rrdr_rows(r) ((r)->rows)
#include "database/rrd.h"
void rrdr_free(ONEWAYALLOC *owa, RRDR *r);
RRDR *rrdr_create(ONEWAYALLOC *owa, struct query_target *qt, size_t dimensions, size_t points);
#include "../web_api_v1.h"
#include "web/api/queries/query.h"
RRDR *rrd2rrdr_legacy(
ONEWAYALLOC *owa,
RRDSET *st, size_t points, time_t after, time_t before,
RRDR_TIME_GROUPING group_method, time_t resampling_time, RRDR_OPTIONS options, const char *dimensions,
const char *group_options, time_t timeout_ms, size_t tier, QUERY_SOURCE query_source,
STORAGE_PRIORITY priority);
RRDR *rrd2rrdr(ONEWAYALLOC *owa, struct query_target *qt);
bool query_target_calculate_window(struct query_target *qt);
#ifdef __cplusplus
}
#endif
#endif //NETDATA_QUERIES_RRDR_H
|
