Skip to content

docs: update how to generate sample config#10831

Closed
sspaink wants to merge 2 commits intomasterfrom
configurationupdate
Closed

docs: update how to generate sample config#10831
sspaink wants to merge 2 commits intomasterfrom
configurationupdate

Conversation

@sspaink
Copy link
Copy Markdown
Contributor

@sspaink sspaink commented Mar 16, 2022 •
edited
Loading

Match what we have on the docs side: https://docs.influxdata.com/telegraf/v1.21/introduction/getting-started/#create-and-edit-the-configuration-file

Not exactly the same, I made this doc less wordy because it is just configuration and not a "getting started" like the website. I have no issue having them match exactly either though.

@telegraf-tiger telegraf-tiger bot added the docs Issues related to Telegraf documentation and configuration descriptions label Mar 16, 2022
@sspaink sspaink marked this pull request as ready for review March 21, 2022 15:24
@sspaink sspaink added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Mar 22, 2022
Hipska
Hipska suggested changes Mar 23, 2022
View reviewed changes
Hipska
Hipska approved these changes Mar 24, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@Hipska Hipska left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the commands are also explained in other places:

telegraf/docs/COMMANDS_AND_FLAGS.md

Lines 46 to 53 in 828b040

**Generate a telegraf config file:**
`telegraf config > telegraf.conf`
**Generate config with only cpu input & influxdb output plugins defined:**
`telegraf --input-filter cpu --output-filter influxdb config`

These need to be updated as well..

@sspaink sspaink force-pushed the configurationupdate branch from 7678a7d to ec16b50 Compare March 24, 2022 20:43
@telegraf-tiger
Copy link
Copy Markdown
Contributor

telegraf-tiger bot commented Mar 24, 2022

Download PR build artifacts for linux_amd64.tar.gz, darwin_amd64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

☺️ This pull request doesn't significantly change the Telegraf binary size (less than 1%)

📦 Click here to get additional PR build artifacts

Artifact URLs

DEB RPM TAR GZ ZIP
amd64.deb aarch64.rpm darwin_amd64.tar.gz windows_amd64.zip
arm64.deb armel.rpm darwin_arm64.tar.gz windows_i386.zip
armel.deb armv6hl.rpm freebsd_amd64.tar.gz
armhf.deb i386.rpm freebsd_armv7.tar.gz
i386.deb ppc64le.rpm freebsd_i386.tar.gz
mips.deb riscv64.rpm linux_amd64.tar.gz
mipsel.deb s390x.rpm linux_arm64.tar.gz
ppc64el.deb x86_64.rpm linux_armel.tar.gz
riscv64.deb linux_armhf.tar.gz
s390x.deb linux_i386.tar.gz
linux_mips.tar.gz
linux_mipsel.tar.gz
linux_ppc64le.tar.gz
linux_riscv64.tar.gz
linux_s390x.tar.gz
static_linux_amd64.tar.gz

@sspaink
Copy link
Copy Markdown
Contributor Author

sspaink commented Mar 24, 2022

After some discussion closing this because this should be an issue so that the following works:
telegraf config --input-filter cpu --output-filter influxdb

instead of telegraf --input-filter cpu --output-filter influxdb config

--sample-config should probably be deprecated as well in favor of config

@sspaink sspaink closed this Mar 24, 2022
@sspaink sspaink mentioned this pull request Mar 24, 2022
Closed
@Hipska
Copy link
Copy Markdown
Contributor

Hipska commented Mar 24, 2022

According to the changes you made here, I assumed the config command would become deprecated.

@sspaink
Copy link
Copy Markdown
Contributor Author

sspaink commented Mar 24, 2022

I originally was in favor of doing it that way so sorry for the confusion, but looking at it again using config does seem like a more standard CLI way of doing things using a command followed by flags instead of a flag followed by more flags.

@Hipska
Copy link
Copy Markdown
Contributor

Hipska commented Mar 25, 2022

That makes more sense indeed!

@sspaink sspaink deleted the configurationupdate branch June 30, 2022 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@Hipska Hipska Hipska approved these changes

@MyaLongmire MyaLongmire MyaLongmire approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Issues related to Telegraf documentation and configuration descriptions ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sspaink @Hipska @MyaLongmire