path: root/exporting/read_config.c

// SPDX-License-Identifier: GPL-3.0-or-later

#include "exporting_engine.h"

EXPORTING_OPTIONS global_exporting_options = EXPORTING_SOURCE_DATA_AVERAGE | EXPORTING_OPTION_SEND_NAMES;
const char *global_exporting_prefix = "netdata";

struct config exporting_config = { .first_section = NULL,
                                   .last_section = NULL,
                                   .mutex = NETDATA_MUTEX_INITIALIZER,
                                   .index = { .avl_tree = { .root = NULL, .compar = appconfig_section_compare },
                                              .rwlock = AVL_LOCK_INITIALIZER } };

struct instance *prometheus_exporter_instance = NULL;

static _CONNECTOR_INSTANCE *find_instance(const char *section)
{
    _CONNECTOR_INSTANCE *local_ci;

    local_ci = add_connector_instance(NULL, NULL); // Get root section
    if (unlikely(!local_ci))
        return local_ci;

    if (!section)
        return local_ci;

    while (local_ci) {
        if (!strcmp(local_ci->instance_name, section))
            break;
        local_ci = local_ci->next;
    }
    return local_ci;
}

char *expconfig_get(struct config *root, const char *section, const char *name, const char *default_value)
{
    _CONNECTOR_INSTANCE *local_ci;

    if (!strcmp(section, CONFIG_SECTION_EXPORTING))
        return appconfig_get(root, CONFIG_SECTION_EXPORTING, name, default_value);

    local_ci = find_instance(section);

    if (!local_ci)
        return NULL; // TODO: Check if it is meaningful to return default_value

    return appconfig_get(
        root, local_ci->instance_name, name,
        appconfig_get(
            root, local_ci->connector_name, name, appconfig_get(root, CONFIG_SECTION_EXPORTING, name, default_value)));
}

int expconfig_get_boolean(struct config *root, const char *section, const char *name, int default_value)
{
    _CONNECTOR_INSTANCE *local_ci;

    if (!strcmp(section, CONFIG_SECTION_EXPORTING))
        return appconfig_get_boolean(root, CONFIG_SECTION_EXPORTING, name, default_value);

    local_ci = find_instance(section);

    if (!local_ci)
        return 0; // TODO: Check if it is meaningful to return default_value

    return appconfig_get_boolean(
        root, local_ci->instance_name, name,
        appconfig_get_boolean(
            root, local_ci->connector_name, name,
            appconfig_get_boolean(root, CONFIG_SECTION_EXPORTING, name, default_value)));
}

long long expconfig_get_number(struct config *root, const char *section, const char *name, long long default_value)
{
    _CONNECTOR_INSTANCE *local_ci;

    if (!strcmp(section, CONFIG_SECTION_EXPORTING))
        return appconfig_get_number(root, CONFIG_SECTION_EXPORTING, name, default_value);

    local_ci = find_instance(section);

    if (!local_ci)
        return 0; // TODO: Check if it is meaningful to return default_value

    return appconfig_get_number(
        root, local_ci->instance_name, name,
        appconfig_get_number(
            root, local_ci->connector_name, name,
            appconfig_get_number(root, CONFIG_SECTION_EXPORTING, name, default_value)));
}

/*
 * Get the next connector instance that we need to activate
 *
 * @param @target_ci will be filled with instance name and connector name
 *
 * @return  - 1 if more connectors to be fetched, 0 done
 *
 */

int get_connector_instance(struct connector_instance *target_ci)
{
    static _CONNECTOR_INSTANCE *local_ci = NULL;
    _CONNECTOR_INSTANCE *global_connector_instance;

    global_connector_instance = find_instance(NULL); // Fetch head of instances

    if (unlikely(!global_connector_instance))
        return 0;

    if (target_ci == NULL) {
        local_ci = NULL;
        return 1;
    }
    if (local_ci == NULL)
        local_ci = global_connector_instance;
    else {
        local_ci = local_ci->next;
        if (local_ci == NULL)
            return 0;
    }

    strcpy(target_ci->instance_name, local_ci->instance_name);
    strcpy(target_ci->connector_name, local_ci->connector_name);

    return 1;
}

