Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simple Documentation Improvement - Bridging the gap between FluentD and ElasticSearch #505

Open
ZCK12 opened this issue Jun 12, 2024 · 1 comment

Comments

@ZCK12
Copy link

ZCK12 commented Jun 12, 2024

Describe the bug

The documentation for the Kubernetes DaemonSet here is very well written, but I would like to suggest that it includes a couple of sentences bridging the gap between the FluentD ElasticSearch integration and ElasticSearch itself. There is no mention of how this data is passed to ElasticSearch, which makes it difficult to know where to pick up in the ElasticSearch documentation.

Link to the problematic documentation

https://docs.fluentd.org/v/0.12/articles/kubernetes-fluentd

Expected explanation

A couple of sentences mentioning that the ElasticSearch plugin ships logs to an ElasticSearch cluster using the Elastic Index API. This makes it clear how the plugin functions, and where a reader might go to learn more.

Additional context

The ElasticSearch Index API is a guess based on the full daemonset manifest, but I think that just proves my point. It's an easy addition that noticeably improves the quality of the documentation.

@daipom
Copy link
Contributor

daipom commented Jun 13, 2024

Thanks!

https://docs.fluentd.org/v/0.12/articles/kubernetes-fluentd is for v0.12.

For v1, it seems that we should add content about K8s and ElasticSearch here.

https://docs.fluentd.org/how-to-guides

We would be glad if you could make a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants