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