src/rrd.h

   1 #include <sys/time.h>
   2 #include <pthread.h>
   3
   4 #include "avl.h"
   5 #include "storage_number.h"
   6
   7 #ifndef NETDATA_RRD_H
   8 #define NETDATA_RRD_H 1
   9
  10 #define UPDATE_EVERY 1
  11 #define UPDATE_EVERY_MAX 3600
  12 extern int rrd_update_every;
  13
  14 #define RRD_DEFAULT_HISTORY_ENTRIES 3600
  15 #define RRD_HISTORY_ENTRIES_MAX (86400*10)
  16 extern int rrd_default_history_entries;
  17
  18 // time in seconds to delete unupdated dimensions
  19 // set to zero to disable this feature
  20 extern int rrd_delete_unupdated_dimensions;
  21
  22 #define RRD_ID_LENGTH_MAX 1024
  23
  24 #define RRDSET_MAGIC            "NETDATA RRD SET FILE V016"
  25 #define RRDDIMENSION_MAGIC      "NETDATA RRD DIMENSION FILE V016"
  26
  27 typedef long long total_number;
  28 #define TOTAL_NUMBER_FORMAT "%lld"
  29
  30 // ----------------------------------------------------------------------------
  31 // chart types
  32
  33 #define RRDSET_TYPE_LINE_NAME "line"
  34 #define RRDSET_TYPE_AREA_NAME "area"
  35 #define RRDSET_TYPE_STACKED_NAME "stacked"
  36
  37 #define RRDSET_TYPE_LINE        0
  38 #define RRDSET_TYPE_AREA        1
  39 #define RRDSET_TYPE_STACKED 2
  40
  41 int rrdset_type_id(const char *name);
  42 const char *rrdset_type_name(int chart_type);
  43
  44
  45 // ----------------------------------------------------------------------------
  46 // memory mode
  47
  48 #define RRD_MEMORY_MODE_RAM_NAME "ram"
  49 #define RRD_MEMORY_MODE_MAP_NAME "map"
  50 #define RRD_MEMORY_MODE_SAVE_NAME "save"
  51
  52 #define RRD_MEMORY_MODE_RAM 0
  53 #define RRD_MEMORY_MODE_MAP 1
  54 #define RRD_MEMORY_MODE_SAVE 2
  55
  56 extern int rrd_memory_mode;
  57
  58 extern const char *rrd_memory_mode_name(int id);
  59 extern int rrd_memory_mode_id(const char *name);
  60
  61
  62 // ----------------------------------------------------------------------------
  63 // algorithms types
  64
  65 #define RRDDIM_ABSOLUTE_NAME                            "absolute"
  66 #define RRDDIM_INCREMENTAL_NAME                         "incremental"
  67 #define RRDDIM_PCENT_OVER_DIFF_TOTAL_NAME       "percentage-of-incremental-row"
  68 #define RRDDIM_PCENT_OVER_ROW_TOTAL_NAME        "percentage-of-absolute-row"
  69
  70 #define RRDDIM_ABSOLUTE                                 0
  71 #define RRDDIM_INCREMENTAL                              1
  72 #define RRDDIM_PCENT_OVER_DIFF_TOTAL    2
  73 #define RRDDIM_PCENT_OVER_ROW_TOTAL             3
  74
  75 extern int rrddim_algorithm_id(const char *name);
  76 extern const char *rrddim_algorithm_name(int chart_type);
  77
  78 // ----------------------------------------------------------------------------
  79 // flags
  80
  81 #define RRDDIM_FLAG_HIDDEN 0x00000001 // this dimension will not be offered to callers
  82 #define RRDDIM_FLAG_DONT_DETECT_RESETS_OR_OVERFLOWS 0x00000002 // do not offer RESET or OVERFLOW info to callers
  83
  84 // ----------------------------------------------------------------------------
  85 // RRD DIMENSION
  86
  87 struct rrddim {
  88         // ------------------------------------------------------------------------
  89         // binary indexing structures
  90
  91         avl avl;                                                                                // the binary index - this has to be first member!
  92
  93         // ------------------------------------------------------------------------
  94         // the dimension definition
  95
  96         char id[RRD_ID_LENGTH_MAX + 1];                                 // the id of this dimension (for internal identification)
  97
  98         const char *name;                                                               // the name of this dimension (as presented to user)
  99                                                                                                         // this is a pointer to the config structure
 100                                                                                                         // since the config always has a higher priority
 101                                                                                                         // (the user overwrites the name of the charts)
 102
 103         int algorithm;                                                                  // the algorithm that is applied to add new collected values
 104         long multiplier;                                                                // the multiplier of the collected values
 105         long divisor;                                                                   // the divider of the collected values
 106
 107         int mapped;                                                                             // if set to non zero, this dimension is mapped to a file
 108
 109         // ------------------------------------------------------------------------
 110         // members for temporary data we need for calculations
 111
 112         uint32_t hash;                                                                  // a simple hash of the id, to speed up searching / indexing
 113                                                                                                         // instead of strcmp() every item in the binary index
 114                                                                                                         // we first compare the hashes
 115
 116         uint32_t flags;
 117
 118         char cache_filename[FILENAME_MAX+1];                    // the filename we load/save from/to this set
 119
 120         unsigned long counter;                                                  // the number of times we added values to this rrdim
 121
 122         int updated;                                                                    // set to 0 after each calculation, to 1 after each collected value
 123                                                                                                         // we use this to detect that a dimension is not updated
 124
 125         struct timeval last_collected_time;                             // when was this dimension last updated
 126                                                                                                         // this is actual date time we updated the last_collected_value
 127                                                                                                         // THIS IS DIFFERENT FROM THE SAME MEMBER OF RRDSET
 128
 129         calculated_number calculated_value;                             // the current calculated value, after applying the algorithm
 130         calculated_number last_calculated_value;                // the last calculated value
 131
 132         collected_number collected_value;                               // the current value, as collected
 133         collected_number last_collected_value;                  // the last value that was collected
 134
 135         // the *_volume members are used to calculate the accuracy of the rounding done by the
 136         // storage number - they are printed to debug.log when debug is enabled for a set.
 137         calculated_number collected_volume;                             // the sum of all collected values so far
 138         calculated_number stored_volume;                                // the sum of all stored values so far
 139
 140         struct rrddim *next;                                                    // linking of dimensions within the same data set
 141
 142         // ------------------------------------------------------------------------
 143         // members for checking the data when loading from disk
 144
 145         long entries;                                                                   // how many entries this dimension has in ram
 146                                                                                                         // this is the same to the entries of the data set
 147                                                                                                         // we set it here, to check the data when we load it from disk.
 148
 149         int update_every;                                                               // every how many seconds is this updated
 150
 151         unsigned long memsize;                                                  // the memory allocated for this dimension
 152
 153         char magic[sizeof(RRDDIMENSION_MAGIC) + 1];             // a string to be saved, used to identify our data file
 154
 155         // ------------------------------------------------------------------------
 156         // the values stored in this dimension, using our floating point numbers
 157
 158         storage_number values[];                                                // the array of values - THIS HAS TO BE THE LAST MEMBER
 159 };
 160 typedef struct rrddim RRDDIM;
 161
 162
 163 // ----------------------------------------------------------------------------
 164 // RRDSET
 165
 166 struct rrdset {
 167         // ------------------------------------------------------------------------
 168         // binary indexing structures
 169
 170         avl avl;                                                                                // the index, with key the id - this has to be first!
 171         avl avlname;                                                                    // the index, with key the name
 172
 173         // ------------------------------------------------------------------------
 174         // the set configuration
 175
 176         char id[RRD_ID_LENGTH_MAX + 1];                                 // id of the data set
 177
 178         const char *name;                                                               // the name of this dimension (as presented to user)
 179                                                                                                         // this is a pointer to the config structure
 180                                                                                                         // since the config always has a higher priority
 181                                                                                                         // (the user overwrites the name of the charts)
 182
 183         char *type;                                                                             // the type of graph RRD_TYPE_* (a category, for determining graphing options)
 184         char *family;                                                                   // the family of this data set (for grouping them together)
 185         char *title;                                                                    // title shown to user
 186         char *units;                                                                    // units of measurement
 187
 188         int chart_type;
 189
 190         int update_every;                                                               // every how many seconds is this updated?
 191
 192         long entries;                                                                   // total number of entries in the data set
 193
 194         long current_entry;                                                             // the entry that is currently being updated
 195                                                                                                         // it goes around in a round-robin fashion
 196
 197         int enabled;
 198
 199         int gap_when_lost_iterations_above;                             // after how many lost iterations a gap should be stored
 200                                                                                                         // netdata will interpolate values for gaps lower than this
 201
 202         long priority;
 203
 204         int isdetail;                                                                   // if set, the data set should be considered as a detail of another
 205                                                                                                         // (the master data set should be the one that has the same family and is not detail)
 206
 207         // ------------------------------------------------------------------------
 208         // members for temporary data we need for calculations
 209
 210         int mapped;                                                                             // if set to 1, this is memory mapped
 211
 212         int debug;
 213
 214         char *cache_dir;                                                                // the directory to store dimensions
 215         char cache_filename[FILENAME_MAX+1];                    // the filename to store this set
 216
 217         pthread_rwlock_t rwlock;
 218
 219         unsigned long counter;                                                  // the number of times we added values to this rrd
 220         unsigned long counter_done;                                             // the number of times we added values to this rrd
 221
 222         uint32_t hash;                                                                  // a simple hash on the id, to speed up searching
 223                                                                                                         // we first compare hashes, and only if the hashes are equal we do string comparisons
 224
 225         uint32_t hash_name;                                                             // a simple hash on the name
 226
 227         unsigned long long usec_since_last_update;              // the time in microseconds since the last collection of data
 228
 229         struct timeval last_updated;                                    // when this data set was last updated (updated every time the rrd_stats_done() function)
 230         struct timeval last_collected_time;                             // when did this data set last collected values
 231
 232         total_number collected_total;                                   // used internally to calculate percentages
 233         total_number last_collected_total;                              // used internally to calculate percentages
 234
 235         struct rrdset *next;                                                    // linking of rrdsets
 236
 237         // ------------------------------------------------------------------------
 238         // members for checking the data when loading from disk
 239
 240         unsigned long memsize;                                                  // how much mem we have allocated for this (without dimensions)
 241
 242         char magic[sizeof(RRDSET_MAGIC) + 1];                   // our magic
 243
 244         // ------------------------------------------------------------------------
 245         // the dimensions
 246
 247         avl_tree dimensions_index;                                              // the root of the dimensions index
 248         RRDDIM *dimensions;                                                             // the actual data for every dimension
 249 };
 250 typedef struct rrdset RRDSET;
 251
 252 extern RRDSET *rrdset_root;
 253 extern pthread_rwlock_t rrdset_root_rwlock;
 254
 255 // ----------------------------------------------------------------------------
 256 // RRD SET functions
 257
 258 extern char *rrdset_strncpy_name(char *to, const char *from, int length);
 259 extern void rrdset_set_name(RRDSET *st, const char *name);
 260
 261 extern char *rrdset_cache_dir(const char *id);
 262
 263 extern void rrdset_reset(RRDSET *st);
 264
 265 extern RRDSET *rrdset_create(const char *type, const char *id, const char *name, const char *family, const char *title, const char *units, long priority, int update_every, int chart_type);
 266
 267 extern void rrdset_free_all(void);
 268 extern void rrdset_save_all(void);
 269
 270 extern RRDSET *rrdset_find(const char *id);
 271 extern RRDSET *rrdset_find_bytype(const char *type, const char *id);
 272 extern RRDSET *rrdset_find_byname(const char *name);
 273
 274 extern void rrdset_next_usec(RRDSET *st, unsigned long long microseconds);
 275 extern void rrdset_next(RRDSET *st);
 276 extern void rrdset_next_plugins(RRDSET *st);
 277
 278 extern unsigned long long rrdset_done(RRDSET *st);
 279
 280 // get the total duration in seconds of the round robin database
 281 #define rrdset_duration(st) ((time_t)( (((st)->counter >= ((unsigned long)(st)->entries))?(unsigned long)(st)->entries:(st)->counter) * (st)->update_every ))
 282
 283 // get the timestamp of the last entry in the round robin database
 284 #define rrdset_last_entry_t(st) ((time_t)(((st)->last_updated.tv_sec)))
 285
 286 // get the timestamp of first entry in the round robin database
 287 #define rrdset_first_entry_t(st) ((time_t)(rrdset_last_entry_t(st) - rrdset_duration(st)))
 288
 289 // get the last slot updated in the round robin database
 290 #define rrdset_last_slot(st) ((unsigned long)(((st)->current_entry == 0) ? (st)->entries - 1 : (st)->current_entry - 1))
 291
 292 // get the first / oldest slot updated in the round robin database
 293 #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) ))
 294
 295 // get the slot of the round robin database, for the given timestamp (t)
 296 // it always returns a valid slot, although may not be for the time requested if the time is outside the round robin database
 297 #define rrdset_time2slot(st, t) ( \
 298                 (  (time_t)(t) >= rrdset_last_entry_t(st))  ? ( rrdset_last_slot(st) ) : \
 299                 ( ((time_t)(t) <= rrdset_first_entry_t(st)) ?   rrdset_first_slot(st) : \
 300                 ( (rrdset_last_slot(st) >= (unsigned long)((rrdset_last_entry_t(st) - (time_t)(t)) / (unsigned long)((st)->update_every)) ) ? \
 301                   (rrdset_last_slot(st) -  (unsigned long)((rrdset_last_entry_t(st) - (time_t)(t)) / (unsigned long)((st)->update_every)) ) : \
 302                   (rrdset_last_slot(st) -  (unsigned long)((rrdset_last_entry_t(st) - (time_t)(t)) / (unsigned long)((st)->update_every)) + (unsigned long)(st)->entries ) \
 303                 )))
 304
 305 // get the timestamp of a specific slot in the round robin database
 306 #define rrdset_slot2time(st, slot) ( rrdset_last_entry_t(st) - \
 307                 ((unsigned long)(st)->update_every * ( \
 308                                 ( (unsigned long)(slot) > rrdset_last_slot(st)) ? \
 309                                 ( (rrdset_last_slot(st) - (unsigned long)(slot) + (unsigned long)(st)->entries) ) : \
 310                                 ( (rrdset_last_slot(st) - (unsigned long)(slot)) )) \
 311                 ))
 312
 313 // ----------------------------------------------------------------------------
 314 // RRD DIMENSION functions
 315
 316 extern RRDDIM *rrddim_add(RRDSET *st, const char *id, const char *name, long multiplier, long divisor, int algorithm);
 317
 318 extern void rrddim_set_name(RRDSET *st, RRDDIM *rd, const char *name);
 319 extern void rrddim_free(RRDSET *st, RRDDIM *rd);
 320
 321 extern RRDDIM *rrddim_find(RRDSET *st, const char *id);
 322
 323 extern int rrddim_hide(RRDSET *st, const char *id);
 324 extern int rrddim_unhide(RRDSET *st, const char *id);
 325
 326 extern collected_number rrddim_set_by_pointer(RRDSET *st, RRDDIM *rd, collected_number value);
 327 extern collected_number rrddim_set(RRDSET *st, const char *id, collected_number value);
 328
 329 #endif /* NETDATA_RRD_H */