src/rrd.h

   1 #ifndef NETDATA_RRD_H
   2 #define NETDATA_RRD_H 1
   3
   4 #define UPDATE_EVERY 1
   5 #define UPDATE_EVERY_MAX 3600
   6
   7 #define RRD_DEFAULT_HISTORY_ENTRIES 3600
   8 #define RRD_HISTORY_ENTRIES_MAX (86400*10)
   9
  10 extern int default_rrd_update_every;
  11 extern int default_rrd_history_entries;
  12
  13 #define RRD_ID_LENGTH_MAX 200
  14
  15 #define RRDSET_MAGIC        "NETDATA RRD SET FILE V019"
  16 #define RRDDIMENSION_MAGIC  "NETDATA RRD DIMENSION FILE V019"
  17
  18 typedef long long total_number;
  19 #define TOTAL_NUMBER_FORMAT "%lld"
  20
  21 // ----------------------------------------------------------------------------
  22 // chart types
  23
  24 typedef enum rrdset_type {
  25     RRDSET_TYPE_LINE    = 0,
  26     RRDSET_TYPE_AREA    = 1,
  27     RRDSET_TYPE_STACKED = 2
  28 } RRDSET_TYPE;
  29
  30 #define RRDSET_TYPE_LINE_NAME "line"
  31 #define RRDSET_TYPE_AREA_NAME "area"
  32 #define RRDSET_TYPE_STACKED_NAME "stacked"
  33
  34 RRDSET_TYPE rrdset_type_id(const char *name);
  35 const char *rrdset_type_name(RRDSET_TYPE chart_type);
  36
  37
  38 // ----------------------------------------------------------------------------
  39 // memory mode
  40
  41 typedef enum rrd_memory_mode {
  42     RRD_MEMORY_MODE_RAM  = 0,
  43     RRD_MEMORY_MODE_MAP  = 1,
  44     RRD_MEMORY_MODE_SAVE = 2
  45 } RRD_MEMORY_MODE;
  46
  47 #define RRD_MEMORY_MODE_RAM_NAME "ram"
  48 #define RRD_MEMORY_MODE_MAP_NAME "map"
  49 #define RRD_MEMORY_MODE_SAVE_NAME "save"
  50
  51 extern RRD_MEMORY_MODE default_rrd_memory_mode;
  52
  53 extern const char *rrd_memory_mode_name(RRD_MEMORY_MODE id);
  54 extern RRD_MEMORY_MODE rrd_memory_mode_id(const char *name);
  55
  56
  57 // ----------------------------------------------------------------------------
  58 // algorithms types
  59
  60 typedef enum rrd_algorithm {
  61     RRD_ALGORITHM_ABSOLUTE              = 0,
  62     RRD_ALGORITHM_INCREMENTAL           = 1,
  63     RRD_ALGORITHM_PCENT_OVER_DIFF_TOTAL = 2,
  64     RRD_ALGORITHM_PCENT_OVER_ROW_TOTAL  = 3
  65 } RRD_ALGORITHM;
  66
  67 #define RRD_ALGORITHM_ABSOLUTE_NAME                "absolute"
  68 #define RRD_ALGORITHM_INCREMENTAL_NAME             "incremental"
  69 #define RRD_ALGORITHM_PCENT_OVER_DIFF_TOTAL_NAME   "percentage-of-incremental-row"
  70 #define RRD_ALGORITHM_PCENT_OVER_ROW_TOTAL_NAME    "percentage-of-absolute-row"
  71
  72 extern RRD_ALGORITHM rrd_algorithm_id(const char *name);
  73 extern const char *rrd_algorithm_name(RRD_ALGORITHM algorithm);
  74
  75 // ----------------------------------------------------------------------------
  76 // flags
  77
  78 typedef enum rrddim_flags {
  79     RRDDIM_FLAG_HIDDEN                          = 1 << 0,  // this dimension will not be offered to callers
  80     RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS = 1 << 1,  // do not offer RESET or OVERFLOW info to callers
  81     RRDDIM_FLAG_UPDATED                         = 1 << 2,  // the dimension has been updated since the last processing
  82     RRDDIM_FLAG_EXPOSED                         = 1 << 3   // when set what have sent this dimension to the central netdata
  83 } RRDDIM_FLAGS;
  84
  85 #define rrddim_flag_check(rd, flag) ((rd)->flags & flag)
  86 #define rrddim_flag_set(rd, flag)   (rd)->flags |= flag
  87 #define rrddim_flag_clear(rd, flag) (rd)->flags &= ~flag
  88
  89
  90 // ----------------------------------------------------------------------------
  91 // RRD FAMILY
  92
  93 struct rrdfamily {
  94     avl avl;
  95
  96     const char *family;
  97     uint32_t hash_family;
  98
  99     size_t use_count;
 100
 101     avl_tree_lock variables_root_index;
 102 };
 103 typedef struct rrdfamily RRDFAMILY;
 104
 105
 106 // ----------------------------------------------------------------------------
 107 // RRD DIMENSION - this is a metric
 108
 109 struct rrddim {
 110     // ------------------------------------------------------------------------
 111     // binary indexing structures
 112
 113     avl avl;                                        // the binary index - this has to be first member!
 114
 115     // ------------------------------------------------------------------------
 116     // the dimension definition
 117
 118     const char *id;                                 // the id of this dimension (for internal identification)
 119     const char *name;                               // the name of this dimension (as presented to user)
 120                                                     // this is a pointer to the config structure
 121                                                     // since the config always has a higher priority
 122                                                     // (the user overwrites the name of the charts)
 123                                                     // DO NOT FREE THIS - IT IS ALLOCATED IN CONFIG
 124
 125     RRD_ALGORITHM algorithm;                        // the algorithm that is applied to add new collected values
 126     RRD_MEMORY_MODE rrd_memory_mode;                // the memory mode for this dimension
 127
 128     collected_number multiplier;                    // the multiplier of the collected values
 129     collected_number divisor;                       // the divider of the collected values
 130
 131     uint32_t flags;                                 // options and status options for the dimension
 132
 133     // ------------------------------------------------------------------------
 134     // members for temporary data we need for calculations
 135
 136     uint32_t hash;                                  // a simple hash of the id, to speed up searching / indexing
 137                                                     // instead of strcmp() every item in the binary index
 138                                                     // we first compare the hashes
 139
 140     uint32_t hash_name;                             // a simple hash of the name
 141
 142     char *cache_filename;                           // the filename we load/save from/to this set
 143
 144     size_t counter;                                 // the number of times we added values to this rrdim
 145
 146     struct timeval last_collected_time;             // when was this dimension last updated
 147                                                     // this is actual date time we updated the last_collected_value
 148                                                     // THIS IS DIFFERENT FROM THE SAME MEMBER OF RRDSET
 149
 150     calculated_number calculated_value;             // the current calculated value, after applying the algorithm - resets to zero after being used
 151     calculated_number last_calculated_value;        // the last calculated value processed
 152
 153     calculated_number last_stored_value;            // the last value as stored in the database (after interpolation)
 154
 155     collected_number collected_value;               // the current value, as collected - resets to 0 after being used
 156     collected_number last_collected_value;          // the last value that was collected, after being processed
 157
 158     // the *_volume members are used to calculate the accuracy of the rounding done by the
 159     // storage number - they are printed to debug.log when debug is enabled for a set.
 160     calculated_number collected_volume;             // the sum of all collected values so far
 161     calculated_number stored_volume;                // the sum of all stored values so far
 162
 163     struct rrddim *next;                            // linking of dimensions within the same data set
 164     struct rrdset *rrdset;
 165
 166     // ------------------------------------------------------------------------
 167     // members for checking the data when loading from disk
 168
 169     long entries;                                   // how many entries this dimension has in ram
 170                                                     // this is the same to the entries of the data set
 171                                                     // we set it here, to check the data when we load it from disk.
 172
 173     int update_every;                               // every how many seconds is this updated
 174
 175     size_t memsize;                                 // the memory allocated for this dimension
 176
 177     char magic[sizeof(RRDDIMENSION_MAGIC) + 1];     // a string to be saved, used to identify our data file
 178
 179     struct rrddimvar *variables;
 180
 181     // ------------------------------------------------------------------------
 182     // the values stored in this dimension, using our floating point numbers
 183
 184     storage_number values[];                        // the array of values - THIS HAS TO BE THE LAST MEMBER
 185 };
 186 typedef struct rrddim RRDDIM;
 187
 188
 189 // ----------------------------------------------------------------------------
 190 // RRDSET - this is a chart
 191
 192 typedef enum rrdset_flags {
 193     RRDSET_FLAG_ENABLED = 1 << 0, // enables or disables a chart
 194     RRDSET_FLAG_DETAIL  = 1 << 1, // if set, the data set should be considered as a detail of another
 195                                   // (the master data set should be the one that has the same family and is not detail)
 196     RRDSET_FLAG_DEBUG   = 1 << 2  // enables or disables debugging for a chart
 197 } RRDSET_FLAGS;
 198
 199 #define rrdset_flag_check(st, flag) ((st)->flags & flag)
 200 #define rrdset_flag_set(st, flag)   (st)->flags |= flag
 201 #define rrdset_flag_clear(st, flag) (st)->flags &= ~flag
 202
 203 struct rrdset {
 204     // ------------------------------------------------------------------------
 205     // binary indexing structures
 206
 207     avl avl;                                        // the index, with key the id - this has to be first!
 208     avl avlname;                                    // the index, with key the name
 209
 210     // ------------------------------------------------------------------------
 211     // the set configuration
 212
 213     char id[RRD_ID_LENGTH_MAX + 1];                 // id of the data set
 214
 215     const char *name;                               // the name of this dimension (as presented to user)
 216                                                     // this is a pointer to the config structure
 217                                                     // since the config always has a higher priority
 218                                                     // (the user overwrites the name of the charts)
 219
 220     char *config_section;                           // the config section for the chart
 221
 222     char *type;                                     // the type of graph RRD_TYPE_* (a category, for determining graphing options)
 223     char *family;                                   // grouping sets under the same family
 224     char *title;                                    // title shown to user
 225     char *units;                                    // units of measurement
 226
 227     char *context;                                  // the template of this data set
 228     uint32_t hash_context;
 229
 230     RRDSET_TYPE chart_type;
 231
 232     int update_every;                               // every how many seconds is this updated?
 233
 234     long entries;                                   // total number of entries in the data set
 235
 236     long current_entry;                             // the entry that is currently being updated
 237                                                     // it goes around in a round-robin fashion
 238
 239     uint32_t flags;
 240
 241     int gap_when_lost_iterations_above;             // after how many lost iterations a gap should be stored
 242                                                     // netdata will interpolate values for gaps lower than this
 243
 244     long priority;
 245
 246
 247     // ------------------------------------------------------------------------
 248     // members for temporary data we need for calculations
 249
 250     RRD_MEMORY_MODE rrd_memory_mode;                // if set to 1, this is memory mapped
 251
 252     char *cache_dir;                                // the directory to store dimensions
 253     char cache_filename[FILENAME_MAX+1];            // the filename to store this set
 254
 255     pthread_rwlock_t rrdset_rwlock;
 256
 257     unsigned long counter;                          // the number of times we added values to this rrd
 258     unsigned long counter_done;                     // the number of times we added values to this rrd
 259
 260     uint32_t hash;                                  // a simple hash on the id, to speed up searching
 261                                                     // we first compare hashes, and only if the hashes are equal we do string comparisons
 262
 263     uint32_t hash_name;                             // a simple hash on the name
 264
 265     usec_t usec_since_last_update;                  // the time in microseconds since the last collection of data
 266
 267     struct timeval last_updated;                    // when this data set was last updated (updated every time the rrd_stats_done() function)
 268     struct timeval last_collected_time;             // when did this data set last collected values
 269
 270     total_number collected_total;                   // used internally to calculate percentages
 271     total_number last_collected_total;              // used internally to calculate percentages
 272
 273     RRDFAMILY *rrdfamily;
 274     struct rrdhost *rrdhost;
 275
 276     struct rrdset *next;                            // linking of rrdsets
 277
 278     // ------------------------------------------------------------------------
 279     // local variables
 280
 281     calculated_number green;
 282     calculated_number red;
 283
 284     avl_tree_lock variables_root_index;
 285     RRDSETVAR *variables;
 286     RRDCALC *alarms;
 287
 288     // ------------------------------------------------------------------------
 289     // members for checking the data when loading from disk
 290
 291     unsigned long memsize;                          // how much mem we have allocated for this (without dimensions)
 292
 293     char magic[sizeof(RRDSET_MAGIC) + 1];           // our magic
 294
 295     // ------------------------------------------------------------------------
 296     // the dimensions
 297
 298     avl_tree_lock dimensions_index;                 // the root of the dimensions index
 299     RRDDIM *dimensions;                             // the actual data for every dimension
 300
 301 };
 302 typedef struct rrdset RRDSET;
 303
 304 #define rrdset_rdlock(st) pthread_rwlock_rdlock(&((st)->rrdset_rwlock))
 305 #define rrdset_wrlock(st) pthread_rwlock_wrlock(&((st)->rrdset_rwlock))
 306 #define rrdset_unlock(st) pthread_rwlock_unlock(&((st)->rrdset_rwlock))
 307
 308 // ----------------------------------------------------------------------------
 309 // RRD HOST
 310
 311 struct rrdhost {
 312     avl avl;                                        // the index of hosts
 313
 314     char *hostname;                                 // the hostname of this host
 315     uint32_t hash_hostname;                         // the hostname hash
 316
 317     char machine_guid[GUID_LEN + 1];                // the unique ID of this host
 318     uint32_t hash_machine_guid;                     // the hash of the unique ID
 319
 320     int rrd_update_every;                           // the update frequency of the host
 321     int rrd_history_entries;                        // the number of history entries for the host's charts
 322
 323     int health_enabled;                             // 1 when this host has health enabled
 324     RRD_MEMORY_MODE rrd_memory_mode;                // the memory more for the charts of this host
 325
 326     RRDSET *rrdset_root;                            // the host charts
 327
 328     pthread_rwlock_t rrdhost_rwlock;                // lock for this RRDHOST
 329
 330     avl_tree_lock rrdset_root_index;                // the host's charts index (by id)
 331     avl_tree_lock rrdset_root_index_name;           // the host's charts index (by name)
 332
 333     avl_tree_lock rrdfamily_root_index;             // the host's chart families index
 334     avl_tree_lock variables_root_index;             // the host's chart variables index
 335
 336     char *cache_dir;                                // the directory to save RRD cache files
 337     char *varlib_dir;                               // the directory to save health log
 338
 339     // all RRDCALCs are primarily allocated and linked here
 340     // RRDCALCs may be linked to charts at any point
 341     // (charts may or may not exist when these are loaded)
 342     RRDCALC *alarms;
 343
 344     ALARM_LOG health_log;                           // alarms historical events (event log)
 345
 346     // templates of alarms
 347     // these are used to create alarms when charts
 348     // are created or renamed, that match them
 349     RRDCALCTEMPLATE *templates;
 350
 351     // health / alarm settings
 352     char *health_default_exec;
 353     char *health_default_recipient;
 354     char *health_log_filename;
 355     size_t health_log_entries_written;
 356     FILE *health_log_fp;
 357
 358     struct rrdhost *next;
 359 };
 360 typedef struct rrdhost RRDHOST;
 361 extern RRDHOST *localhost;
 362
 363 #define rrdhost_rdlock(h) pthread_rwlock_rdlock(&((h)->rrdhost_rwlock))
 364 #define rrdhost_wrlock(h) pthread_rwlock_wrlock(&((h)->rrdhost_rwlock))
 365 #define rrdhost_unlock(h) pthread_rwlock_unlock(&((h)->rrdhost_rwlock))
 366
 367 extern void rrd_init(char *hostname);
 368
 369 extern RRDHOST *rrdhost_find(const char *guid, uint32_t hash);
 370 extern RRDHOST *rrdhost_find_or_create(const char *hostname, const char *guid);
 371
 372 #ifdef NETDATA_INTERNAL_CHECKS
 373 #define rrdhost_check_rdlock(host) rrdhost_check_rdlock_int(host, __FILE__, __FUNCTION__, __LINE__)
 374 #define rrdhost_check_wrlock(host) rrdhost_check_wrlock_int(host, __FILE__, __FUNCTION__, __LINE__)
 375 #define rrd_check_rdlock() rrd_check_rdlock_int(__FILE__, __FUNCTION__, __LINE__)
 376 #define rrd_check_wrlock() rrd_check_wrlock_int(__FILE__, __FUNCTION__, __LINE__)
 377 #else
 378 #define rrdhost_check_rdlock(host) (void)0
 379 #define rrdhost_check_wrlock(host) (void)0
 380 #define rrd_check_rdlock() (void)0
 381 #define rrd_check_wrlock() (void)0
 382 #endif
 383
 384 extern void rrdhost_check_wrlock_int(RRDHOST *host, const char *file, const char *function, const unsigned long line);
 385 extern void rrdhost_check_rdlock_int(RRDHOST *host, const char *file, const char *function, const unsigned long line);
 386
 387 // ----------------------------------------------------------------------------
 388 // global lock for all RRDHOSTs
 389
 390 extern pthread_rwlock_t rrd_rwlock;
 391 #define rrd_rdlock() pthread_rwlock_rdlock(&rrd_rwlock)
 392 #define rrd_wrlock() pthread_rwlock_wrlock(&rrd_rwlock)
 393 #define rrd_unlock() pthread_rwlock_unlock(&rrd_rwlock)
 394
 395
 396 // ----------------------------------------------------------------------------
 397 // RRDSET functions
 398
 399 extern void rrdset_set_name(RRDSET *st, const char *name);
 400
 401 extern RRDSET *rrdset_create(RRDHOST *host
 402                              , const char *type
 403                              , const char *id
 404                              , const char *name
 405                              , const char *family
 406                              , const char *context
 407                              , const char *title
 408                              , const char *units
 409                              , long priority
 410                              , int update_every
 411                              , RRDSET_TYPE chart_type);
 412
 413 #define rrdset_create_localhost(type, id, name, family, context, title, units, priority, update_every, chart_type) rrdset_create(localhost, type, id, name, family, context, title, units, priority, update_every, chart_type)
 414
 415 extern void rrdhost_free_all(void);
 416 extern void rrdhost_save_all(void);
 417
 418 extern void rrdhost_free(RRDHOST *host);
 419 extern void rrdhost_save(RRDHOST *host);
 420
 421 extern RRDSET *rrdset_find(RRDHOST *host, const char *id);
 422 #define rrdset_find_localhost(id) rrdset_find(localhost, id)
 423
 424 extern RRDSET *rrdset_find_bytype(RRDHOST *host, const char *type, const char *id);
 425 #define rrdset_find_bytype_localhost(type, id) rrdset_find_bytype(localhost, type, id)
 426
 427 extern RRDSET *rrdset_find_byname(RRDHOST *host, const char *name);
 428 #define rrdset_find_byname_localhost(name)  rrdset_find_byname(localhost, name)
 429
 430 extern void rrdset_next_usec_unfiltered(RRDSET *st, usec_t microseconds);
 431 extern void rrdset_next_usec(RRDSET *st, usec_t microseconds);
 432 #define rrdset_next(st) rrdset_next_usec(st, 0ULL)
 433
 434 extern void rrdset_done(RRDSET *st);
 435
 436 // get the total duration in seconds of the round robin database
 437 #define rrdset_duration(st) ((time_t)( (((st)->counter >= ((unsigned long)(st)->entries))?(unsigned long)(st)->entries:(st)->counter) * (st)->update_every ))
 438
 439 // get the timestamp of the last entry in the round robin database
 440 #define rrdset_last_entry_t(st) ((time_t)(((st)->last_updated.tv_sec)))
 441
 442 // get the timestamp of first entry in the round robin database
 443 #define rrdset_first_entry_t(st) ((time_t)(rrdset_last_entry_t(st) - rrdset_duration(st)))
 444
 445 // get the last slot updated in the round robin database
 446 #define rrdset_last_slot(st) ((unsigned long)(((st)->current_entry == 0) ? (st)->entries - 1 : (st)->current_entry - 1))
 447
 448 // get the first / oldest slot updated in the round robin database
 449 #define rrdset_first_slot(st) ((unsigned long)( (((st)->counter >= ((unsigned long)(st)->entries)) ? (unsigned long)( ((unsigned long)(st)->current_entry > 0) ? ((unsigned long)(st)->current_entry) : ((unsigned long)(st)->entries) ) - 1 : 0) ))
 450
 451 // get the slot of the round robin database, for the given timestamp (t)
 452 // it always returns a valid slot, although may not be for the time requested if the time is outside the round robin database
 453 #define rrdset_time2slot(st, t) ( \
 454         (  (time_t)(t) >= rrdset_last_entry_t(st))  ? ( rrdset_last_slot(st) ) : \
 455         ( ((time_t)(t) <= rrdset_first_entry_t(st)) ?   rrdset_first_slot(st) : \
 456         ( (rrdset_last_slot(st) >= (unsigned long)((rrdset_last_entry_t(st) - (time_t)(t)) / (unsigned long)((st)->update_every)) ) ? \
 457           (rrdset_last_slot(st) -  (unsigned long)((rrdset_last_entry_t(st) - (time_t)(t)) / (unsigned long)((st)->update_every)) ) : \
 458           (rrdset_last_slot(st) -  (unsigned long)((rrdset_last_entry_t(st) - (time_t)(t)) / (unsigned long)((st)->update_every)) + (unsigned long)(st)->entries ) \
 459         )))
 460
 461 // get the timestamp of a specific slot in the round robin database
 462 #define rrdset_slot2time(st, slot) ( rrdset_last_entry_t(st) - \
 463         ((unsigned long)(st)->update_every * ( \
 464                 ( (unsigned long)(slot) > rrdset_last_slot(st)) ? \
 465                 ( (rrdset_last_slot(st) - (unsigned long)(slot) + (unsigned long)(st)->entries) ) : \
 466                 ( (rrdset_last_slot(st) - (unsigned long)(slot)) )) \
 467         ))
 468
 469 // ----------------------------------------------------------------------------
 470 // RRD DIMENSION functions
 471
 472 extern RRDDIM *rrddim_add(RRDSET *st, const char *id, const char *name, collected_number multiplier, collected_number divisor, RRD_ALGORITHM algorithm);
 473
 474 extern void rrddim_set_name(RRDSET *st, RRDDIM *rd, const char *name);
 475 extern RRDDIM *rrddim_find(RRDSET *st, const char *id);
 476
 477 extern int rrddim_hide(RRDSET *st, const char *id);
 478 extern int rrddim_unhide(RRDSET *st, const char *id);
 479
 480 extern collected_number rrddim_set_by_pointer(RRDSET *st, RRDDIM *rd, collected_number value);
 481 extern collected_number rrddim_set(RRDSET *st, const char *id, collected_number value);
 482
 483 extern long align_entries_to_pagesize(long entries);
 484
 485
 486 // ----------------------------------------------------------------------------
 487 // RRD internal functions
 488
 489 #ifdef NETDATA_RRD_INTERNALS
 490
 491 extern void rrdset_free(RRDSET *st);
 492 extern avl_tree_lock rrdhost_root_index;
 493
 494 extern char *rrdset_strncpyz_name(char *to, const char *from, size_t length);
 495 extern char *rrdset_cache_dir(RRDHOST *host, const char *id, const char *config_section);
 496
 497 extern void rrdset_reset(RRDSET *st);
 498
 499 extern void rrddim_free(RRDSET *st, RRDDIM *rd);
 500
 501 extern int rrddim_compare(void* a, void* b);
 502 extern int rrdset_compare(void* a, void* b);
 503 extern int rrdset_compare_name(void* a, void* b);
 504 extern int rrdfamily_compare(void *a, void *b);
 505
 506 extern RRDFAMILY *rrdfamily_create(RRDHOST *host, const char *id);
 507 extern void rrdfamily_free(RRDHOST *host, RRDFAMILY *rc);
 508
 509 #define rrdset_index_add(host, st) (RRDSET *)avl_insert_lock(&((host)->rrdset_root_index), (avl *)(st))
 510 #define rrdset_index_del(host, st) (RRDSET *)avl_remove_lock(&((host)->rrdset_root_index), (avl *)(st))
 511 extern RRDSET *rrdset_index_del_name(RRDHOST *host, RRDSET *st);
 512
 513 #endif /* NETDATA_RRD_INTERNALS */
 514
 515
 516 #endif /* NETDATA_RRD_H */