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