src/health.h

   1 #ifndef NETDATA_HEALTH_H
   2 #define NETDATA_HEALTH_H
   3
   4 extern int health_enabled;
   5
   6 extern int rrdvar_compare(void *a, void *b);
   7
   8 #define RRDVAR_TYPE_CALCULATED 1
   9 #define RRDVAR_TYPE_TIME_T     2
  10 #define RRDVAR_TYPE_COLLECTED  3
  11 #define RRDVAR_TYPE_TOTAL      4
  12 #define RRDVAR_TYPE_INT        5
  13
  14 // the variables as stored in the variables indexes
  15 // there are 3 indexes:
  16 // 1. at each chart   (RRDSET.variables_root_index)
  17 // 2. at each context (RRDFAMILY.variables_root_index)
  18 // 3. at each host    (RRDHOST.variables_root_index)
  19 typedef struct rrdvar {
  20     avl avl;
  21
  22     char *name;
  23     uint32_t hash;
  24
  25     int type;
  26     void *value;
  27
  28     time_t last_updated;
  29 } RRDVAR;
  30
  31 // variables linked to charts
  32 // We link variables to point to the values that are already
  33 // calculated / processed by the normal data collection process
  34 // This means, there will be no speed penalty for using
  35 // these variables
  36 typedef struct rrdsetvar {
  37     char *fullid;               // chart type.chart id.variable
  38     char *fullname;             // chart type.chart name.variable
  39     char *variable;             // variable
  40
  41     int type;
  42     void *value;
  43
  44     uint32_t options;
  45
  46     RRDVAR *local;
  47     RRDVAR *family;
  48     RRDVAR *host;
  49     RRDVAR *family_name;
  50     RRDVAR *host_name;
  51
  52     struct rrdset *rrdset;
  53
  54     struct rrdsetvar *next;
  55 } RRDSETVAR;
  56
  57
  58 // variables linked to individual dimensions
  59 // We link variables to point the values that are already
  60 // calculated / processed by the normal data collection process
  61 // This means, there will be no speed penalty for using
  62 // these variables
  63 typedef struct rrddimvar {
  64     char *prefix;
  65     char *suffix;
  66
  67     char *id;                   // dimension id
  68     char *name;                 // dimension name
  69     char *fullidid;             // chart type.chart id.dimension id
  70     char *fullidname;           // chart type.chart id.dimension name
  71     char *fullnameid;           // chart type.chart name.dimension id
  72     char *fullnamename;         // chart type.chart name.dimension name
  73
  74     int type;
  75     void *value;
  76
  77     uint32_t options;
  78
  79     RRDVAR *local_id;
  80     RRDVAR *local_name;
  81
  82     RRDVAR *family_id;
  83     RRDVAR *family_name;
  84
  85     RRDVAR *host_fullidid;
  86     RRDVAR *host_fullidname;
  87     RRDVAR *host_fullnameid;
  88     RRDVAR *host_fullnamename;
  89
  90     struct rrddim *rrddim;
  91
  92     struct rrddimvar *next;
  93 } RRDDIMVAR;
  94
  95 // calculated variables (defined in health configuration)
  96 // These aggregate time-series data at fixed intervals
  97 // (defined in their update_every member below)
  98 // These increase the overhead of netdata.
  99 //
 100 // These calculations are allocated and linked (->next)
 101 // under RRDHOST.
 102 // Then are also linked to RRDSET (of course only when the
 103 // chart is found, via ->rrdset_next and ->rrdset_prev).
 104 // This double-linked list is maintained sorted at all times
 105 // having as RRDSET.calculations the RRDCALC to be processed
 106 // next.
 107
 108 #define RRDCALC_STATUS_REMOVED       -2
 109 #define RRDCALC_STATUS_UNDEFINED     -1
 110 #define RRDCALC_STATUS_UNINITIALIZED  0
 111 #define RRDCALC_STATUS_CLEAR          1
 112 #define RRDCALC_STATUS_RAISED         2
 113 #define RRDCALC_STATUS_WARNING        3
 114 #define RRDCALC_STATUS_CRITICAL       4
 115
 116 #define RRDCALC_FLAG_DB_ERROR      0x00000001
 117 #define RRDCALC_FLAG_DB_NAN        0x00000002
 118 #define RRDCALC_FLAG_DB_STALE      0x00000004
 119 #define RRDCALC_FLAG_CALC_ERROR    0x00000008
 120 #define RRDCALC_FLAG_WARN_ERROR    0x00000010
 121 #define RRDCALC_FLAG_CRIT_ERROR    0x00000020
 122
 123 typedef struct rrdcalc {
 124     uint32_t id;                    // the unique id of this alarm
 125     uint32_t next_event_id;         // the next event id that will be used for this alarm
 126
 127     char *name;                     // the name of this alarm
 128     uint32_t hash;
 129
 130     char *exec;                     // the command to execute when this alarm switches state
 131     char *recipient;                // the recipient of the alarm (the first parameter to exec)
 132
 133     char *chart;                    // the chart id this should be linked to
 134     uint32_t hash_chart;
 135
 136     char *source;                   // the source of this alarm
 137     char *units;                    // the units of the alarm
 138     char *info;                     // a short description of the alarm
 139
 140     int update_every;               // update frequency for the alarm
 141
 142     // the red and green threshold of this alarm (to be set to the chart)
 143     calculated_number green;
 144     calculated_number red;
 145
 146     // ------------------------------------------------------------------------
 147     // database lookup settings
 148
 149     char *dimensions;               // the chart dimensions
 150     int group;                      // grouping method: average, max, etc.
 151     int before;                     // ending point in time-series
 152     int after;                      // starting point in time-series
 153     uint32_t options;               // calculation options
 154
 155     // ------------------------------------------------------------------------
 156     // expressions related to the alarm
 157
 158     EVAL_EXPRESSION *calculation;   // expression to calculate the value of the alarm
 159     EVAL_EXPRESSION *warning;       // expression to check the warning condition
 160     EVAL_EXPRESSION *critical;      // expression to check the critical condition
 161
 162     // ------------------------------------------------------------------------
 163     // notification delay settings
 164
 165     int delay_up_duration;         // duration to delay notifications when alarm raises
 166     int delay_down_duration;       // duration to delay notifications when alarm lowers
 167     int delay_max_duration;        // the absolute max delay to apply to this alarm
 168     float delay_multiplier;        // multiplier for all delays when alarms switch status
 169                                    // while now < delay_up_to
 170
 171     // ------------------------------------------------------------------------
 172     // runtime information
 173
 174     int status;                     // the current status of the alarm
 175
 176     calculated_number value;        // the current value of the alarm
 177     calculated_number old_value;    // the previous value of the alarm
 178
 179     uint32_t rrdcalc_flags;         // check RRDCALC_FLAG_*
 180
 181     time_t last_updated;            // the last update timestamp of the alarm
 182     time_t next_update;             // the next update timestamp of the alarm
 183     time_t last_status_change;      // the timestamp of the last time this alarm changed status
 184
 185     time_t db_after;                // the first timestamp evaluated by the db lookup
 186     time_t db_before;               // the last timestamp evaluated by the db lookup
 187
 188     time_t delay_up_to_timestamp;   // the timestamp up to which we should delay notifications
 189     int delay_up_current;           // the current up notification delay duration
 190     int delay_down_current;         // the current down notification delay duration
 191     int delay_last;                 // the last delay we used
 192
 193     // ------------------------------------------------------------------------
 194     // variables this alarm exposes to the rest of the alarms
 195
 196     RRDVAR *local;
 197     RRDVAR *family;
 198     RRDVAR *hostid;
 199     RRDVAR *hostname;
 200
 201     // ------------------------------------------------------------------------
 202     // the chart this alarm it is linked to
 203
 204     struct rrdset *rrdset;
 205
 206     // linking of this alarm on its chart
 207     struct rrdcalc *rrdset_next;
 208     struct rrdcalc *rrdset_prev;
 209
 210     struct rrdcalc *next;
 211 } RRDCALC;
 212
 213 #define RRDCALC_HAS_DB_LOOKUP(rc) ((rc)->after)
 214
 215 // RRDCALCTEMPLATE
 216 // these are to be applied to charts found dynamically
 217 // based on their context.
 218 typedef struct rrdcalctemplate {
 219     char *name;
 220     uint32_t hash_name;
 221
 222     char *exec;
 223     char *recipient;
 224
 225     char *context;
 226     uint32_t hash_context;
 227
 228     char *source;                   // the source of this alarm
 229     char *units;                    // the units of the alarm
 230     char *info;                     // a short description of the alarm
 231
 232     int update_every;               // update frequency for the alarm
 233
 234     // the red and green threshold of this alarm (to be set to the chart)
 235     calculated_number green;
 236     calculated_number red;
 237
 238     // ------------------------------------------------------------------------
 239     // database lookup settings
 240
 241     char *dimensions;               // the chart dimensions
 242     int group;                      // grouping method: average, max, etc.
 243     int before;                     // ending point in time-series
 244     int after;                      // starting point in time-series
 245     uint32_t options;               // calculation options
 246
 247     // ------------------------------------------------------------------------
 248     // notification delay settings
 249
 250     int delay_up_duration;         // duration to delay notifications when alarm raises
 251     int delay_down_duration;       // duration to delay notifications when alarm lowers
 252     int delay_max_duration;        // the absolute max delay to apply to this alarm
 253     float delay_multiplier;        // multiplier for all delays when alarms switch status
 254
 255     // ------------------------------------------------------------------------
 256     // expressions related to the alarm
 257
 258     EVAL_EXPRESSION *calculation;
 259     EVAL_EXPRESSION *warning;
 260     EVAL_EXPRESSION *critical;
 261
 262     struct rrdcalctemplate *next;
 263 } RRDCALCTEMPLATE;
 264
 265 #define RRDCALCTEMPLATE_HAS_CALCULATION(rt) ((rt)->after)
 266
 267 #define HEALTH_ENTRY_FLAG_PROCESSED    0x00000001
 268 #define HEALTH_ENTRY_FLAG_UPDATED      0x00000002
 269 #define HEALTH_ENTRY_FLAG_EXEC_RUN     0x00000004
 270 #define HEALTH_ENTRY_FLAG_EXEC_FAILED  0x00000008
 271 #define HEALTH_ENTRY_FLAG_SAVED        0x10000000
 272
 273 typedef struct alarm_entry {
 274     uint32_t unique_id;
 275     uint32_t alarm_id;
 276     uint32_t alarm_event_id;
 277
 278     time_t when;
 279     time_t duration;
 280     time_t non_clear_duration;
 281
 282     char *name;
 283     uint32_t hash_name;
 284
 285     char *chart;
 286     uint32_t hash_chart;
 287
 288     char *family;
 289
 290     char *exec;
 291     char *recipient;
 292     time_t exec_run_timestamp;
 293     int exec_code;
 294
 295     char *source;
 296     char *units;
 297     char *info;
 298
 299     calculated_number old_value;
 300     calculated_number new_value;
 301     int old_status;
 302     int new_status;
 303
 304     uint32_t flags;
 305
 306     int delay;
 307     time_t delay_up_to_timestamp;
 308
 309     uint32_t updated_by_id;
 310     uint32_t updates_id;
 311
 312     struct alarm_entry *next;
 313 } ALARM_ENTRY;
 314
 315 typedef struct alarm_log {
 316     uint32_t next_log_id;
 317     uint32_t next_alarm_id;
 318     unsigned int count;
 319     unsigned int max;
 320     ALARM_ENTRY *alarms;
 321     pthread_rwlock_t alarm_log_rwlock;
 322 } ALARM_LOG;
 323
 324 #include "rrd.h"
 325
 326 extern void rrdsetvar_rename_all(RRDSET *st);
 327 extern RRDSETVAR *rrdsetvar_create(RRDSET *st, const char *variable, int type, void *value, uint32_t options);
 328 extern void rrdsetvar_free(RRDSETVAR *rs);
 329
 330 extern void rrddimvar_rename_all(RRDDIM *rd);
 331 extern RRDDIMVAR *rrddimvar_create(RRDDIM *rd, int type, const char *prefix, const char *suffix, void *value, uint32_t options);
 332 extern void rrddimvar_free(RRDDIMVAR *rs);
 333
 334 extern void rrdsetcalc_link_matching(RRDSET *st);
 335 extern void rrdsetcalc_unlink(RRDCALC *rc);
 336 extern void rrdcalctemplate_link_matching(RRDSET *st);
 337 extern RRDCALC *rrdcalc_find(RRDSET *st, const char *name);
 338
 339 extern void health_init(void);
 340 extern void *health_main(void *ptr);
 341
 342 extern void health_reload(void);
 343
 344 extern int health_variable_lookup(const char *variable, uint32_t hash, RRDCALC *rc, calculated_number *result);
 345 extern void health_alarms2json(RRDHOST *host, BUFFER *wb, int all);
 346 extern void health_alarm_log2json(RRDHOST *host, BUFFER *wb, uint32_t after);
 347
 348 #endif //NETDATA_HEALTH_H