/**
 * Select Type
 *
 * Select the connector type based on the user input
 *
 * @param type is the string that defines the connector type
 *
 * @return It returns the connector id.
 */
EXPORTING_CONNECTOR_TYPE exporting_select_type(const char *type)
{
    if (!strcmp(type, "graphite") || !strcmp(type, "graphite:plaintext")) {
        return EXPORTING_CONNECTOR_TYPE_GRAPHITE;
    } else if (!strcmp(type, "graphite:http") || !strcmp(type, "graphite:https")) {
        return EXPORTING_CONNECTOR_TYPE_GRAPHITE_HTTP;
    } else if (!strcmp(type, "json") || !strcmp(type, "json:plaintext")) {
        return EXPORTING_CONNECTOR_TYPE_JSON;
    } else if (!strcmp(type, "json:http") || !strcmp(type, "json:https")) {
        return EXPORTING_CONNECTOR_TYPE_JSON_HTTP;
    } else if (!strcmp(type, "opentsdb") || !strcmp(type, "opentsdb:telnet")) {
        return EXPORTING_CONNECTOR_TYPE_OPENTSDB;
    } else if (!strcmp(type, "opentsdb:http") || !strcmp(type, "opentsdb:https")) {
        return EXPORTING_CONNECTOR_TYPE_OPENTSDB_HTTP;
    } else if (
        !strcmp(type, "prometheus_remote_write") ||
        !strcmp(type, "prometheus_remote_write:http") ||
        !strcmp(type, "prometheus_remote_write:https")) {
        return EXPORTING_CONNECTOR_TYPE_PROMETHEUS_REMOTE_WRITE;
    } else if (!strcmp(type, "kinesis") || !strcmp(type, "kinesis:plaintext")) {
        return EXPORTING_CONNECTOR_TYPE_KINESIS;
    } else if (!strcmp(type, "pubsub") || !strcmp(type, "pubsub:plaintext")) {
        return EXPORTING_CONNECTOR_TYPE_PUBSUB;
    } else if (!strcmp(type, "mongodb") || !strcmp(type, "mongodb:plaintext"))
        return EXPORTING_CONNECTOR_TYPE_MONGODB;

    return EXPORTING_CONNECTOR_TYPE_UNKNOWN;
}

inline EXPORTING_OPTIONS exporting_parse_data_source(const char *data_source, EXPORTING_OPTIONS exporting_options)
{
    if (!strcmp(data_source, "raw") || !strcmp(data_source, "as collected") || !strcmp(data_source, "as-collected") ||
        !strcmp(data_source, "as_collected") || !strcmp(data_source, "ascollected")) {
        exporting_options |= EXPORTING_SOURCE_DATA_AS_COLLECTED;
        exporting_options &= ~(EXPORTING_OPTIONS_SOURCE_BITS ^ EXPORTING_SOURCE_DATA_AS_COLLECTED);
    } else if (!strcmp(data_source, "average")) {
        exporting_options |= EXPORTING_SOURCE_DATA_AVERAGE;
        exporting_options &= ~(EXPORTING_OPTIONS_SOURCE_BITS ^ EXPORTING_SOURCE_DATA_AVERAGE);
    } else if (!strcmp(data_source, "sum") || !strcmp(data_source, "volume")) {
        exporting_options |= EXPORTING_SOURCE_DATA_SUM;
        exporting_options &= ~(EXPORTING_OPTIONS_SOURCE_BITS ^ EXPORTING_SOURCE_DATA_SUM);
    } else {
        netdata_log_error("EXPORTING: invalid data data_source method '%s'.", data_source);
    }

    return exporting_options;
}

/**
 * Read configuration
 *
 * Based on read configuration an engine data structure is filled with exporting connector instances.
 *
 * @return Returns a filled engine data structure or NULL if there are no connector instances configured.
 */
struct engine *read_exporting_config()
{
    int instances_to_activate = 0;
    int exporting_config_exists = 0;

