// SPDX-License-Identifier: GPL-3.0-or-later #ifndef NETDATA_RRD_H #define NETDATA_RRD_H 1 #ifdef __cplusplus extern "C" { #endif #include "libnetdata/libnetdata.h" // forward typedefs typedef struct rrdb RRDB; typedef struct rrdhost RRDHOST; typedef struct rrddim RRDDIM; typedef struct rrdset RRDSET; typedef struct rrdcalc RRDCALC; typedef struct rrdcalctemplate RRDCALCTEMPLATE; typedef struct alarm_entry ALARM_ENTRY; typedef struct rrdfamily_acquired RRDFAMILY_ACQUIRED; typedef struct rrdvar_acquired RRDVAR_ACQUIRED; typedef struct rrdsetvar_acquired RRDSETVAR_ACQUIRED; typedef struct rrdcalc_acquired RRDCALC_ACQUIRED; typedef struct rrdhost_acquired RRDHOST_ACQUIRED; typedef struct rrdset_acquired RRDSET_ACQUIRED; typedef struct rrddim_acquired RRDDIM_ACQUIRED; typedef struct ml_host rrd_ml_host_t; typedef struct ml_chart rrd_ml_chart_t; typedef struct ml_dimension rrd_ml_dimension_t; typedef enum __attribute__ ((__packed__)) { QUERY_SOURCE_UNKNOWN = 0, QUERY_SOURCE_API_DATA, QUERY_SOURCE_API_BADGE, QUERY_SOURCE_API_WEIGHTS, QUERY_SOURCE_HEALTH, QUERY_SOURCE_ML, QUERY_SOURCE_UNITTEST, } QUERY_SOURCE; #define RRD_STORAGE_TIERS 5 // forward declarations struct rrddim_tier; struct ml_metrics_statistics { size_t anomalous; size_t normal; size_t trained; size_t pending; size_t silenced; }; #include "storage_engine.h" #include "daemon/common.h" #include "web/api/queries/query.h" #include "web/api/queries/rrdr.h" #include "rrdvar.h" #include "rrdsetvar.h" #include "rrddimvar.h" #include "rrdcalc.h" #include "rrdcalctemplate.h" #include "rrdfunctions.h" #include "rrdlabels.h" #include "streaming/rrdpush.h" #include "aclk/aclk_rrdhost_state.h" // ---------------------------------------------------------------------------- // chart types typedef enum __attribute__ ((__packed__)) { RRDSET_TYPE_LINE = 0, RRDSET_TYPE_AREA = 1, RRDSET_TYPE_STACKED = 2, } RRDSET_TYPE; #define RRDSET_TYPE_LINE_NAME "line" #define RRDSET_TYPE_AREA_NAME "area" #define RRDSET_TYPE_STACKED_NAME "stacked" RRDSET_TYPE rrdset_type_id(const char *name); const char *rrdset_type_name(RRDSET_TYPE chart_type); #include "contexts/rrdcontext.h" typedef enum __attribute__ ((__packed__)) { RRD_BACKFILL_NONE = 0, RRD_BACKFILL_FULL, RRD_BACKFILL_NEW } RRD_BACKFILL; #define UPDATE_EVERY_MIN 1 #define UPDATE_EVERY_MAX 600 #define RRD_DEFAULT_HISTORY_ENTRIES 3600 #define RRD_HISTORY_ENTRIES_MAX (86400*365) #define RRD_ID_LENGTH_MAX 1000 // ---------------------------------------------------------------------------- // algorithms types typedef enum __attribute__ ((__packed__)) { RRD_ALGORITHM_ABSOLUTE = 0, RRD_ALGORITHM_INCREMENTAL = 1, RRD_ALGORITHM_PCENT_OVER_DIFF_TOTAL = 2, RRD_ALGORITHM_PCENT_OVER_ROW_TOTAL = 3, // this is 8-bit } RRD_ALGORITHM; #define RRD_ALGORITHM_ABSOLUTE_NAME "absolute" #define RRD_ALGORITHM_INCREMENTAL_NAME "incremental" #define RRD_ALGORITHM_PCENT_OVER_DIFF_TOTAL_NAME "percentage-of-incremental-row" #define RRD_ALGORITHM_PCENT_OVER_ROW_TOTAL_NAME "percentage-of-absolute-row" RRD_ALGORITHM rrd_algorithm_id(const char *name); const char *rrd_algorithm_name(RRD_ALGORITHM algorithm); // ---------------------------------------------------------------------------- // RRD FAMILY const RRDFAMILY_ACQUIRED *rrdfamily_add_and_acquire(RRDHOST *host, const char *id); void rrdfamily_release(RRDHOST *host, const RRDFAMILY_ACQUIRED *rfa); void rrdfamily_index_init(RRDHOST *host); void rrdfamily_index_destroy(RRDHOST *host); DICTIONARY *rrdfamily_rrdvars_dict(const RRDFAMILY_ACQUIRED *rf); // ---------------------------------------------------------------------------- // flags & options // options are permanent configuration options (no atomics to alter/access them) typedef enum __attribute__ ((__packed__)) { RRDDIM_OPTION_NONE = 0, RRDDIM_OPTION_HIDDEN = (1 << 0), // this dimension will not be offered to callers RRDDIM_OPTION_DONT_DETECT_RESETS_OR_OVERFLOWS = (1 << 1), // do not offer RESET or OVERFLOW info to callers RRDDIM_OPTION_BACKFILLED_HIGH_TIERS = (1 << 2), // when set, we have backfilled higher tiers RRDDIM_OPTION_UPDATED = (1 << 3), // single-threaded collector updated flag RRDDIM_OPTION_EXPOSED = (1 << 4), // single-threaded collector exposed flag // this is 8-bit } RRDDIM_OPTIONS; #define rrddim_option_check(rd, option) ((rd)->collector.options & (option)) #define rrddim_option_set(rd, option) (rd)->collector.options |= (option) #define rrddim_option_clear(rd, option) (rd)->collector.options &= ~(option) // flags are runtime changing status flags (atomics are required to alter/access them) typedef enum __attribute__ ((__packed__)) { RRDDIM_FLAG_NONE = 0, RRDDIM_FLAG_PENDING_HEALTH_INITIALIZATION = (1 << 0), RRDDIM_FLAG_OBSOLETE = (1 << 2), // this is marked by the collector/module as obsolete // No new values have been collected for this dimension since agent start, or it was marked RRDDIM_FLAG_OBSOLETE at // least rrdset_free_obsolete_time seconds ago. RRDDIM_FLAG_ARCHIVED = (1 << 3), RRDDIM_FLAG_METADATA_UPDATE = (1 << 4), // Metadata needs to go to the database RRDDIM_FLAG_META_HIDDEN = (1 << 6), // Status of hidden option in the metadata database // this is 8 bit } RRDDIM_FLAGS; #define rrddim_flag_check(rd, flag) (__atomic_load_n(&((rd)->flags), __ATOMIC_SEQ_CST) & (flag)) #define rrddim_flag_set(rd, flag) __atomic_or_fetch(&((rd)->flags), (flag), __ATOMIC_SEQ_CST) #define rrddim_flag_clear(rd, flag) __atomic_and_fetch(&((rd)->flags), ~(flag), __ATOMIC_SEQ_CST) // ---------------------------------------------------------------------------- // Storage tier data for every dimension struct rrddim_tier { STORAGE_POINT virtual_point; time_t next_point_end_time_s; STORAGE_METRIC_HANDLE *db_metric_handle; // the metric handle inside the database STORAGE_COLLECT_HANDLE *db_collection_handle; // the data collection handle }; void rrdr_fill_tier_gap_from_smaller_tiers(RRDDIM *rd, size_t tier, time_t now_s); // ---------------------------------------------------------------------------- // RRD DIMENSION - this is a metric struct rrddim { uuid_t metric_uuid; // global UUID for this metric (unique_across hosts) // ------------------------------------------------------------------------ // dimension definition STRING *id; // the id of this dimension (for internal identification) STRING *name; // the name of this dimension (as presented to user) RRD_ALGORITHM algorithm; // the algorithm that is applied to add new collected values RRDDIM_FLAGS flags; // run time changing status flags int32_t multiplier; // the multiplier of the collected values int32_t divisor; // the divider of the collected values // ------------------------------------------------------------------------ // operational state members struct rrdset *rrdset; rrd_ml_dimension_t *ml_dimension; // machine learning data about this dimension RRDMETRIC_ACQUIRED *rrdmetric; // the rrdmetric of this dimension #ifdef NETDATA_LOG_COLLECTION_ERRORS usec_t rrddim_store_metric_last_ut; // the timestamp we last called rrddim_store_metric() size_t rrddim_store_metric_count; // the rrddim_store_metric() counter const char *rrddim_store_metric_last_caller; // the name of the function that last called rrddim_store_metric() #endif // ------------------------------------------------------------------------ // db mode RAM, SAVE, MAP, ALLOC, NONE specifics // TODO - they should be managed by storage engine // (RRDDIM_DB_STATE ptr to an undefined structure, and a call to clean this up during destruction) struct { size_t memsize; // the memory allocated for this dimension (without RRDDIM) void *rd_on_file; // pointer to the header written on disk storage_number *data; // the array of values } db; // ------------------------------------------------------------------------ // data collection members struct { RRDDIM_OPTIONS options; // permanent configuration options uint32_t counter; // the number of times we added values to this rrddim collected_number collected_value; // the current value, as collected - resets to 0 after being used collected_number collected_value_max; // the absolute maximum of the collected value collected_number last_collected_value; // the last value that was collected, after being processed struct timeval last_collected_time; // when was this dimension last updated // this is actual date time we updated the last_collected_value // THIS IS DIFFERENT FROM THE SAME MEMBER OF RRDSET NETDATA_DOUBLE calculated_value; // the current calculated value, after applying the algorithm - resets to zero after being used NETDATA_DOUBLE last_calculated_value; // the last calculated value processed NETDATA_DOUBLE last_stored_value; // the last value as stored in the database (after interpolation) } collector; // ------------------------------------------------------------------------ struct rrddim_tier tiers[]; // our tiers of databases }; size_t rrddim_size(void); #define rrddim_id(rd) string2str((rd)->id) #define rrddim_name(rd) string2str((rd) ->name) #define rrddim_check_updated(rd) ((rd)->collector.options & RRDDIM_OPTION_UPDATED) #define rrddim_set_updated(rd) (rd)->collector.options |= RRDDIM_OPTION_UPDATED #define rrddim_clear_updated(rd) (rd)->collector.options &= ~RRDDIM_OPTION_UPDATED #define rrddim_check_exposed(rd) ((rd)->collector.options & RRDDIM_OPTION_EXPOSED) #define rrddim_set_exposed(rd) (rd)->collector.options |= RRDDIM_OPTION_EXPOSED #define rrddim_clear_exposed(rd) (rd)->collector.options &= ~RRDDIM_OPTION_EXPOSED // returns the RRDDIM cache filename, or NULL if it does not exist const char *rrddim_cache_filename(RRDDIM *rd); // updated the header with the latest RRDDIM value, for storage engines MAP and SAVE void rrddim_memory_file_update(RRDDIM *rd); // free the memory file structures for storage engines MAP and SAVE void rrddim_memory_file_free(RRDDIM *rd); // return the v019 header size of RRDDIM files size_t rrddim_memory_file_header_size(void); void rrddim_memory_file_save(RRDDIM *rd); // ---------------------------------------------------------------------------- // these loop macros make sure the linked list is accessed with the right lock #define rrddim_foreach_read(rd, st) \ dfe_start_read((st)->rrddim_root_index, rd) #define rrddim_foreach_write(rd, st) \ dfe_start_write((st)->rrddim_root_index, rd) #define rrddim_foreach_reentrant(rd, st) \ dfe_start_reentrant((st)->rrddim_root_index, rd) #define rrddim_foreach_done(rd) \ dfe_done(rd) // ---------------------------------------------------------------------------- // RRDSET - this is a chart // use this for configuration flags, not for state control // flags are set/unset in a manner that is not thread safe // and may lead to missing information. typedef enum __attribute__ ((__packed__)) { RRDSET_FLAG_DETAIL = (1 << 1), // if set, the data set should be considered as a detail of another // (the master data set should be the one that has the same family and is not detail) RRDSET_FLAG_DEBUG = (1 << 2), // enables or disables debugging for a chart RRDSET_FLAG_OBSOLETE = (1 << 3), // this is marked by the collector/module as obsolete RRDSET_FLAG_EXPORTING_SEND = (1 << 4), // if set, this chart should be sent to Prometheus web API and external databases RRDSET_FLAG_EXPORTING_IGNORE = (1 << 5), // if set, this chart should not be sent to Prometheus web API and external databases RRDSET_FLAG_UPSTREAM_SEND = (1 << 6), // if set, this chart should be sent upstream (streaming) RRDSET_FLAG_UPSTREAM_IGNORE = (1 << 7), // if set, this chart should not be sent upstream (streaming) RRDSET_FLAG_UPSTREAM_EXPOSED = (1 << 8), // if set, we have sent this chart definition to netdata parent (streaming) RRDSET_FLAG_STORE_FIRST = (1 << 9), // if set, do not eliminate the first collection during interpolation RRDSET_FLAG_HETEROGENEOUS = (1 << 10), // if set, the chart is not homogeneous (dimensions in it have multiple algorithms, multipliers or dividers) RRDSET_FLAG_HOMOGENEOUS_CHECK = (1 << 11), // if set, the chart should be checked to determine if the dimensions are homogeneous RRDSET_FLAG_HIDDEN = (1 << 12), // if set, do not show this chart on the dashboard, but use it for exporting RRDSET_FLAG_SYNC_CLOCK = (1 << 13), // if set, microseconds on next data collection will be ignored (the chart will be synced to now) RRDSET_FLAG_OBSOLETE_DIMENSIONS = (1 << 14), // this is marked by the collector/module when a chart has obsolete dimensions // No new values have been collected for this chart since agent start, or it was marked RRDSET_FLAG_OBSOLETE at // least rrdset_free_obsolete_time seconds ago. RRDSET_FLAG_ARCHIVED = (1 << 15), RRDSET_FLAG_METADATA_UPDATE = (1 << 16), // Mark that metadata needs to be stored RRDSET_FLAG_ANOMALY_DETECTION = (1 << 18), // flag to identify anomaly detection charts. RRDSET_FLAG_INDEXED_ID = (1 << 19), // the rrdset is indexed by its id RRDSET_FLAG_INDEXED_NAME = (1 << 20), // the rrdset is indexed by its name RRDSET_FLAG_PENDING_HEALTH_INITIALIZATION = (1 << 21), RRDSET_FLAG_SENDER_REPLICATION_IN_PROGRESS = (1 << 22), // the sending side has replication in progress RRDSET_FLAG_SENDER_REPLICATION_FINISHED = (1 << 23), // the sending side has completed replication RRDSET_FLAG_RECEIVER_REPLICATION_IN_PROGRESS = (1 << 24), // the receiving side has replication in progress RRDSET_FLAG_RECEIVER_REPLICATION_FINISHED = (1 << 25), // the receiving side has completed replication RRDSET_FLAG_UPSTREAM_SEND_VARIABLES = (1 << 26), // a custom variable has been updated and needs to be exposed to parent RRDSET_FLAG_COLLECTION_FINISHED = (1 << 27), // when set, data collection is not available for this chart } RRDSET_FLAGS; #define rrdset_flag_check(st, flag) (__atomic_load_n(&((st)->flags), __ATOMIC_SEQ_CST) & (flag)) #define rrdset_flag_set(st, flag) __atomic_or_fetch(&((st)->flags), flag, __ATOMIC_SEQ_CST) #define rrdset_flag_clear(st, flag) __atomic_and_fetch(&((st)->flags), ~(flag), __ATOMIC_SEQ_CST) #define rrdset_is_replicating(st) (rrdset_flag_check(st, RRDSET_FLAG_SENDER_REPLICATION_IN_PROGRESS|RRDSET_FLAG_RECEIVER_REPLICATION_IN_PROGRESS) \ && !rrdset_flag_check(st, RRDSET_FLAG_SENDER_REPLICATION_FINISHED|RRDSET_FLAG_RECEIVER_REPLICATION_FINISHED)) struct rrdset { uuid_t chart_uuid; // the global UUID for this chart // ------------------------------------------------------------------------ // chart configuration struct { STRING *type; // the type of {type}.{id} STRING *id; // the id of {type}.{id} STRING *name; // the name of {type}.{name} } parts; STRING *id; // the unique ID of the rrdset as {type}.{id} STRING *name; // the unique name of the rrdset as {type}.{name} STRING *family; // grouping sets under the same family STRING *title; // title shown to user STRING *units; // units of measurement STRING *context; // the template of this data set STRING *plugin_name; // the name of the plugin that generated this STRING *module_name; // the name of the plugin module that generated this int32_t priority; // the sorting priority of this chart int32_t update_every; // data collection frequency DICTIONARY *rrdlabels; // chart labels DICTIONARY *rrdsetvar_root_index; // chart variables DICTIONARY *rrddimvar_root_index; // dimension variables // we use this dictionary to manage their allocation RRDSET_TYPE chart_type; // line, area, stacked // ------------------------------------------------------------------------ // operational state members RRDSET_FLAGS flags; // flags STORAGE_ENGINE_ID storage_engine_id; // the db mode of this rrdset DICTIONARY *rrddim_root_index; // dimensions index rrd_ml_chart_t *ml_chart; STORAGE_METRICS_GROUP *storage_metrics_groups[RRD_STORAGE_TIERS]; // ------------------------------------------------------------------------ // linking to siblings and parents RRDHOST *rrdhost; // pointer to RRDHOST this chart belongs to RRDINSTANCE_ACQUIRED *rrdinstance; // the rrdinstance of this chart RRDCONTEXT_ACQUIRED *rrdcontext; // the rrdcontext this chart belongs to // ------------------------------------------------------------------------ // data collection members SPINLOCK data_collection_lock; uint32_t counter; // the number of times we added values to this database uint32_t counter_done; // the number of times rrdset_done() has been called time_t last_accessed_time_s; // the last time this RRDSET has been accessed usec_t usec_since_last_update; // the time in microseconds since the last collection of data struct timeval last_updated; // when this data set was last updated (updated every time the rrd_stats_done() function) struct timeval last_collected_time; // when did this data set last collected values size_t rrdlabels_last_saved_version; DICTIONARY *functions_view; // collector functions this rrdset supports, can be NULL // ------------------------------------------------------------------------ // data collection - streaming to parents, temp variables time_t upstream_resync_time_s; // the timestamp up to which we should resync clock upstream // ------------------------------------------------------------------------ // db mode SAVE, MAP specifics // TODO - they should be managed by storage engine // (RRDSET_DB_STATE ptr to an undefined structure, and a call to clean this up during destruction) struct { char *cache_dir; // the directory to store dimensions void *st_on_file; // compatibility with V019 RRDSET files int32_t entries; // total number of entries in the data set int32_t current_entry; // the entry that is currently being updated // it goes around in a round-robin fashion } db; // ------------------------------------------------------------------------ // exporting to 3rd party time-series members // TODO - they should be managed by exporting engine // (RRDSET_EXPORTING_STATE ptr to an undefined structure, and a call to clean this up during destruction) RRDSET_FLAGS *exporting_flags; // array of flags for exporting connector instances // ------------------------------------------------------------------------ // health monitoring members // TODO - they should be managed by health // (RRDSET_HEALTH_STATE ptr to an undefined structure, and a call to clean this up during destruction) NETDATA_DOUBLE green; // green threshold for this chart NETDATA_DOUBLE red; // red threshold for this chart DICTIONARY *rrdvars; // RRDVAR index for this chart const RRDFAMILY_ACQUIRED *rrdfamily; // pointer to RRDFAMILY dictionary item, this chart belongs to struct { RW_SPINLOCK spinlock; // protection for RRDCALC *base RRDCALC *base; // double linked list of RRDCALC related to this RRDSET } alerts; struct { uint32_t pos; uint32_t size; uint32_t used; RRDDIM_ACQUIRED **rda; } pluginsd; #ifdef NETDATA_LOG_REPLICATION_REQUESTS struct { bool log_next_data_collection; bool start_streaming; time_t after; time_t before; } replay; #endif // NETDATA_LOG_REPLICATION_REQUESTS }; #define rrdset_plugin_name(st) string2str((st)->plugin_name) #define rrdset_module_name(st) string2str((st)->module_name) #define rrdset_units(st) string2str((st)->units) #define rrdset_parts_type(st) string2str((st)->parts.type) #define rrdset_family(st) string2str((st)->family) #define rrdset_title(st) string2str((st)->title) #define rrdset_context(st) string2str((st)->context) #define rrdset_name(st) string2str((st)->name) #define rrdset_id(st) string2str((st)->id) STRING *rrd_string_strdupz(const char *s); // ---------------------------------------------------------------------------- // these loop macros make sure the linked list is accessed with the right lock #define rrdset_foreach_read(st, host) \ dfe_start_read((host)->rrdset_root_index, st) #define rrdset_foreach_write(st, host) \ dfe_start_write((host)->rrdset_root_index, st) #define rrdset_foreach_reentrant(st, host) \ dfe_start_reentrant((host)->rrdset_root_index, st) #define rrdset_foreach_done(st) \ dfe_done(st) #define rrdset_number_of_dimensions(st) \ dictionary_entries((st)->rrddim_root_index) void rrdset_memory_file_save(RRDSET *st); void rrdset_memory_file_free(RRDSET *st); void rrdset_memory_file_update(RRDSET *st); const char *rrdset_cache_filename(RRDSET *st); // ---------------------------------------------------------------------------- // RRDHOST flags // use this for configuration flags, not for state control // flags are set/unset in a manner that is not thread safe // and may lead to missing information. typedef enum __attribute__ ((__packed__)) { // Careful not to overlap with rrdhost_options to avoid bugs if // rrdhost_flags_xxx is used instead of rrdhost_option_xxx or vice-versa // Orphan, Archived and Obsolete flags RRDHOST_FLAG_ORPHAN = (1 << 8), // this host is orphan (not receiving data) RRDHOST_FLAG_ARCHIVED = (1 << 9), // The host is archived, no collected charts yet RRDHOST_FLAG_PENDING_OBSOLETE_CHARTS = (1 << 10), // the host has pending chart obsoletions RRDHOST_FLAG_PENDING_OBSOLETE_DIMENSIONS = (1 << 11), // the host has pending dimension obsoletions // Streaming sender RRDHOST_FLAG_RRDPUSH_SENDER_INITIALIZED = (1 << 12), // the host has initialized rrdpush structures RRDHOST_FLAG_RRDPUSH_SENDER_SPAWN = (1 << 13), // When set, the sender thread is running RRDHOST_FLAG_RRDPUSH_SENDER_CONNECTED = (1 << 14), // When set, the host is connected to a parent RRDHOST_FLAG_RRDPUSH_SENDER_READY_4_METRICS = (1 << 15), // when set, rrdset_done() should push metrics to parent RRDHOST_FLAG_RRDPUSH_SENDER_LOGGED_STATUS = (1 << 16), // when set, we have logged the status of metrics streaming // Health RRDHOST_FLAG_PENDING_HEALTH_INITIALIZATION = (1 << 17), // contains charts and dims with uninitialized variables RRDHOST_FLAG_INITIALIZED_HEALTH = (1 << 18), // the host has initialized health structures // Exporting RRDHOST_FLAG_EXPORTING_SEND = (1 << 19), // send it to external databases RRDHOST_FLAG_EXPORTING_DONT_SEND = (1 << 20), // don't send it to external databases // ACLK RRDHOST_FLAG_ACLK_STREAM_CONTEXTS = (1 << 21), // when set, we should send ACLK stream context updates RRDHOST_FLAG_ACLK_STREAM_ALERTS = (1 << 22), // set when the receiver part is disconnected // Metadata RRDHOST_FLAG_METADATA_UPDATE = (1 << 23), // metadata needs to be stored in the database RRDHOST_FLAG_METADATA_LABELS = (1 << 24), // metadata needs to be stored in the database RRDHOST_FLAG_METADATA_INFO = (1 << 25), // metadata needs to be stored in the database RRDHOST_FLAG_PENDING_CONTEXT_LOAD = (1 << 26), // metadata needs to be stored in the database RRDHOST_FLAG_CONTEXT_LOAD_IN_PROGRESS = (1 << 27), // metadata needs to be stored in the database RRDHOST_FLAG_METADATA_CLAIMID = (1 << 28), // metadata needs to be stored in the database RRDHOST_FLAG_RRDPUSH_RECEIVER_DISCONNECTED = (1 << 29), // set when the receiver part is disconnected } RRDHOST_FLAGS; #define rrdhost_flag_check(host, flag) (__atomic_load_n(&((host)->flags), __ATOMIC_SEQ_CST) & (flag)) #define rrdhost_flag_set(host, flag) __atomic_or_fetch(&((host)->flags), flag, __ATOMIC_SEQ_CST) #define rrdhost_flag_clear(host, flag) __atomic_and_fetch(&((host)->flags), ~(flag), __ATOMIC_SEQ_CST) typedef enum __attribute__ ((__packed__)) { // Indexing RRDHOST_OPTION_INDEXED_MACHINE_GUID = (1 << 0), // when set, we have indexed its machine guid RRDHOST_OPTION_INDEXED_HOSTNAME = (1 << 1), // when set, we have indexed its hostname // Streaming configuration RRDHOST_OPTION_SENDER_ENABLED = (1 << 2), // set when the host is configured to send metrics to a parent // Configuration options RRDHOST_OPTION_DELETE_OBSOLETE_CHARTS = (1 << 3), // delete files of obsolete charts RRDHOST_OPTION_DELETE_ORPHAN_HOST = (1 << 4), // delete the entire host when orphan RRDHOST_OPTION_REPLICATION = (1 << 5), // when set, we support replication for this host RRDHOST_OPTION_VIRTUAL_HOST = (1 << 6), // when set, this host is a virtual one } RRDHOST_OPTIONS; #define rrdhost_option_check(host, flag) ((host)->options & (flag)) #define rrdhost_option_set(host, flag) (host)->options |= flag #define rrdhost_option_clear(host, flag) (host)->options &= ~(flag) #define rrdhost_has_rrdpush_sender_enabled(host) (rrdhost_option_check(host, RRDHOST_OPTION_SENDER_ENABLED) && (host)->sender) #define rrdhost_can_send_definitions_to_parent(host) (rrdhost_has_rrdpush_sender_enabled(host) && rrdhost_flag_check(host, RRDHOST_FLAG_RRDPUSH_SENDER_CONNECTED)) // ---------------------------------------------------------------------------- // Health data struct alarm_entry { uint32_t unique_id; uint32_t alarm_id; uint32_t alarm_event_id; usec_t global_id; uuid_t config_hash_id; uuid_t transition_id; time_t when; time_t duration; time_t non_clear_duration; STRING *name; STRING *chart; STRING *chart_context; STRING *chart_name; STRING *family; STRING *classification; STRING *component; STRING *type; STRING *exec; STRING *recipient; time_t exec_run_timestamp; int exec_code; uint64_t exec_spawn_serial; STRING *source; STRING *units; STRING *info; NETDATA_DOUBLE old_value; NETDATA_DOUBLE new_value; STRING *old_value_string; STRING *new_value_string; RRDCALC_STATUS old_status; RRDCALC_STATUS new_status; uint32_t flags; int delay; time_t delay_up_to_timestamp; uint32_t updated_by_id; uint32_t updates_id; time_t last_repeat; struct alarm_entry *next; struct alarm_entry *next_in_progress; struct alarm_entry *prev_in_progress; }; #define ae_name(ae) string2str((ae)->name) #define ae_chart_id(ae) string2str((ae)->chart) #define ae_chart_name(ae) string2str((ae)->chart_name) #define ae_chart_context(ae) string2str((ae)->chart_context) #define ae_family(ae) string2str((ae)->family) #define ae_classification(ae) string2str((ae)->classification) #define ae_component(ae) string2str((ae)->component) #define ae_type(ae) string2str((ae)->type) #define ae_exec(ae) string2str((ae)->exec) #define ae_recipient(ae) string2str((ae)->recipient) #define ae_source(ae) string2str((ae)->source) #define ae_units(ae) string2str((ae)->units) #define ae_info(ae) string2str((ae)->info) #define ae_old_value_string(ae) string2str((ae)->old_value_string) #define ae_new_value_string(ae) string2str((ae)->new_value_string) typedef struct alarm_log { uint32_t next_log_id; uint32_t next_alarm_id; unsigned int count; unsigned int max; uint32_t health_log_history; // the health log history in seconds to be kept in db ALARM_ENTRY *alarms; RW_SPINLOCK spinlock; } ALARM_LOG; typedef struct health { unsigned int health_enabled; // 1 when this host has health enabled time_t health_delay_up_to; // a timestamp to delay alarms processing up to STRING *health_default_exec; // the full path of the alarms notifications program STRING *health_default_recipient; // the default recipient for all alarms size_t health_log_entries_written; // the number of alarm events written to the alarms event log uint32_t health_default_warn_repeat_every; // the default value for the interval between repeating warning notifications uint32_t health_default_crit_repeat_every; // the default value for the interval between repeating critical notifications } HEALTH; // ---------------------------------------------------------------------------- // RRD HOST struct rrdhost_system_info { char *cloud_provider_type; char *cloud_instance_type; char *cloud_instance_region; char *host_os_name; char *host_os_id; char *host_os_id_like; char *host_os_version; char *host_os_version_id; char *host_os_detection; char *host_cores; char *host_cpu_freq; char *host_ram_total; char *host_disk_space; char *container_os_name; char *container_os_id; char *container_os_id_like; char *container_os_version; char *container_os_version_id; char *container_os_detection; char *kernel_name; char *kernel_version; char *architecture; char *virtualization; char *virt_detection; char *container; char *container_detection; char *is_k8s_node; uint16_t hops; bool ml_capable; bool ml_enabled; char *install_type; char *prebuilt_arch; char *prebuilt_dist; int mc_version; }; struct rrdhost { char machine_guid[GUID_LEN + 1]; // the unique ID of this host // ------------------------------------------------------------------------ // host information STRING *hostname; // the hostname of this host STRING *registry_hostname; // the registry hostname for this host STRING *os; // the O/S type of the host STRING *tags; // tags for this host STRING *timezone; // the timezone of the host STRING *abbrev_timezone; // the abbriviated timezone of the host STRING *program_name; // the program name that collects metrics for this host STRING *program_version; // the program version that collects metrics for this host int32_t utc_offset; // the offset in seconds from utc RRDHOST_OPTIONS options; // configuration option for this RRDHOST (no atomics on this) RRDHOST_FLAGS flags; // runtime flags about this RRDHOST (atomics on this) RRDHOST_FLAGS *exporting_flags; // array of flags for exporting connector instances int32_t update_every; // the update frequency of the host int32_t rrd_history_entries; // the number of history entries for the host's charts STORAGE_ENGINE_ID storage_engine_id; // the configured storage engine id for the charts of this host // the actual per tier is at .db[tier].mode char *cache_dir; // the directory to save RRD cache files struct { STORAGE_ENGINE_ID id; // the storage engine id for this tier STORAGE_INSTANCE *instance; // the db instance for this tier uint32_t tier_grouping; // tier 0 iterations aggregated on this tier } db[RRD_STORAGE_TIERS]; struct rrdhost_system_info *system_info; // information collected from the host environment // ------------------------------------------------------------------------ // streaming of data to remote hosts - rrdpush sender char *rrdpush_send_destination; // where to send metrics to char *rrdpush_send_api_key; // the api key at the receiving netdata struct rrdpush_destinations *destinations; // a linked list of possible destinations struct rrdpush_destinations *destination; // the current destination from the above list SIMPLE_PATTERN *rrdpush_send_charts_matching; // pattern to match the charts to be sent int32_t rrdpush_last_receiver_exit_reason; time_t rrdpush_seconds_to_replicate; // max time we want to replicate from the child time_t rrdpush_replication_step; // seconds per replication step size_t rrdpush_receiver_replicating_charts; // the number of charts currently being replicated from a child NETDATA_DOUBLE rrdpush_receiver_replication_percent; // the % of replication completion // the following are state information for the threading // streaming metrics from this netdata to an upstream netdata struct sender_state *sender; netdata_thread_t rrdpush_sender_thread; // the sender thread size_t rrdpush_sender_replicating_charts; // the number of charts currently being replicated to a parent void *aclk_sync_host_config; uint32_t rrdpush_receiver_connection_counter; // the number of times this receiver has connected uint32_t rrdpush_sender_connection_counter; // the number of times this sender has connected // ------------------------------------------------------------------------ // streaming of data from remote hosts - rrdpush receiver time_t child_connect_time; // the time the last sender was connected time_t child_last_chart_command; // the time of the last CHART streaming command time_t child_disconnected_time; // the time the last sender was disconnected int connected_children_count; // number of senders currently streaming struct receiver_state *receiver; netdata_mutex_t receiver_lock; int trigger_chart_obsoletion_check; // set when child connects, will instruct parent to // trigger a check for obsoleted charts since previous connect // ------------------------------------------------------------------------ // health monitoring options // health variables HEALTH health; // all RRDCALCs are primarily allocated and linked here DICTIONARY *rrdcalc_root_index; // templates of alarms DICTIONARY *rrdcalctemplate_root_index; ALARM_LOG health_log; // alarms historical events (event log) uint32_t health_last_processed_id; // the last processed health id from the log uint32_t health_max_unique_id; // the max alarm log unique id given for the host uint32_t health_max_alarm_id; // the max alarm id given for the host size_t health_transitions; // the number of times an alert changed state // ------------------------------------------------------------------------ // locks SPINLOCK rrdhost_update_lock; // ------------------------------------------------------------------------ // ML handle rrd_ml_host_t *ml_host; // ------------------------------------------------------------------------ // Support for host-level labels DICTIONARY *rrdlabels; // ------------------------------------------------------------------------ // Support for functions DICTIONARY *functions; // collector functions this rrdset supports, can be NULL // ------------------------------------------------------------------------ // indexes DICTIONARY *rrdset_root_index; // the host's charts index (by id) DICTIONARY *rrdset_root_index_name; // the host's charts index (by name) DICTIONARY *rrdfamily_root_index; // the host's chart families index DICTIONARY *rrdvars; // the host's chart variables index // this includes custom host variables struct { DICTIONARY *contexts; DICTIONARY *hub_queue; DICTIONARY *pp_queue; uint32_t metrics; uint32_t instances; } rrdctx; struct { SPINLOCK spinlock; time_t first_time_s; time_t last_time_s; } retention; uuid_t host_uuid; // Global GUID for this host uuid_t *node_id; // Cloud node_id netdata_mutex_t aclk_state_lock; aclk_rrdhost_state aclk_state; struct rrdhost *next; struct rrdhost *prev; }; // ---------------------------------------------------------------------------- // RRDB struct rrdb { DICTIONARY *rrdhost_root_index; DICTIONARY *rrdhost_root_index_hostname; bool unittest_running; bool dbengine_enabled; size_t storage_tiers; bool use_direct_io; size_t storage_tiers_grouping_iterations[RRD_STORAGE_TIERS]; RRD_BACKFILL storage_tiers_backfill[RRD_STORAGE_TIERS]; int default_update_every; int default_rrd_history_entries; int gap_when_lost_iterations_above; time_t rrdset_free_obsolete_time_s; int libuv_worker_threads; bool ieee754_doubles; time_t rrdhost_free_orphan_time_s; netdata_rwlock_t rrd_rwlock; RRDHOST *localhost; int default_rrdeng_page_cache_mb; int default_rrdeng_extent_cache_mb; int db_engine_journal_check; int default_rrdeng_disk_quota_mb; int default_multidb_disk_quota_mb; STORAGE_INSTANCE *multidb_ctx[RRD_STORAGE_TIERS]; size_t page_type_size[256]; size_t tier_page_size[RRD_STORAGE_TIERS]; }; extern struct rrdb rrdb; #define rrdhost_hostname(host) string2str((host)->hostname) #define rrdhost_registry_hostname(host) string2str((host)->registry_hostname) #define rrdhost_os(host) string2str((host)->os) #define rrdhost_tags(host) string2str((host)->tags) #define rrdhost_timezone(host) string2str((host)->timezone) #define rrdhost_abbrev_timezone(host) string2str((host)->abbrev_timezone) #define rrdhost_program_name(host) string2str((host)->program_name) #define rrdhost_program_version(host) string2str((host)->program_version) #define rrdhost_aclk_state_lock(host) netdata_mutex_lock(&((host)->aclk_state_lock)) #define rrdhost_aclk_state_unlock(host) netdata_mutex_unlock(&((host)->aclk_state_lock)) #define rrdhost_receiver_replicating_charts(host) (__atomic_load_n(&((host)->rrdpush_receiver_replicating_charts), __ATOMIC_RELAXED)) #define rrdhost_receiver_replicating_charts_plus_one(host) (__atomic_add_fetch(&((host)->rrdpush_receiver_replicating_charts), 1, __ATOMIC_RELAXED)) #define rrdhost_receiver_replicating_charts_minus_one(host) (__atomic_sub_fetch(&((host)->rrdpush_receiver_replicating_charts), 1, __ATOMIC_RELAXED)) #define rrdhost_receiver_replicating_charts_zero(host) (__atomic_store_n(&((host)->rrdpush_receiver_replicating_charts), 0, __ATOMIC_RELAXED)) #define rrdhost_sender_replicating_charts(host) (__atomic_load_n(&((host)->rrdpush_sender_replicating_charts), __ATOMIC_RELAXED)) #define rrdhost_sender_replicating_charts_plus_one(host) (__atomic_add_fetch(&((host)->rrdpush_sender_replicating_charts), 1, __ATOMIC_RELAXED)) #define rrdhost_sender_replicating_charts_minus_one(host) (__atomic_sub_fetch(&((host)->rrdpush_sender_replicating_charts), 1, __ATOMIC_RELAXED)) #define rrdhost_sender_replicating_charts_zero(host) (__atomic_store_n(&((host)->rrdpush_sender_replicating_charts), 0, __ATOMIC_RELAXED)) #define rrdhost_is_online(host) ((host) == rrdb.localhost || rrdhost_option_check(host, RRDHOST_OPTION_VIRTUAL_HOST) || !rrdhost_flag_check(host, RRDHOST_FLAG_ORPHAN | RRDHOST_FLAG_RRDPUSH_RECEIVER_DISCONNECTED)) bool rrdhost_matches_window(RRDHOST *host, time_t after, time_t before, time_t now); size_t rrdhost_hosts_available(void); RRDHOST_ACQUIRED *rrdhost_find_and_acquire(const char *machine_guid); RRDHOST *rrdhost_acquired_to_rrdhost(RRDHOST_ACQUIRED *rha); void rrdhost_acquired_release(RRDHOST_ACQUIRED *rha); void rrdhost_set_is_parent_label(void); // ---------------------------------------------------------------------------- #define rrdhost_foreach_read(var) \ for((var) = rrdb.localhost; var ; (var) = (var)->next) #define rrdhost_foreach_write(var) \ for((var) = rrdb.localhost; var ; (var) = (var)->next) // ---------------------------------------------------------------------------- // global lock for all RRDHOSTs #define rrd_rdlock() netdata_rwlock_rdlock(&rrdb.rrd_rwlock) #define rrd_wrlock() netdata_rwlock_wrlock(&rrdb.rrd_rwlock) #define rrd_unlock() netdata_rwlock_unlock(&rrdb.rrd_rwlock) #define rrd_tryrdlock() netdata_rwlock_tryrdlock(&rrdb.rrd_rwlock) // ---------------------------------------------------------------------------- bool is_storage_engine_shared(STORAGE_INSTANCE *engine); void rrdset_index_init(RRDHOST *host); void rrdset_index_destroy(RRDHOST *host); void rrddim_index_init(RRDSET *st); void rrddim_index_destroy(RRDSET *st); // ---------------------------------------------------------------------------- int rrd_init(char *hostname, struct rrdhost_system_info *system_info, bool unittest); RRDHOST *rrdhost_find_by_hostname(const char *hostname); RRDHOST *rrdhost_find_by_guid(const char *guid); RRDHOST *rrdhost_find_by_node_id(const char *node_id); RRDHOST *rrdhost_create( const char *hostname, const char *registry_hostname, const char *guid, const char *os, const char *timezone, const char *abbrev_timezone, int32_t utc_offset, const char *tags, const char *program_name, const char *program_version, int update_every, long entries, STORAGE_ENGINE_ID storage_engine_id, unsigned int health_enabled, unsigned int rrdpush_enabled, char *rrdpush_destination, char *rrdpush_api_key, char *rrdpush_send_charts_matching, bool rrdpush_enable_replication, time_t rrdpush_seconds_to_replicate, time_t rrdpush_replication_step, struct rrdhost_system_info *system_info, int is_localhost, bool archived); RRDHOST *rrdhost_get_or_create( const char *hostname , const char *registry_hostname , const char *guid , const char *os , const char *timezone , const char *abbrev_timezone , int32_t utc_offset , const char *tags , const char *program_name , const char *program_version , int update_every , long history , STORAGE_ENGINE_ID storage_engine_id , unsigned int health_enabled , unsigned int rrdpush_enabled , char *rrdpush_destination , char *rrdpush_api_key , char *rrdpush_send_charts_matching , bool rrdpush_enable_replication , time_t rrdpush_seconds_to_replicate , time_t rrdpush_replication_step , struct rrdhost_system_info *system_info , bool is_archived ); int rrdhost_set_system_info_variable(struct rrdhost_system_info *system_info, char *name, char *value); // ---------------------------------------------------------------------------- // RRDSET functions int rrdset_reset_name(RRDSET *st, const char *name); RRDSET *rrdset_create_custom(RRDHOST *host , const char *type , const char *id , const char *name , const char *family , const char *context , const char *title , const char *units , const char *plugin , const char *module , long priority , int update_every , RRDSET_TYPE chart_type , STORAGE_ENGINE_ID storage_engine_id , long history_entries); #define rrdset_create(host, type, id, name, family, context, title, units, plugin, module, priority, update_every, chart_type) \ rrdset_create_custom(host, type, id, name, family, context, title, units, plugin, module, priority, update_every, chart_type, (host)->storage_engine_id, (host)->rrd_history_entries) #define rrdset_create_localhost(type, id, name, family, context, title, units, plugin, module, priority, update_every, chart_type) \ rrdset_create(rrdb.localhost, type, id, name, family, context, title, units, plugin, module, priority, update_every, chart_type) void rrdhost_free_all(void); void rrdhost_save_all(void); void rrdhost_cleanup_all(void); void rrdhost_system_info_free(struct rrdhost_system_info *system_info); void rrdhost_free___while_having_rrd_wrlock(RRDHOST *host, bool force); void rrdhost_save_charts(RRDHOST *host); void rrdhost_delete_charts(RRDHOST *host); int rrdhost_should_be_removed(RRDHOST *host, RRDHOST *protected_host, time_t now_s); void rrdset_update_heterogeneous_flag(RRDSET *st); time_t rrdset_set_update_every_s(RRDSET *st, time_t update_every_s); RRDSET *rrdset_find_by_id(RRDHOST *host, const char *id); RRDSET *rrdset_find_by_type(RRDHOST *host, const char *type, const char *id); RRDSET *rrdset_find_by_name(RRDHOST *host, const char *name); RRDSET_ACQUIRED *rrdset_find_and_acquire(RRDHOST *host, const char *id); RRDSET *rrdset_acquired_to_rrdset(RRDSET_ACQUIRED *rsa); void rrdset_acquired_release(RRDSET_ACQUIRED *rsa); void rrdset_next_usec_unfiltered(RRDSET *st, usec_t microseconds); void rrdset_next_usec(RRDSET *st, usec_t microseconds); void rrdset_timed_next(RRDSET *st, struct timeval now, usec_t microseconds); #define rrdset_next(st) rrdset_next_usec(st, 0ULL) void rrdset_timed_done(RRDSET *st, struct timeval now, bool pending_rrdset_next); void rrdset_done(RRDSET *st); void rrdset_is_obsolete(RRDSET *st); void rrdset_isnot_obsolete(RRDSET *st); // checks if the RRDSET should be offered to viewers #define rrdset_is_available_for_viewers(st) (!rrdset_flag_check(st, RRDSET_FLAG_HIDDEN) && !rrdset_flag_check(st, RRDSET_FLAG_OBSOLETE) && !rrdset_flag_check(st, RRDSET_FLAG_ARCHIVED) && rrdset_number_of_dimensions(st) && (st)->storage_engine_id != STORAGE_ENGINE_NONE) #define rrdset_is_available_for_exporting_and_alarms(st) (!rrdset_flag_check(st, RRDSET_FLAG_OBSOLETE) && !rrdset_flag_check(st, RRDSET_FLAG_ARCHIVED) && rrdset_number_of_dimensions(st)) #define rrdset_is_archived(st) (rrdset_flag_check(st, RRDSET_FLAG_ARCHIVED) && rrdset_number_of_dimensions(st)) time_t rrddim_first_entry_s(RRDDIM *rd); time_t rrddim_first_entry_s_of_tier(RRDDIM *rd, size_t tier); time_t rrddim_last_entry_s(RRDDIM *rd); time_t rrddim_last_entry_s_of_tier(RRDDIM *rd, size_t tier); time_t rrdset_first_entry_s(RRDSET *st); time_t rrdset_first_entry_s_of_tier(RRDSET *st, size_t tier); time_t rrdset_last_entry_s(RRDSET *st); time_t rrdset_last_entry_s_of_tier(RRDSET *st, size_t tier); void rrdset_get_retention_of_tier_for_collected_chart(RRDSET *st, time_t *first_time_s, time_t *last_time_s, time_t now_s, size_t tier); void rrdset_update_rrdlabels(RRDSET *st, DICTIONARY *new_rrdlabels); // ---------------------------------------------------------------------------- // RRD DIMENSION functions RRDDIM *rrddim_add(RRDSET *st, const char *id, const char *name, collected_number multiplier, collected_number divisor, RRD_ALGORITHM algorithm); int rrddim_reset_name(RRDSET *st, RRDDIM *rd, const char *name); int rrddim_set_algorithm(RRDSET *st, RRDDIM *rd, RRD_ALGORITHM algorithm); int rrddim_set_multiplier(RRDSET *st, RRDDIM *rd, int32_t multiplier); int rrddim_set_divisor(RRDSET *st, RRDDIM *rd, int32_t divisor); RRDDIM *rrddim_find_by_id(RRDSET *st, const char *id); RRDDIM_ACQUIRED *rrddim_find_and_acquire(RRDSET *st, const char *id); RRDDIM *rrddim_acquired_to_rrddim(RRDDIM_ACQUIRED *rda); void rrddim_acquired_release(RRDDIM_ACQUIRED *rda); int rrddim_hide(RRDSET *st, const char *id); int rrddim_unhide(RRDSET *st, const char *id); void rrddim_is_obsolete(RRDSET *st, RRDDIM *rd); void rrddim_isnot_obsolete(RRDSET *st, RRDDIM *rd); collected_number rrddim_timed_set_by_pointer(RRDSET *st, RRDDIM *rd, struct timeval collected_time, collected_number value); collected_number rrddim_set_by_pointer(RRDSET *st, RRDDIM *rd, collected_number value); collected_number rrddim_set(RRDSET *st, const char *id, collected_number value); bool rrddim_finalize_collection_and_check_retention(RRDDIM *rd); void rrdset_finalize_collection(RRDSET *st, bool dimensions_too); void rrdhost_finalize_collection(RRDHOST *host); void rrd_finalize_collection_for_all_hosts(void); long align_entries_to_pagesize(STORAGE_ENGINE_ID id, long entries); #ifdef NETDATA_LOG_COLLECTION_ERRORS #define rrddim_store_metric(rd, point_end_time_ut, n, flags) rrddim_store_metric_with_trace(rd, point_end_time_ut, n, flags, __FUNCTION__) void rrddim_store_metric_with_trace(RRDDIM *rd, usec_t point_end_time_ut, NETDATA_DOUBLE n, SN_FLAGS flags, const char *function); #else void rrddim_store_metric(RRDDIM *rd, usec_t point_end_time_ut, NETDATA_DOUBLE n, SN_FLAGS flags); #endif // ---------------------------------------------------------------------------- // Miscellaneous functions char *rrdset_strncpyz_name(char *to, const char *from, size_t length); // ---------------------------------------------------------------------------- // RRD internal functions void rrdset_delete_files(RRDSET *st); void rrdset_save(RRDSET *st); void rrdset_free(RRDSET *st); void rrddim_free(RRDSET *st, RRDDIM *rd); const char *rrdset_cache_dir(RRDSET *st); void set_host_properties( RRDHOST *host, int update_every, STORAGE_ENGINE_ID storage_engine_id, const char *registry_hostname, const char *os, const char *tags, const char *tzone, const char *abbrev_tzone, int32_t utc_offset, const char *program_name, const char *program_version); size_t get_tier_grouping(size_t tier); void store_metric_collection_completed(void); // ---------------------------------------------------------------------------- // RRD DB engine declarations #ifdef ENABLE_DBENGINE #include "database/engine/rrdengineapi.h" #endif #include "sqlite/sqlite_context.h" #include "sqlite/sqlite_metadata.h" #include "sqlite/sqlite_aclk.h" #include "sqlite/sqlite_aclk_alert.h" #include "sqlite/sqlite_aclk_node.h" #include "sqlite/sqlite_health.h" #ifdef __cplusplus } #endif #endif /* NETDATA_RRD_H */