es_out: support Upstream Servers with configuration overriding #7608

mabrarov · 2023-06-25T08:42:03Z

Implementation of Upstream feature for the Elasticsearch output plugin.

This pull request is based on pull request #1560 and Forward output plugin.

It was tested in a local setup with:

Fluent Bit without Upstream feature connected to a single node of Elasticsearch cluster consisting of 3 master-eligible/data and 1 coordinating nodes.

Refer to elastic-cluster directory of mabrarov/elastic-stack repository for Docker Compose project used to create target Elasticsearch cluster and Kibana.

fluent-bit.conf Fluent Bit configuration file used for the test - refer to fluent-bit-es/fluent-bit.conf in mabrarov/elastic-stack repository.

Debug log is available at flb_es.log.
Fluent Bit with Upstream feature connected to all Elasticsearch data nodes of Elasticsearch cluster consisting of 3 master-eligible/data and 1 coordinating nodes.

Refer to elastic-cluster directory of mabrarov/elastic-stack repository for Docker Compose project used to create target Elasticsearch cluster and Kibana.

fluent-bit.conf Fluent Bit configuration file used for the test - refer to fluent-bit-es-cluster/fluent-bit.conf in mabrarov/elastic-stack repository.

Debug log is available at flb_es_upstream.log.

Testing

Example configuration files for the change can be found in mabrarov/elastic-stack repository under fluent-bit-es-cluster directory.
Debug log output from testing the change - see above.
Attached Valgrind output that shows no leaks or memory corruption was found - refer to flb_run_code_analysis.log for the output of command
```
TEST_PRESET=valgrind ./run_code_analysis.sh
```
[N/A] Run local packaging test showing all targets (including any new ones) build.
[N/A] Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

Documentation required for this feature - refer to es_out: support Upstream Servers with configuration overriding fluent-bit-docs#1143.

Backporting

[N/A] Backport to latest stable release.

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

mabrarov · 2023-06-26T07:47:46Z

plugins/out_es/es.h


-struct flb_elasticsearch {
+struct flb_elasticsearch_config {


The whole idea / implementation and naming of new types follows Upstream support in Forward output plugin.

mabrarov · 2023-06-26T07:51:56Z

plugins/out_es/es_conf_parse.c

+        return 0;
+    }
+
+    toks = flb_utils_split((const char *)cloud_auth, ':', -1);


Not:

Suggested change

toks = flb_utils_split((const char *)cloud_auth, ':', -1);

toks = flb_utils_split((const char *) cloud_auth, ':', -1);

because https://github.com/fluent/fluent-bit/blob/master/CONTRIBUTING.md requires to follow https://httpd.apache.org/dev/styleguide.html which requires to not put a space in case of type cast:

The Guidelines
...
There is no whitespace between a cast and the item modified (e.g., "(int)j" and not "(int) j").

mabrarov · 2023-06-28T09:19:30Z

Hi reviewers,

Is it possible to approve only workflow for this pull request, so that automated checks and build can start?

Thank you.

PettitWesley · 2023-06-28T17:55:39Z

@mabrarov sure

mabrarov · 2023-06-29T04:35:15Z

Hi @PettitWesley,

It looks like all failed checks are around run-macos-unit-tests jobs and caused by the following failed unit tests:

flb-rt-in_event_test
flb-rt-out_tcp

I feel like other pull requests have the same issues, i.e. it doesn't seem that the failed checks are caused by this pull request changes.

Help of maintainers is appreciated.

Thank you.

mabrarov · 2023-07-07T11:20:02Z

plugins/out_es/es_conf.c

+    }
+    tmp = flb_upstream_node_get_property(FLB_ES_CONFIG_PROPERTY_LOGSTASH_PREFIX, node);
+    if (tmp) {
+        ec->logstash_prefix = (char *)tmp;


Type cast is illegal. Should use flb_sds_create instead. Working on fix in feature/out_es_upstream_support_extended_test branch.

mabrarov · 2023-07-10T10:10:13Z

Hi @PettitWesley,

Is it possible to trigger automated workflow (build) for this pull request one more time? I found & fixed one issue and added tests for the new code since last build happened.

Thank you.

mabrarov · 2023-07-20T15:16:09Z

Hi dear reviewers,

Is it possible to get this pull request reviewed / accepted sooner? Is there something pending / waiting from my side to start review?

Thank you.

mabrarov · 2023-08-22T07:18:01Z

Hi @PettitWesley and @edsiper,

It feels like you are code owners for Elasticsearch output plugin. Is there something pending / waiting from my side to start review of this pull request? This new feature was requested 4 years ago and I feel it is something which multiple users of Fluent Bit (not just my team) would like to have.

Thank you.

mabrarov · 2024-11-03T18:29:02Z

FYI, the competitor of Fluent Bit - Vector - supports multiple Elasticsearch hosts in its elastcisearch sink. Refer to https://vector.dev/docs/reference/configuration/sinks/elasticsearch/#endpoints. Note that it looks like Vector uses smart approach (not like this pull request) when deciding what Elasticsearch endpoint to send data, because sink configuration supports healthcheck. Just like Fluentd Elasticsearch plugin.

…wn to parser of Upstream node configuration section are implemented, e.g. "host" and "port" Signed-off-by: Marat Abrarov <[email protected]>

…o the test callback based on configuration of Fluent Bit and based on configuration of plugin Signed-off-by: Marat Abrarov <[email protected]>

…llback contract Signed-off-by: Marat Abrarov <[email protected]>

…with Upstream node configuration For Elastic cloud authentication these parameters are always taken from plugin configuration and never from Upstream node configuration: cloud_id. For AWS authentication these parameters are always taken from plugin configuration and never from Upstream node configuration: http_proxy, no_proxy, tls*. Signed-off-by: Marat Abrarov <[email protected]>

Signed-off-by: Marat Abrarov <[email protected]>

cosmo0920 · 2024-11-28T07:59:35Z

plugins/out_es/es_conf_parse.c

+    region = strtok(buf, dollar);
+    if (region == NULL) {
+        return NULL;
+    }
+    host = strtok(NULL, dollar);
+    if (host == NULL) {
+        return NULL;
+    }


Do we need to use flb_utils_split instead of strtok?
This is because strtok is one of the dangerous functions which are still provided in libc.

It's original code - refer to https://github.com/fluent/fluent-bit/blob/master/plugins/out_es/es_conf.c#L67-L74 - moved to a new location. We can try to fix it, but that way we will spend time in this pull request fixing all issues of original code (which is not goal of this pull request). Sorry, but I am not sure this pull request is the best place / time for doing that (but I understand, that it's a good chance to cleanup the code).

