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

Rewrite documentation for snmp input #6802

Merged
merged 2 commits into from
Dec 30, 2019
Merged

Rewrite documentation for snmp input #6802

merged 2 commits into from
Dec 30, 2019

Conversation

danielnelson
Copy link
Contributor

closes #6736

Required for all PRs:

  • Signed CLA.
  • Associated README.md updated.
  • Has appropriate unit tests.

@danielnelson danielnelson added docs Issues related to Telegraf documentation and configuration descriptions area/snmp labels Dec 13, 2019
@danielnelson danielnelson added this to the 1.13.1 milestone Dec 13, 2019
@danielnelson danielnelson requested a review from reimda December 13, 2019 22:58

### Example:
These programs will load available MIBs on the system. Typically the default
directory for MIBs is `/usr/share/snmp/mibs`, but if you MIBs are in a
Copy link
Contributor

Choose a reason for hiding this comment

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

you should be your


### MIB lookups
Copy link
Contributor

Choose a reason for hiding this comment

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

The snmp trap input's readme refers to this section by name. Since the section is removed in this change we'll need to update snmp_trap/README.md. It looks like the content is moved to the prerequisites section.

Copy link
Contributor

@reimda reimda left a comment

Choose a reason for hiding this comment

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

Looks good. Could you update the snmp trap readme to match before merging?

@danielnelson
Copy link
Contributor Author

I decided to copy/paste the prerequisites section over the snmp_trap docs, if you feel strongly against this duplication I'll undo. In the snmp_trap version I only mention needing snmptranslate.

I made some minor changes in snmp_trap docs, moving the port into a sub section under the Configuration section and removed the description from the sample configuration.

One thing I was wondering is if we need to remove the mention of INFORM from the snmp_trap docs, these won't work yet will they?

@danielnelson danielnelson requested a review from reimda December 17, 2019 01:39
@danielnelson danielnelson merged commit c325c94 into master Dec 30, 2019
@danielnelson danielnelson deleted the snmp-docs branch December 30, 2019 19:33
danielnelson added a commit that referenced this pull request Dec 30, 2019
athoune pushed a commit to bearstech/telegraf that referenced this pull request Apr 17, 2020
idohalevi pushed a commit to idohalevi/telegraf that referenced this pull request Sep 29, 2020
arstercz pushed a commit to arstercz/telegraf that referenced this pull request Mar 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/snmp docs Issues related to Telegraf documentation and configuration descriptions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update snmp input documentation with net-snmp requirements
2 participants