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

Sample config should have all non-system plugins disabled by default #199

Closed
pauldix opened this issue Sep 15, 2015 · 7 comments
Closed

Comments

@pauldix
Copy link
Member

pauldix commented Sep 15, 2015

For the generated sample config all plugins that aren't the system plugin should be disabled. It's painful for a new user setting up Telegraf initially to have to go through and disable all the plugins since they're most likely only going to have one or two they want to use.

@sparrc
Copy link
Contributor

sparrc commented Sep 15, 2015

that's a good idea, I already did this for the .deb and .rpm package default config for the same reason

@sparrc
Copy link
Contributor

sparrc commented Sep 22, 2015

@pauldix I came up with a different solution while I was working on a filtering change.

See PR #217, this will allow users to specify the plugins and outputs they want when they generate the config file, like:

telegraf -sample-config -filter cpu:mem:swap -outputfilter influxdb

Also, when installing from the deb/rpm package, only influxdb and a few of the system plugins are enabled by default

sparrc added a commit that referenced this issue Sep 22, 2015
sparrc added a commit that referenced this issue Sep 22, 2015
sparrc added a commit that referenced this issue Sep 22, 2015
sparrc added a commit that referenced this issue Sep 22, 2015
sparrc added a commit that referenced this issue Sep 22, 2015
@sparrc
Copy link
Contributor

sparrc commented Oct 13, 2015

closing this as fixed by the -filter and -outputfilter flags, these should now be used to create config files.

@sparrc sparrc closed this as completed Oct 13, 2015
@pauldix
Copy link
Member Author

pauldix commented Oct 13, 2015

Will it still output all the other plugin configs commented out or disabled? It's helpful for users to have that in there rather than having to know all of the plugin names that exist so that they can put them in the command line when generating the file.

@sparrc
Copy link
Contributor

sparrc commented Oct 13, 2015

It won't, but maybe I could make an option to list them more succinctly? The reason I say that is because the default sample config is getting pretty huge, and is only going to get bigger

@pauldix
Copy link
Member Author

pauldix commented Oct 13, 2015

That's fine if it's huge, it's just a text file.

Check the config for Redis: http://download.redis.io/redis-stable/redis.conf

That one is big too, but I think it's the gold standard for example config files. Tons of comments so that the user can just look at the config file without having to jump to documentation to figure out what to do.

Better to have everything there, rather than forcing the user to go to the documentation or generate another temp config to see how things are supposed to work.

@sparrc
Copy link
Contributor

sparrc commented Oct 13, 2015

okay, re-opening

@sparrc sparrc reopened this Oct 13, 2015
sparrc added a commit that referenced this issue Apr 1, 2016
sparrc added a commit that referenced this issue Apr 1, 2016
sparrc added a commit that referenced this issue Apr 1, 2016
sparrc added a commit that referenced this issue Apr 1, 2016
changes:

- -sample-config will now comment out all but a few default plugins.
- config file parse errors will output path to bad conf file.
- cleanup 80-char line-length and some other style issues.
- default package conf file will now have all plugins, but commented
  out.

closes #199
closes #944
sparrc added a commit that referenced this issue Apr 1, 2016
changes:

- -sample-config will now comment out all but a few default plugins.
- config file parse errors will output path to bad conf file.
- cleanup 80-char line-length and some other style issues.
- default package conf file will now have all plugins, but commented
  out.

closes #199
closes #944
sparrc added a commit that referenced this issue Apr 1, 2016
changes:

- -sample-config will now comment out all but a few default plugins.
- config file parse errors will output path to bad conf file.
- cleanup 80-char line-length and some other style issues.
- default package conf file will now have all plugins, but commented
  out.

closes #199
closes #944
sparrc added a commit that referenced this issue Apr 1, 2016
changes:

- -sample-config will now comment out all but a few default plugins.
- config file parse errors will output path to bad conf file.
- cleanup 80-char line-length and some other style issues.
- default package conf file will now have all plugins, but commented
  out.

closes #199
closes #944
@sparrc sparrc closed this as completed in e436b2d Apr 1, 2016
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