cosmo0920

I also found the dangerous functions usages from libc.
The added patch is basically reasonable at the point of codes.
I'll take more time to review this PR tomorrow.

cosmo0920 · 2024-11-28T10:22:03Z

plugins/out_es/es_conf_parse.c

+    strcpy(cloud_host_buf, host);
+    strcat(cloud_host_buf, ".");
+    strcat(cloud_host_buf, region);
+    if (port != NULL) {
+        strcat(cloud_host_buf, ":");
+        strcat(cloud_host_buf, port);
+    }


We need to use strict length version of strncat and strcpy at least.
Or, Fluent Bit offers the flb_sds function APIs which can handling more safely to process strings.
Could you use them if you could do?

This part is original code - refer to https://github.com/fluent/fluent-bit/blob/master/plugins/out_es/es_conf.c#L92-L95 - moved to a new location. More changes we introduce into this pull request - harder it will be accept / test this pull request. I'm not against of fixing issues of original code in this pull request too (in dedicated commit(s)), but I'd like to ensure it is really needed and requesters of fixes realize the source of these issues.

mabrarov requested review from PettitWesley, edsiper, niedbalski, leonardo-albertovich, fujimotos and koleini as code owners June 25, 2023 08:42

github-actions bot added the docs-required label Jun 25, 2023

mabrarov mentioned this pull request Jun 25, 2023

es_out: support Upstream Servers with configuration overriding fluent/fluent-bit-docs#1143

Open

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from 812020d to ba3382a Compare June 25, 2023 09:06

mabrarov mentioned this pull request Jun 25, 2023

es_out: support Upstream Servers #1560

Open

mabrarov commented Jun 26, 2023

View reviewed changes

mabrarov temporarily deployed to pr June 28, 2023 17:55 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr June 28, 2023 18:22 — with GitHub Actions Inactive

mabrarov commented Jul 7, 2023

View reviewed changes

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from ba3382a to b7cd81b Compare July 8, 2023 10:22

