src/rrd.h

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