in_premetheus_remote_write: Implement handler of payloads of promethe…

…us remote write protocol (#8725) in_prometheus_remote_write: Implement prometheus remote write input plugin. This plugin is able to handle the following types currently: - Counter - Gauge - Untyped - Histogram Summary type of metrics shouldn't be handled and decoded correctly for now. --------- Signed-off-by: Hiroshi Hatake <[email protected]>
fluent · May 16, 2024 · 7de2c45 · 7de2c45
1 parent 9311b43
commit 7de2c45
Show file tree

Hide file tree

Showing 12 changed files with 1,341 additions and 0 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -209,6 +209,7 @@ option(FLB_IN_ELASTICSEARCH            "Enable Elasticsearch (Bulk API) input pl
 option(FLB_IN_CALYPTIA_FLEET           "Enable Calyptia Fleet input plugin"           Yes)
 option(FLB_IN_SPLUNK                   "Enable Splunk HTTP HEC input plugin"          Yes)
 option(FLB_IN_PROCESS_EXPORTER_METRICS "Enable process exporter metrics input plugin" Yes)
+option(FLB_IN_PROMETHEUS_REMOTE_WRITE  "Enable prometheus remote write input plugin"  Yes)
 option(FLB_OUT_AZURE                   "Enable Azure output plugin"                   Yes)
 option(FLB_OUT_AZURE_BLOB              "Enable Azure output plugin"                   Yes)
 option(FLB_OUT_AZURE_LOGS_INGESTION    "Enable Azure Logs Ingestion output plugin"    Yes)

diff --git a/cmake/windows-setup.cmake b/cmake/windows-setup.cmake
@@ -61,6 +61,7 @@ if(FLB_WINDOWS_DEFAULTS)
   set(FLB_IN_PODMAN_METRICS      No)
   set(FLB_IN_ELASTICSEARCH      Yes)
   set(FLB_IN_SPLUNK             Yes)
+  set(FLB_IN_PROMETHEUS_REMOTE_WRITE Yes)
 
   # OUTPUT plugins
   # ==============

diff --git a/plugins/CMakeLists.txt b/plugins/CMakeLists.txt
@@ -229,6 +229,7 @@ REGISTER_IN_PLUGIN("in_opentelemetry")
 REGISTER_IN_PLUGIN("in_elasticsearch")
 REGISTER_IN_PLUGIN("in_calyptia_fleet")
 REGISTER_IN_PLUGIN("in_splunk")
+REGISTER_IN_PLUGIN("in_prometheus_remote_write")
 
 # Test the event loop messaging when used in threaded mode
 REGISTER_IN_PLUGIN("in_event_test")

diff --git a/plugins/in_prometheus_remote_write/CMakeLists.txt b/plugins/in_prometheus_remote_write/CMakeLists.txt
@@ -0,0 +1,12 @@
+if(NOT FLB_METRICS)
+  message(FATAL_ERROR "Prometheus remote write input plugin requires FLB_HTTP_SERVER=On.")
+endif()
+
+set(src
+  prom_rw.c
+  prom_rw_prot.c
+  prom_rw_conn.c
+  prom_rw_config.c
+  )
+
+FLB_PLUGIN(in_prometheus_remote_write "${src}" "monkey-core-static")
diff --git a/plugins/in_prometheus_remote_write/prom_rw.c b/plugins/in_prometheus_remote_write/prom_rw.c
@@ -0,0 +1,250 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+
+/*  Fluent Bit
+ *  ==========
+ *  Copyright (C) 2015-2024 The Fluent Bit Authors
+ *
+ *  Licensed under the Apache License, Version 2.in_in (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.in_in
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+
+#include <fluent-bit/flb_input_plugin.h>
+#include <fluent-bit/flb_downstream.h>
+#include <fluent-bit/flb_network.h>
+#include <fluent-bit/flb_config.h>
+
+#include "prom_rw.h"
+#include "prom_rw_conn.h"
+#include "prom_rw_prot.h"
+#include "prom_rw_config.h"
+
+/*
+ * For a server event, the collection event means a new client have arrived, we
+ * accept the connection and create a new TCP instance which will wait for
+ * JSON map messages.
+ */
+static int prom_rw_collect(struct flb_input_instance *ins,
+                           struct flb_config *config, void *in_context)
+{
+    struct flb_connection    *connection;
+    struct prom_remote_write_conn *conn;
+    struct flb_prom_remote_write  *ctx;
+
+    ctx = in_context;
+
+    connection = flb_downstream_conn_get(ctx->downstream);
+
+    if (connection == NULL) {
+        flb_plg_error(ctx->ins, "could not accept new connection");
+
+        return -1;
+    }
+
+    flb_plg_trace(ctx->ins, "new TCP connection arrived FD=%i", connection->fd);
+
+    conn = prom_rw_conn_add(connection, ctx);
+
+    if (conn == NULL) {
+        return -1;
+    }
+
+    return 0;
+}
+
+static int prom_rw_init(struct flb_input_instance *ins,
+                        struct flb_config *config, void *data)
+{
+    unsigned short int        port;
+    int                       ret;
+    struct flb_prom_remote_write *ctx;
+
+    (void) data;
+
+    /* Create context and basic conf */
+    ctx = prom_rw_config_create(ins);
+    if (!ctx) {
+        return -1;
+    }
+    ctx->collector_id = -1;
+
+    /* Populate context with config map defaults and incoming properties */
+    ret = flb_input_config_map_set(ins, (void *) ctx);
+    if (ret == -1) {
+        flb_plg_error(ctx->ins, "configuration error");
+        prom_rw_config_destroy(ctx);
+        return -1;
+    }
+
+    /* Set the context */
+    flb_input_set_context(ins, ctx);
+
+    port = (unsigned short int) strtoul(ctx->tcp_port, NULL, 10);
+
+    if (ctx->enable_http2) {
+        ret = flb_http_server_init(&ctx->http_server,
+                                    HTTP_PROTOCOL_AUTODETECT,
+                                    (FLB_HTTP_SERVER_FLAG_KEEPALIVE | FLB_HTTP_SERVER_FLAG_AUTO_INFLATE),
+                                    NULL,
+                                    ins->host.listen,
+                                    ins->host.port,
+                                    ins->tls,
+                                    ins->flags,
+                                    &ins->net_setup,
+                                    flb_input_event_loop_get(ins),
+                                    ins->config,
+                                    (void *) ctx);
+
+        if (ret != 0) {
+            flb_plg_error(ctx->ins,
+                          "could not initialize http server on %s:%u. Aborting",
+                          ins->host.listen, ins->host.port);
+
+            prom_rw_config_destroy(ctx);
+
+            return -1;
+        }
+
+        ret = flb_http_server_start(&ctx->http_server);
+
+        if (ret != 0) {
+            flb_plg_error(ctx->ins,
+                          "could not start http server on %s:%u. Aborting",
+                          ins->host.listen, ins->host.port);
+
+            prom_rw_config_destroy(ctx);
+
+            return -1;
+        }
+
+        ctx->http_server.request_callback = prom_rw_prot_handle_ng;
+
+        flb_input_downstream_set(ctx->http_server.downstream, ctx->ins);
+    }
+    else {
+        ctx->downstream = flb_downstream_create(FLB_TRANSPORT_TCP,
+                                                ins->flags,
+                                                ctx->listen,
+                                                port,
+                                                ins->tls,
+                                                config,
+                                                &ins->net_setup);
+
+        if (ctx->downstream == NULL) {
+            flb_plg_error(ctx->ins,
+                        "could not initialize downstream on %s:%s. Aborting",
+                        ctx->listen, ctx->tcp_port);
+
+            prom_rw_config_destroy(ctx);
+
+            return -1;
+        }
+
+        flb_input_downstream_set(ctx->downstream, ctx->ins);
+
+        /* Collect upon data available on the standard input */
+        ret = flb_input_set_collector_socket(ins,
+                                             prom_rw_collect,
+                                             ctx->downstream->server_fd,
+                                             config);
+        if (ret == -1) {
+            flb_plg_error(ctx->ins, "Could not set collector for IN_TCP input plugin");
+            prom_rw_config_destroy(ctx);
+            return -1;
+        }
+
+        ctx->collector_id = ret;
+    }
+
+    flb_plg_info(ctx->ins, "listening on %s:%s", ctx->listen, ctx->tcp_port);
+
+    if (ctx->successful_response_code != 200 &&
+        ctx->successful_response_code != 201 &&
+        ctx->successful_response_code != 204) {
+        flb_plg_error(ctx->ins, "%d is not supported response code. Use default 201",
+                      ctx->successful_response_code);
+        ctx->successful_response_code = 201;
+    }
+
+    return 0;
+}
+
+static int prom_rw_exit(void *data, struct flb_config *config)
+{
+    struct flb_prom_remote_write *ctx;
+
+    (void) config;
+
+    ctx = data;
+
+    if (ctx != NULL) {
+        prom_rw_config_destroy(ctx);
+    }
+
+    return 0;
+}
+
+/* Configuration properties map */
+static struct flb_config_map config_map[] = {
+    {
+     FLB_CONFIG_MAP_BOOL, "http2", "true",
+     0, FLB_TRUE, offsetof(struct flb_prom_remote_write, enable_http2),
+     NULL
+    },
+
+    {
+     FLB_CONFIG_MAP_SIZE, "buffer_max_size", HTTP_BUFFER_MAX_SIZE,
+     0, FLB_TRUE, offsetof(struct flb_prom_remote_write, buffer_max_size),
+     ""
+    },
+
+    {
+     FLB_CONFIG_MAP_SIZE, "buffer_chunk_size", HTTP_BUFFER_CHUNK_SIZE,
+     0, FLB_TRUE, offsetof(struct flb_prom_remote_write, buffer_chunk_size),
+     ""
+    },
+
+    {
+     FLB_CONFIG_MAP_STR, "uri", NULL,
+     0, FLB_TRUE, offsetof(struct flb_prom_remote_write, uri),
+     "Specify an optional HTTP URI for the target web server, e.g: /something"
+    },
+
+    {
+     FLB_CONFIG_MAP_BOOL, "tag_from_uri", "true",
+     0, FLB_TRUE, offsetof(struct flb_prom_remote_write, tag_from_uri),
+     "If true, tag will be created from uri. e.g. v1_metrics from /v1/metrics ."
+    },
+    {
+     FLB_CONFIG_MAP_INT, "successful_response_code", "201",
+     0, FLB_TRUE, offsetof(struct flb_prom_remote_write, successful_response_code),
+     "Set successful response code. 200, 201 and 204 are supported."
+    },
+
+    /* EOF */
+    {0}
+};
+
+/* Plugin reference */
+struct flb_input_plugin in_prometheus_remote_write_plugin = {
+    .name         = "prometheus_remote_write",
+    .description  = "Prometheus Remote Write input",
+    .cb_init      = prom_rw_init,
+    .cb_pre_run   = NULL,
+    .cb_collect   = prom_rw_collect,
+    .cb_flush_buf = NULL,
+    .cb_pause     = NULL,
+    .cb_resume    = NULL,
+    .cb_exit      = prom_rw_exit,
+    .config_map   = config_map,
+    .flags        = FLB_INPUT_NET_SERVER | FLB_IO_OPT_TLS
+};
diff --git a/plugins/in_prometheus_remote_write/prom_rw.h b/plugins/in_prometheus_remote_write/prom_rw.h
@@ -0,0 +1,60 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+
+/*  Fluent Bit
+ *  ==========
+ *  Copyright (C) 2015-2024 The Fluent Bit Authors
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+#ifndef FLB_IN_PROM_RW_H
+#define FLB_IN_PROM_RW_H
+
+#include <fluent-bit/flb_config.h>
+#include <fluent-bit/flb_input.h>
+#include <fluent-bit/flb_utils.h>
+
+#include <monkey/monkey.h>
+#include <fluent-bit/http_server/flb_http_server.h>
+
+#define HTTP_BUFFER_MAX_SIZE    "4M"
+#define HTTP_BUFFER_CHUNK_SIZE  "512K"
+
+struct flb_prom_remote_write {
+    int successful_response_code;
+    flb_sds_t listen;
+    flb_sds_t tcp_port;
+    int  tag_from_uri;
+
+    struct flb_input_instance *ins;
+
+    /* HTTP URI */
+    char *uri;
+
+    /* New gen HTTP server */
+    int enable_http2;
+    struct flb_http_server http_server;
+
+    /* Legacy HTTP server */
+    size_t buffer_max_size;            /* Maximum buffer size */
+    size_t buffer_chunk_size;          /* Chunk allocation size */
+
+    int collector_id;                  /* Listener collector id       */
+    struct flb_downstream *downstream; /* Client manager */
+    struct mk_list connections;        /* linked list of connections */
+
+    struct mk_server *server;
+};
+
+
+#endif