mabrarov temporarily deployed to pr July 10, 2023 12:05 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr July 10, 2023 12:28 — with GitHub Actions Inactive

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from b7cd81b to b81d3f7 Compare July 20, 2023 19:38

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from b81d3f7 to f6431c2 Compare September 30, 2023 13:32

mabrarov temporarily deployed to pr November 9, 2024 23:53 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr November 10, 2024 00:14 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr November 10, 2024 00:15 — with GitHub Actions Inactive

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from ce00434 to 7b6b43f Compare November 12, 2024 01:47

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from 7b6b43f to f4bf0f9 Compare November 22, 2024 20:44

mabrarov temporarily deployed to pr November 22, 2024 20:45 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr November 22, 2024 21:09 — with GitHub Actions Inactive

edsiper assigned cosmo0920 Nov 27, 2024

mabrarov added 5 commits November 28, 2024 09:17

pipeline: outputs: es: basic support of Upstream, only parameters kno…

f0e243c

…wn to parser of Upstream node configuration section are implemented, e.g. "host" and "port" Signed-off-by: Marat Abrarov <[email protected]>

engine: support of tests which require generation of context passed t…

580f217

…o the test callback based on configuration of Fluent Bit and based on configuration of plugin Signed-off-by: Marat Abrarov <[email protected]>

pipeline: outputs: es: fixed tests after modification of formatter ca…

9594d7f

…llback contract Signed-off-by: Marat Abrarov <[email protected]>

pipeline: outputs: es: tests for upstream node configuration properties

952be6d

Signed-off-by: Marat Abrarov <[email protected]>

cosmo0920 requested changes Nov 28, 2024

View reviewed changes

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from f4bf0f9 to 952be6d Compare November 28, 2024 11:24

mabrarov temporarily deployed to pr November 28, 2024 11:24 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr November 28, 2024 11:46 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

es_out: support Upstream Servers with configuration overriding #7608

es_out: support Upstream Servers with configuration overriding #7608

mabrarov commented Jun 25, 2023 •

edited

Loading

mabrarov Jun 26, 2023

mabrarov Jun 26, 2023 •

edited

Loading

mabrarov commented Jun 28, 2023

PettitWesley commented Jun 28, 2023

mabrarov commented Jun 29, 2023 •

edited

Loading

mabrarov Jul 7, 2023 •

edited

Loading

mabrarov Jul 8, 2023

mabrarov commented Jul 10, 2023

mabrarov commented Jul 20, 2023

mabrarov commented Aug 22, 2023

mabrarov commented Nov 3, 2024

cosmo0920 Nov 28, 2024

mabrarov Nov 28, 2024 •

edited

Loading

cosmo0920 left a comment

cosmo0920 Nov 28, 2024

mabrarov Nov 28, 2024

	toks = flb_utils_split((const char *)cloud_auth, ':', -1);
	toks = flb_utils_split((const char *) cloud_auth, ':', -1);


		struct flb_elasticsearch {
		struct flb_elasticsearch_config {

es_out: support Upstream Servers with configuration overriding #7608

Are you sure you want to change the base?

es_out: support Upstream Servers with configuration overriding #7608

Conversation

mabrarov commented Jun 25, 2023 • edited Loading

mabrarov Jun 26, 2023

Choose a reason for hiding this comment

mabrarov Jun 26, 2023 • edited Loading

Choose a reason for hiding this comment

mabrarov commented Jun 28, 2023

PettitWesley commented Jun 28, 2023

mabrarov commented Jun 29, 2023 • edited Loading

mabrarov Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

mabrarov Jul 8, 2023

Choose a reason for hiding this comment

mabrarov commented Jul 10, 2023

mabrarov commented Jul 20, 2023

mabrarov commented Aug 22, 2023

mabrarov commented Nov 3, 2024

cosmo0920 Nov 28, 2024

Choose a reason for hiding this comment

mabrarov Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

cosmo0920 left a comment

Choose a reason for hiding this comment

cosmo0920 Nov 28, 2024

Choose a reason for hiding this comment

mabrarov Nov 28, 2024

Choose a reason for hiding this comment

mabrarov commented Jun 25, 2023 •

edited

Loading

mabrarov Jun 26, 2023 •

edited

Loading

mabrarov commented Jun 29, 2023 •

edited

Loading

mabrarov Jul 7, 2023 •

edited

Loading

mabrarov Nov 28, 2024 •

edited

Loading