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

Docs don't contain conf location for Docker #2285

Closed
DarrienG opened this issue Feb 4, 2019 · 5 comments
Closed

Docs don't contain conf location for Docker #2285

DarrienG opened this issue Feb 4, 2019 · 5 comments

Comments

@DarrienG
Copy link

DarrienG commented Feb 4, 2019

I'm not entirely sure where the doc source is located, so I'm posting here. Not a very big issue to fix, but the current docs for finding the config file are located here: https://docs.fluentd.org/v0.12/articles/config-file

And are also the top Google result if you Google fluent config file

The current docs list:

/etc/td-agent/td-agent.conf

and

/etc/fluent/fluent.conf

As the only two places the config file might be.

However when using the Docker container, the config file is located in /fluentd/etc which is not documented there and is hiding somewhere in the middle of the official DockerHub repo: https://hub.docker.com/r/fluent/fluentd/ only briefly mentioned in a docker mount command:

docker run -ti --rm -v /path/to/dir:/fluentd/etc fluentd -c /fluentd/etc/ -v

I spent a good 30 minutes poking around for this non-standard config location. Since the place in docker containers for the config file is... uh... interesting, could it please be added to https://docs.fluentd.org/v0.12/articles/config-file ?

Thanks :)

@DarrienG DarrienG changed the title Docs don't container conf location for Docker Docs don't contain conf location for Docker Feb 4, 2019
@repeatedly
Copy link
Member

Since the place in docker containers for the config file is... uh... interesting, could it please be added to https://docs.fluentd.org/v0.12/articles/config-file ?

This is docker image specific directory, this is why we need -c option to tell it,so if we add note for conf location, it should be in docker image README.

@DarrienG
Copy link
Author

DarrienG commented Feb 6, 2019

I disagree, by doing that you're pretty much saying Docker is not a first class citizen (which I think most people using Fluentd would disagree with).

Take a competitor - Filebeat for instance: https://www.elastic.co/guide/en/beats/filebeat/current/directory-layout.html

Default paths for all installation types are listed. There's even an explanation of what each dir does, and how they can autostart!

Edit: For what it's worth, the -c option is listed in the the fluentd config docs, but listed as so:

-c option

See Command Line Option article.

Which pretty much just says it exists. But there's no reason for me to check it.

If -c is the recommended way of doing things, it should be a first class citizen and placed throughout the docs more brazenly. As of now it's just sort of brushed to the side.

@repeatedly
Copy link
Member

I think most people using Fluentd

You have a point. Fluentd with docker is now popular so adding it to the fluentd-docs seems reasonable.
Could you send a PR?

@DarrienG
Copy link
Author

DarrienG commented Feb 6, 2019

Sure :)

fluent/fluentd-docs#614

@repeatedly
Copy link
Member

Merged fluentd-docs patch. Thanks

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