    static struct engine *engine = NULL;
    struct connector_instance_list {
        struct connector_instance local_ci;
        EXPORTING_CONNECTOR_TYPE exporting_type;

        struct connector_instance_list *next;
    };
    struct connector_instance local_ci;
    struct connector_instance_list *tmp_ci_list = NULL, *tmp_ci_list1 = NULL, *tmp_ci_list_prev = NULL;

    if (unlikely(engine))
        return engine;

    char *filename = strdupz_path_subpath(netdata_configured_user_config_dir, EXPORTING_CONF);

    exporting_config_exists = appconfig_load(&exporting_config, filename, 0, NULL);
    if (!exporting_config_exists) {
        netdata_log_info("CONFIG: cannot load user exporting config '%s'. Will try the stock version.", filename);
        freez(filename);

        filename = strdupz_path_subpath(netdata_configured_stock_config_dir, EXPORTING_CONF);
        exporting_config_exists = appconfig_load(&exporting_config, filename, 0, NULL);
        if (!exporting_config_exists)
            netdata_log_info("CONFIG: cannot load stock exporting config '%s'. Running with internal defaults.", filename);
    }

    freez(filename);

#define prometheus_config_get(name, value)                                                                             \
    appconfig_get(                                                                                                     \
        &exporting_config, CONFIG_SECTION_PROMETHEUS, name,                                                            \
        appconfig_get(&exporting_config, CONFIG_SECTION_EXPORTING, name, value))
#define prometheus_config_get_number(name, value)                                                                      \
    appconfig_get_number(                                                                                              \
        &exporting_config, CONFIG_SECTION_PROMETHEUS, name,                                                            \
        appconfig_get_number(&exporting_config, CONFIG_SECTION_EXPORTING, name, value))
#define prometheus_config_get_boolean(name, value)                                                                     \
    appconfig_get_boolean(                                                                                             \
        &exporting_config, CONFIG_SECTION_PROMETHEUS, name,                                                            \
        appconfig_get_boolean(&exporting_config, CONFIG_SECTION_EXPORTING, name, value))

    if (!prometheus_exporter_instance) {
        prometheus_exporter_instance = callocz(1, sizeof(struct instance));

        prometheus_exporter_instance->config.update_every =
            prometheus_config_get_number(EXPORTING_UPDATE_EVERY_OPTION_NAME, EXPORTING_UPDATE_EVERY_DEFAULT);

        prometheus_exporter_instance->config.options |= global_exporting_options & EXPORTING_OPTIONS_SOURCE_BITS;

        char *data_source = prometheus_config_get("data source", "average");
        prometheus_exporter_instance->config.options =
            exporting_parse_data_source(data_source, prometheus_exporter_instance->config.options);

        if (prometheus_config_get_boolean(
                "send names instead of ids", global_exporting_options & EXPORTING_OPTION_SEND_NAMES))
            prometheus_exporter_instance->config.options |= EXPORTING_OPTION_SEND_NAMES;
        else
            prometheus_exporter_instance->config.options &= ~EXPORTING_OPTION_SEND_NAMES;

        if (prometheus_config_get_boolean("send configured labels", CONFIG_BOOLEAN_YES))
            prometheus_exporter_instance->config.options |= EXPORTING_OPTION_SEND_CONFIGURED_LABELS;
        else
            prometheus_exporter_instance->config.options &= ~EXPORTING_OPTION_SEND_CONFIGURED_LABELS;

        if (prometheus_config_get_boolean("send automatic labels", CONFIG_BOOLEAN_NO))
            prometheus_exporter_instance->config.options |= EXPORTING_OPTION_SEND_AUTOMATIC_LABELS;
        else
            prometheus_exporter_instance->config.options &= ~EXPORTING_OPTION_SEND_AUTOMATIC_LABELS;

        prometheus_exporter_instance->config.charts_pattern = simple_pattern_create(
                prometheus_config_get("send charts matching", "*"),
                NULL,
                SIMPLE_PATTERN_EXACT, true);
        prometheus_exporter_instance->config.hosts_pattern = simple_pattern_create(
                prometheus_config_get("send hosts matching", "localhost *"), NULL, SIMPLE_PATTERN_EXACT, true);

        prometheus_exporter_instance->config.prefix = prometheus_config_get("prefix", global_exporting_prefix);

        prometheus_exporter_instance->config.label_prefix = prometheus_config_get("netdata label prefix", "");

        prometheus_exporter_instance->config.initialized = 1;
    }

