fluent / fluent/fluentd-docs-gitbook

Simple Documentation Improvement - Bridging the gap between FluentD and ElasticSearch

Open
#505 1 comment 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
CSS
Stars
46
Forks
136
Avg merge
4h 47m
Merged PRs (30d)
16

Description

### Describe the bug

The documentation for the Kubernetes DaemonSet [here](https://docs.fluentd.org/v/0.12/articles/kubernetes-fluentd) 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html). 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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.