-
Notifications
You must be signed in to change notification settings - Fork 3
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
Initial version of the SNMP integration plugin, incorporating snmp and snmptrap inputs #1
Conversation
… and logstash-input-snmptrap (2824bb8a5d3389996be4694f7f87d8319af9914c) plugins
…ntegration-snmp into initial-version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've gone through all of the plugin, given that the code is the same, and it's only organizational, I haven't gone through a thorough review. But LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@edmocosta, thank you for the opportunity to try to get these new integration docs working from the beginning. I've commented on some lines that I know will cause problems if unresolved, and added explanations. Please let me know if you'd like to discuss.
Let's check in again before you merge and publish.
docs/index.asciidoc
Outdated
- {logstash-ref}/plugins-input-snmp.html[SNMP Input Plugin] | ||
- {logstash-ref}/plugins-input-snmptrap.html[SNMP Trap Input Plugin] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- {logstash-ref}/plugins-input-snmp.html[SNMP Input Plugin] | |
- {logstash-ref}/plugins-input-snmptrap.html[SNMP Trap Input Plugin] | |
/ * {logstash-ref}/plugins-input-snmp.html[SNMP input plugin] | |
/ * {logstash-ref}/plugins-input-snmptrap.html[Snmptrap input plugin] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These links should be removed for the initial commit. Why?
The generated files were targeting don't exist yet. (We're merging the original source files as part of this PR.) We can't link to those generated files until they've been created, merged, published, and generated. Linking to non-existent files will break docs-ci, and if merged, the entire docs build.
docs/input-snmp.asciidoc
Outdated
|
||
=== SNMP input plugin | ||
|
||
include::{include_path}/plugin_header-integration.asciidoc[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
include::{include_path}/plugin_header-integration.asciidoc[] | |
/ include::{include_path}/plugin_header-integration.asciidoc[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This include statement pulls in this header file: https://github.com/elastic/logstash/blame/main/docs/include/plugin_header-integration.asciidoc.
The header file includes a reference to a file that does not exist yet: <<plugins-integrations-{integration},{integration} integration plugin>>
.
We're merging the original source files as part of this PR. We can't link to those generated files until they've been created, merged, published, and generated. Linking to non-existent files will break docs-ci, and if merged, the entire docs build.
We need to comment out (or delete) this include statement until we have generated initial versions of the target files.
docs/input-snmptrap.asciidoc
Outdated
|
||
=== SNMP trap input plugin | ||
|
||
include::{include_path}/plugin_header-integration.asciidoc[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
include::{include_path}/plugin_header-integration.asciidoc[] | |
/ include::{include_path}/plugin_header-integration.asciidoc[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This include statement pulls in this header file: https://github.com/elastic/logstash/blame/main/docs/include/plugin_header-integration.asciidoc.
The header file includes a reference to a file that does not exist yet: <<plugins-integrations-{integration},{integration} integration plugin>>.
We're merging the original source files as part of this PR. We can't link to those generated files until they've been created, merged, published, and generated. Linking to non-existent files will break docs-ci, and if merged, the entire docs build.
We need to comment out (or delete) this include statement until we have generated initial versions of the target files.
|
||
=== SNMP Integration Plugin | ||
|
||
include::{include_path}/plugin_header.asciidoc[] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The plugin_header.asciidoc
file include can stay. Technically, the integration plugin itself (but not its component plugins) behaves like a traditional (input, output, codec, filter) plugin. Only the plugin_header-integration.asciidoc
header file causes problems.
@edmocosta Thank you for the opportunity to work through adding an integration iteratively. We might still hit some bumps, but we'll learn the best practices and then I'll document them for next time. |
What does this PR do?
Created the SNMP Integration Plugin, incorporating the logstash-input-snmp and logstash-input-snmptrap plugins.
.ci
adjusted to work with both plugins. It was mainly adapted from the original CI configurations.spec/integration
andspec/unit
. The specs were not modified.:type: integration
markups:type: integration
markupsChecklist
Related issues