    while (get_connector_instance(&local_ci)) {
        netdata_log_info("Processing connector instance (%s)", local_ci.instance_name);

        if (exporter_get_boolean(local_ci.instance_name, "enabled", 0)) {
            netdata_log_info(
                "Instance (%s) on connector (%s) is enabled and scheduled for activation",
                local_ci.instance_name, local_ci.connector_name);

            tmp_ci_list = (struct connector_instance_list *)callocz(1, sizeof(struct connector_instance_list));
            memcpy(&tmp_ci_list->local_ci, &local_ci, sizeof(local_ci));
            tmp_ci_list->exporting_type = exporting_select_type(local_ci.connector_name);
            tmp_ci_list->next = tmp_ci_list_prev;
            tmp_ci_list_prev = tmp_ci_list;
            instances_to_activate++;
        } else
            netdata_log_info("Instance (%s) on connector (%s) is not enabled", local_ci.instance_name, local_ci.connector_name);
    }

    if (unlikely(!instances_to_activate)) {
        netdata_log_info("No connector instances to activate");
        return NULL;
    }

    engine = (struct engine *)callocz(1, sizeof(struct engine));
    // TODO: Check and fill engine fields if actually needed

    if (exporting_config_exists) {
        engine->config.hostname =
            strdupz(exporter_get(CONFIG_SECTION_EXPORTING, "hostname", netdata_configured_hostname));
        engine->config.update_every = exporter_get_number(
            CONFIG_SECTION_EXPORTING, EXPORTING_UPDATE_EVERY_OPTION_NAME, EXPORTING_UPDATE_EVERY_DEFAULT);
    }

