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 and (same in YAML format) fluent-bit-es/fluent-bit.yaml 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 and (same in YAML format) fluent-bit-es-cluster/fluent-bit.yaml 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 SKIP_TESTS='flb-rt-out_td flb-it-network' ./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.

plugins/out_es/es.h

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.

patrick-stephens · 2025-04-28T15:08:59Z

@mabrarov / @cosmo0920 are the issues covered here? There's a lot of stuff in the conversation so not sure if the changes have been actioned.

mabrarov · 2025-04-28T15:53:02Z

Hi @patrick-stephens,

Answering your question about status of this pull request (my understanding): review of @cosmo0920 ended with conclusion that the ownership tracking (please note that it is not reference counting) implemented in this pull request doesn't follow Fluent Bit code style / architecture (which is true. IMHO, it is so, because existing Fluent Bit code doesn't have the case which this pull request has). Unfortunately, I failed to find better solution, because the only alternative - duplication of configuration per each upstream node - drastically complicates code without real benefit. I'd like Fluent Bit maintainers and community to review this pull request one more time. Maybe it's the case when it is acceptable to introduce changes into configuration data ownership handling.

Thank you.

…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]>

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

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

plugins/out_es/es.h Show resolved Hide resolved

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

patrick-stephens added the ok-package-test Run PR packaging tests label Apr 28, 2025

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from dbf8ccb to 9de393c Compare April 30, 2025 22:42

mabrarov temporarily deployed to pr April 30, 2025 22:42 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr April 30, 2025 23:05 — with GitHub Actions Inactive

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from 9de393c to 8351ef1 Compare May 17, 2025 00:59

mabrarov temporarily deployed to pr May 17, 2025 01:00 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr May 17, 2025 01:22 — with GitHub Actions Inactive

mabrarov added 6 commits May 23, 2025 23:26

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

c0fee9a

…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…

0d9c1b4

…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…

27c846f

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

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

4abc828

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

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

5e515cd

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

mabrarov force-pushed the feature/out_es_upstream_support_extended branch from 8351ef1 to 5e515cd Compare May 24, 2025 08:54

mabrarov temporarily deployed to pr May 24, 2025 08:54 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr May 24, 2025 09:10 — with GitHub Actions Inactive

mabrarov temporarily deployed to pr May 24, 2025 09:11 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

es_out: support Upstream Servers with configuration overriding #7608

es_out: support Upstream Servers with configuration overriding #7608

Uh oh!

mabrarov commented Jun 25, 2023 •

edited

Loading

Uh oh!

Uh oh!

mabrarov Jun 26, 2023 •

edited

Loading

Uh oh!

mabrarov commented Jun 28, 2023

Uh oh!

PettitWesley commented Jun 28, 2023

Uh oh!

mabrarov commented Jun 29, 2023 •

edited

Loading

Uh oh!

mabrarov Jul 7, 2023 •

edited

Loading

Uh oh!

mabrarov Jul 8, 2023

Uh oh!

mabrarov commented Jul 10, 2023

Uh oh!

mabrarov commented Jul 20, 2023

Uh oh!

mabrarov commented Aug 22, 2023

Uh oh!

patrick-stephens commented Apr 28, 2025

Uh oh!

mabrarov commented Apr 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

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

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

Uh oh!

Conversation

mabrarov commented Jun 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

mabrarov Jun 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mabrarov commented Jun 28, 2023

Uh oh!

PettitWesley commented Jun 28, 2023

Uh oh!

mabrarov commented Jun 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mabrarov Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mabrarov Jul 8, 2023

Choose a reason for hiding this comment

Uh oh!

mabrarov commented Jul 10, 2023

Uh oh!

mabrarov commented Jul 20, 2023

Uh oh!

mabrarov commented Aug 22, 2023

Uh oh!

patrick-stephens commented Apr 28, 2025

Uh oh!

mabrarov commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

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 commented Apr 28, 2025 •

edited

Loading