fluent / fluentd-docs-gitbook

Fluentd documentation project in Gitbook format
https://docs.fluentd.org
Apache License 2.0
43 stars 128 forks source link

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

Open ZCK12 opened 1 month ago

ZCK12 commented 1 month ago

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 commented 1 month ago

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.