    while (tmp_ci_list) {
        struct instance *tmp_instance;
        char *instance_name;
        char *default_destination = "localhost";

        netdata_log_info("Instance %s on %s", tmp_ci_list->local_ci.instance_name, tmp_ci_list->local_ci.connector_name);

        if (tmp_ci_list->exporting_type == EXPORTING_CONNECTOR_TYPE_UNKNOWN) {
            netdata_log_error("Unknown exporting connector type");
            goto next_connector_instance;
        }

#ifndef ENABLE_PROMETHEUS_REMOTE_WRITE
        if (tmp_ci_list->exporting_type == EXPORTING_CONNECTOR_TYPE_PROMETHEUS_REMOTE_WRITE) {
            netdata_log_error("Prometheus Remote Write support isn't compiled");
            goto next_connector_instance;
        }
#endif

#ifndef HAVE_KINESIS
        if (tmp_ci_list->exporting_type == EXPORTING_CONNECTOR_TYPE_KINESIS) {
            netdata_log_error("AWS Kinesis support isn't compiled");
            goto next_connector_instance;
        }
#endif

#ifndef ENABLE_EXPORTING_PUBSUB
        if (tmp_ci_list->exporting_type == EXPORTING_CONNECTOR_TYPE_PUBSUB) {
            netdata_log_error("Google Cloud Pub/Sub support isn't compiled");
            goto next_connector_instance;
        }
#endif

#ifndef HAVE_MONGOC
        if (tmp_ci_list->exporting_type == EXPORTING_CONNECTOR_TYPE_MONGODB) {
            netdata_log_error("MongoDB support isn't compiled");
            goto next_connector_instance;
        }
#endif

        tmp_instance = (struct instance *)callocz(1, sizeof(struct instance));
        tmp_instance->next = engine->instance_root;
        engine->instance_root = tmp_instance;

        tmp_instance->engine = engine;
        tmp_instance->config.type = tmp_ci_list->exporting_type;

        instance_name = tmp_ci_list->local_ci.instance_name;

        tmp_instance->config.type_name = strdupz(tmp_ci_list->local_ci.connector_name);
        tmp_instance->config.name = strdupz(tmp_ci_list->local_ci.instance_name);


        tmp_instance->config.update_every =
            exporter_get_number(instance_name, EXPORTING_UPDATE_EVERY_OPTION_NAME, EXPORTING_UPDATE_EVERY_DEFAULT);

        tmp_instance->config.buffer_on_failures = exporter_get_number(instance_name, "buffer on failures", 10);

        tmp_instance->config.timeoutms = exporter_get_number(instance_name, "timeout ms", 10000);

        tmp_instance->config.charts_pattern =
                simple_pattern_create(exporter_get(instance_name, "send charts matching", "*"), NULL,
                                      SIMPLE_PATTERN_EXACT,
                                      true);

        tmp_instance->config.hosts_pattern = simple_pattern_create(
                exporter_get(instance_name, "send hosts matching", "localhost *"), NULL, SIMPLE_PATTERN_EXACT, true);

        char *data_source = exporter_get(instance_name, "data source", "average");

        tmp_instance->config.options = exporting_parse_data_source(data_source, tmp_instance->config.options);
        if (EXPORTING_OPTIONS_DATA_SOURCE(tmp_instance->config.options) != EXPORTING_SOURCE_DATA_AS_COLLECTED &&
            tmp_instance->config.update_every % localhost->rrd_update_every)
            netdata_log_info(
                "The update interval %d for instance %s is not a multiple of the database update interval %d. "
                "Metric values will deviate at different points in time.",
                tmp_instance->config.update_every, tmp_instance->config.name, localhost->rrd_update_every);

        if (exporter_get_boolean(instance_name, "send configured labels", CONFIG_BOOLEAN_YES))
            tmp_instance->config.options |= EXPORTING_OPTION_SEND_CONFIGURED_LABELS;
        else
            tmp_instance->config.options &= ~EXPORTING_OPTION_SEND_CONFIGURED_LABELS;

        if (exporter_get_boolean(instance_name, "send automatic labels", CONFIG_BOOLEAN_NO))
            tmp_instance->config.options |= EXPORTING_OPTION_SEND_AUTOMATIC_LABELS;
        else
            tmp_instance->config.options &= ~EXPORTING_OPTION_SEND_AUTOMATIC_LABELS;

        if (exporter_get_boolean(instance_name, "send names instead of ids", CONFIG_BOOLEAN_YES))
            tmp_instance->config.options |= EXPORTING_OPTION_SEND_NAMES;
        else
            tmp_instance->config.options &= ~EXPORTING_OPTION_SEND_NAMES;

        if (exporter_get_boolean(instance_name, "send variables", CONFIG_BOOLEAN_YES))
            tmp_instance->config.options |= EXPORTING_OPTION_SEND_VARIABLES;
        else 
            tmp_instance->config.options &= ~EXPORTING_OPTION_SEND_VARIABLES;

        if (tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_PROMETHEUS_REMOTE_WRITE) {
            struct prometheus_remote_write_specific_config *connector_specific_config =
                callocz(1, sizeof(struct prometheus_remote_write_specific_config));

            tmp_instance->config.connector_specific_config = connector_specific_config;

            connector_specific_config->remote_write_path =
                strdupz(exporter_get(instance_name, "remote write URL path", "/receive"));
        }

        if (tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_KINESIS) {
            struct aws_kinesis_specific_config *connector_specific_config =
                callocz(1, sizeof(struct aws_kinesis_specific_config));

            default_destination = "us-east-1";

            tmp_instance->config.connector_specific_config = connector_specific_config;

            connector_specific_config->stream_name = strdupz(exporter_get(instance_name, "stream name", ""));

            connector_specific_config->auth_key_id = strdupz(exporter_get(instance_name, "aws_access_key_id", ""));
            connector_specific_config->secure_key = strdupz(exporter_get(instance_name, "aws_secret_access_key", ""));
        }

        if (tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_PUBSUB) {
            struct pubsub_specific_config *connector_specific_config =
                callocz(1, sizeof(struct pubsub_specific_config));

            default_destination = "pubsub.googleapis.com";

            tmp_instance->config.connector_specific_config = connector_specific_config;

            connector_specific_config->credentials_file = strdupz(exporter_get(instance_name, "credentials file", ""));
            connector_specific_config->project_id = strdupz(exporter_get(instance_name, "project id", ""));
            connector_specific_config->topic_id = strdupz(exporter_get(instance_name, "topic id", ""));
        }

        if (tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_MONGODB) {
            struct mongodb_specific_config *connector_specific_config =
                callocz(1, sizeof(struct mongodb_specific_config));

            tmp_instance->config.connector_specific_config = connector_specific_config;

            connector_specific_config->database = strdupz(exporter_get(
                instance_name, "database", ""));

            connector_specific_config->collection = strdupz(exporter_get(
                instance_name, "collection", ""));
        }

        tmp_instance->config.destination = strdupz(exporter_get(instance_name, "destination", default_destination));

        tmp_instance->config.username = strdupz(exporter_get(instance_name, "username", ""));

        tmp_instance->config.password = strdupz(exporter_get(instance_name, "password", ""));

        tmp_instance->config.prefix = strdupz(exporter_get(instance_name, "prefix", "netdata"));

        tmp_instance->config.hostname = strdupz(exporter_get(instance_name, "hostname", engine->config.hostname));

#ifdef ENABLE_HTTPS

#define STR_GRAPHITE_HTTPS "graphite:https"
#define STR_JSON_HTTPS "json:https"
#define STR_OPENTSDB_HTTPS "opentsdb:https"
#define STR_PROMETHEUS_REMOTE_WRITE_HTTPS "prometheus_remote_write:https"

        if ((tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_GRAPHITE_HTTP &&
             !strncmp(tmp_ci_list->local_ci.connector_name, STR_GRAPHITE_HTTPS, strlen(STR_GRAPHITE_HTTPS))) ||
            (tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_JSON_HTTP &&
             !strncmp(tmp_ci_list->local_ci.connector_name, STR_JSON_HTTPS, strlen(STR_JSON_HTTPS))) ||
            (tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_OPENTSDB_HTTP &&
             !strncmp(tmp_ci_list->local_ci.connector_name, STR_OPENTSDB_HTTPS, strlen(STR_OPENTSDB_HTTPS))) ||
            (tmp_instance->config.type == EXPORTING_CONNECTOR_TYPE_PROMETHEUS_REMOTE_WRITE &&
             !strncmp(
                 tmp_ci_list->local_ci.connector_name, STR_PROMETHEUS_REMOTE_WRITE_HTTPS,
                 strlen(STR_PROMETHEUS_REMOTE_WRITE_HTTPS)))) {
            tmp_instance->config.options |= EXPORTING_OPTION_USE_TLS;
        }
#endif

#ifdef NETDATA_INTERNAL_CHECKS
        netdata_log_info(
            "     Dest=[%s], upd=[%d], buffer=[%d] timeout=[%ld] options=[%u]",
            tmp_instance->config.destination,
            tmp_instance->config.update_every,
            tmp_instance->config.buffer_on_failures,
            tmp_instance->config.timeoutms,
            tmp_instance->config.options);
#endif

        if (unlikely(!exporting_config_exists) && !engine->config.hostname) {
            engine->config.hostname = strdupz(config_get(instance_name, "hostname", netdata_configured_hostname));
            engine->config.update_every =
                config_get_number(instance_name, EXPORTING_UPDATE_EVERY_OPTION_NAME, EXPORTING_UPDATE_EVERY_DEFAULT);
        }

    next_connector_instance:
        tmp_ci_list1 = tmp_ci_list->next;
        freez(tmp_ci_list);
        tmp_ci_list = tmp_ci_list1;
    }

    return engine;
}