logstash-integration-snmp 4.0.0-java → 4.0.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a169c08af78713fd509798ce2c094cabb6008b9bd68c674621a62e9e99909968
-  data.tar.gz: 18f98d64c37266859d3a67699f2cfe196eb8f0690b70382fb66f6ecefc9fe9b0
+  metadata.gz: 2a2a3c314a8797b49f4f35a7a79779baa76ffc94b1d44bac47459d87c735ffe2
+  data.tar.gz: eacee8e01c540e097243465583a2701e242b4fb6c246ed5c79905b37e5037d33
 SHA512:
-  metadata.gz: fc759f4705e32ffa83654880389f39e5a096a87d0ea62d636fb2499831644b1d249ee4c6e17ea82f0b2e949b3ceb8d268dc95b961d029df93cb51296edea5c2f
-  data.tar.gz: '06866a07ecc529a9ce5d2b163694e9579d2b90bec623a2bb1bcbf9ff8c3e31303fb20362477b9d40f88480ffc4687b07fa05da0d0174093cefb416f2223b8172'
+  metadata.gz: 1712b4df3084f8869ce0cbb5f4225551cf9a515f74dd1c9eaffad9ec4f05cff962e3fd79e55699f49f629a7c4db6a1685725940a81789085c2a4645d62e9ed65
+  data.tar.gz: 23ead4fe9535c6395ab3f416a75e140453912f5964588837fd8a122a7d18122f6413b04ecd19f272355defcba24ad5181a4242ff60bf4e330f3f06a433077e8a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.0.1
+  - [DOC] Add technical preview banner and reimplement cross-doc links [#57](https://github.com/logstash-plugins/logstash-integration-snmp/pull/57)
+
 ## 4.0.0
   - Initial Release of SNMP Integration Plugin, incorporating [logstash-input-snmp](https://github.com/logstash-plugins/logstash-input-snmp) and [logstash-input-snmptrap](https://github.com/logstash-plugins/logstash-input-snmptrap).
     Independent changelogs for previous versions can be found:

data/VERSION

@@ -1 +1 @@
-4.0.0
+4.0.1

data/docs/index.asciidoc

@@ -17,18 +17,27 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === SNMP Integration Plugin
 
-// include::{include_path}/plugin_header.asciidoc[]
+include::{include_path}/plugin_header.asciidoc[]
+
+experimental[]
+
+.Technical Preview
+****
+The new `integration-snmp` plugin, and its component plugins--`input-snmp` and `input-snmptrap`--are available in _Technical Preview_ and can be installed on the latest Logstash 7.x and 8.x versions.
+
+Current 1.x versions of the `input-snmp` plugin are bundled with {ls} by default, and will soon be replaced by the snmp input plugin contained in this integration.
+(If you want to opt into the Technical Preview for the `integration-snmp` plugin, run `bin/logstash-plugin install logstash-integration-snmp`.)
+
+Be aware of <<plugins-{type}s-{plugin}-migration,behavioral and mapping differences>> between current stand-alone plugins and the new versions included in the `integration-snmp`. 
+The information in this topic can help. 
+****
 
 ==== Description
 
 The SNMP integration plugin includes:
 
-* SNMP input plugin
-* SNMPtrap input plugin
-
-// Uncomment and replace with above bullets after generated the initial versions of the target files
-// - {logstash-ref}/plugins-input-snmp.html[SNMP input plugin]
-// - {logstash-ref}/plugins-input-snmptrap.html[Snmptrap input plugin]
+* link:{logstash-ref}/plugins-inputs-snmp.html[SNMP input plugin]
+* link:{logstash-ref}/plugins-inputs-snmptrap.html[Snmptrap input plugin]
 
 The new the `logstash-integration-snmp` plugin combines the 
 `logstash-input-snmp` and `logstash-input-snmptrap` plugins into one integrated plugin that encompasses
@@ -47,16 +56,6 @@ In this section, we'll cover:
 You'll retain and expand the functionality of existing stand-alone plugins, but in a more compact, integrated package. 
 In this section, we'll note mapping and behavioral changes, and explain how to preserve current behavior if needed.
 
-[IMPORTANT] 
---
-Uninstall the `logstash-input-snmp` and `logstash-input-snmptrap` plugins _before_ you install the `logstash-integration-snmp` plugin. 
-
-* `bin/logstash-plugin remove logstash-input-snmp` +
-* `bin/logstash-plugin remove logstash-input-snmptrap`
---
-
-// ToDo: Add guidance and set expectations for when snmp integration is installed by default
-
 [id="plugins-{type}s-{plugin}-migration-input-snmp"]
 ===== Migration notes: `logstash-input-snmp` 
 
@@ -130,9 +129,6 @@ input {
 
 // ToDo: Any considerations that we should point out? 
 
-:no_codec!:
-
-
 [id="plugins-{type}s-{plugin}-import-mibs"]
 ==== Importing MIBs
 
@@ -198,5 +194,3 @@ $ smidump -c smi.conf -k -f python CISCO-PROCESS-MIB.mib > CISCO-PROCESS-MIB_my.
 -----
 
 :no_codec!:
-
-

data/docs/input-snmp.asciidoc

@@ -18,8 +18,21 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === SNMP input plugin
 
-// Uncomment after generated the initial versions of the target file
-// include::{include_path}/plugin_header-integration.asciidoc[]
+include::{include_path}/plugin_header-integration.asciidoc[]
+
+experimental[]
+
+.Technical Preview
+****
+The new `integration-snmp` plugin, and its component plugins--`input-snmp` and `input-snmptrap`--are available in _Technical Preview_ and can be installed on the latest Logstash 7.x and 8.x versions.
+
+Current 1.x versions of the `input-snmp` plugin are bundled with {ls} by default, and will soon be replaced by the snmp input plugin contained in this integration.
+(If you want to opt into the Technical Preview for the `integration-snmp` plugin, run `bin/logstash-plugin install logstash-integration-snmp`.)
+
+Be aware of behavioral and mapping differences between current stand-alone plugins and the new versions included in the `integration-snmp`. 
+
+Before you install the new integration, be aware of link:{logstash-ref}/plugins-integrations-snmp.html#plugins-integrations-snmp-migration[behavioral and mapping differences] between current stand-alone plugins and the new versions included in `integration-snmp`. 
+****
 
 ==== Description
 
@@ -34,10 +47,11 @@ The `logstash-input-snmp` plugin is now a component of the `logstash-integration
 This integrated plugin package provides better alignment in snmp processing, better resource management, 
 easier package maintenance, and a smaller installation footprint. 
 
-For migration information and guidelines, check out the migration guide.
+Before you install the new integration, be aware of link:{logstash-ref}/plugins-integrations-snmp.html#plugins-integrations-snmp-migration[behavioral and mapping differences] between current stand-alone plugins and the new versions included in `integration-snmp`. 
 **** 
 
-// TODO: Add link to migration topic in the integration index. 
+// ToDo: link:{logstash-ref}/plugins-input-snmp.html[Importing MIBs]
+
 
 [id="plugins-{type}s-{plugin}-ecs"]
 ==== Compatibility with the Elastic Common Schema (ECS)
@@ -59,9 +73,10 @@ Metadata fields follow a specific naming convention when <<plugins-{type}s-{plug
 ==== Importing MIBs 
 
 This plugin already includes the IETF MIBs (management information bases), and you do not need to import them.
-If you need additional MIBs, you need to important them.  
+If you need additional MIBs, you need to import them.  
 Check out "Importing MIBs" for instructions.
 
+// link:{logstash-ref}/plugins-input-snmp.html[Importing MIBs]
 // ToDo: Add link to MIBs content after generated file exists.
 
 [id="plugins-{type}s-{plugin}-options"]
@@ -375,7 +390,7 @@ The number of threads to use for executing the hosts SNMP requests.
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
-This plugin provides all IETF MIBs (management information bases), publicly available in the https://www.ibr.cs.tu-bs.de/projects/libsmi[libsmi] version `0.5.0`.
+This plugin provides all IETF MIBs (management information bases), publicly available in the link:https://www.ibr.cs.tu-bs.de/projects/libsmi[libsmi] version `0.5.0`.
 When enabled, it automatically loads the bundled MIBs and provides mapping of the numeric OIDs to MIB field names in the resulting event.
 
 ==== SNMPv3 Authentication Options

data/docs/input-snmptrap.asciidoc

@@ -18,8 +18,21 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === SNMP trap input plugin
 
-//Uncomment after generated the initial versions of the target file
-//include::{include_path}/plugin_header-integration.asciidoc[]
+include::{include_path}/plugin_header-integration.asciidoc[]
+
+experimental[]
+
+.Technical Preview
+****
+The new `integration-snmp` plugin, and its component plugins--`input-snmp` and `input-snmptrap`--are available in _Technical Preview_ and can be installed on the latest Logstash 7.x and 8.x versions.
+
+Current 1.x versions of the `input-snmp` plugin are bundled with {ls} by default, and will soon be replaced by the snmp input plugin contained in this integration.
+(If you want to opt into the Technical Preview for the `integration-snmp` plugin, run `bin/logstash-plugin install logstash-integration-snmp`.)
+
+Be aware of behavioral and mapping differences between current stand-alone plugins and the new versions included in the `integration-snmp`. 
+
+Before you install the new integration, be aware of link:{logstash-ref}/plugins-integrations-snmp.html#plugins-integrations-snmp-migration[behavioral and mapping differences] between current stand-alone plugins and the new versions included in `integration-snmp`. 
+****
 
 ==== Description
 
@@ -35,11 +48,9 @@ The `logstash-input-snmptrap` plugin is now a component of the `logstash-integra
 This integrated plugin package provides better alignment in snmp processing, better resource management, 
 easier package maintenance, and a smaller installation footprint. 
 
-For migration information and guidelines, check out the migration guide.
+Before you install the new integration, be aware of link:{logstash-ref}/plugins-integrations-snmp.html#plugins-integrations-snmp-migration[behavioral and mapping differences] between current stand-alone plugins and the new versions included in `integration-snmp`. 
 **** 
 
-// TODO: Add link to migration topic in the integration index. 
-
 [id="plugins-{type}s-{plugin}-ecs"]
 ==== Event Metadata and the Elastic Common Schema (ECS)
 
@@ -78,12 +89,12 @@ which variable binding in the list caused the error
 ==== Importing MIBs
 
 This plugin already includes the IETF MIBs (management information bases), and you do not need to import them.
-If you need additional MIBs, you need to important them.  
+If you need additional MIBs, you need to import them.  
 Check out "Importing MIBs" for instructions.
 
+// link:{logstash-ref}/plugins-input-snmp.html[Importing MIBs]
 // ToDo: Add link to MIBs content after generated file exists.
 
-
 [id="plugins-{type}s-{plugin}-options"]
 ==== SNMP Trap Input Configuration Options
 
@@ -263,7 +274,7 @@ The supported transport protocols to listen on.
 
 SNMP was originally designed for use with UDP as transport protocol and is the official recommendation.
 TCP is an optional transport mapping and can be enabled if needed. For more details
-on SNMP over TCP, please refer to the https://datatracker.ietf.org/doc/html/rfc3430[RFC-3430].
+on SNMP over TCP, please refer to the link:https://datatracker.ietf.org/doc/html/rfc3430[RFC-3430].
 
 [id="plugins-{type}s-{plugin}-supported_versions"]
 ===== `supported_versions`
@@ -299,7 +310,7 @@ The number of threads to use for processing the received SNMP trap messages.
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
-This plugin provides all IETF MIBs (management information bases), publicly available in the https://www.ibr.cs.tu-bs.de/projects/libsmi[libsmi] version `0.5.0`.
+This plugin provides all IETF MIBs (management information bases), publicly available in the link:https://www.ibr.cs.tu-bs.de/projects/libsmi[libsmi] version `0.5.0`.
 When enabled, it automatically loads the bundled MIBs and provides mapping of the numeric OIDs to MIB field names in the resulting event.
 
 [id="plugins-{type}s-{plugin}-yamlmibdir"]

data/lib/logstash-integration-snmp_jars.rb

@@ -3,4 +3,4 @@
 require 'jar_dependencies'
 require_jar('org.snmp4j', 'snmp4j', '3.8.0')
 require_jar('org.snakeyaml', 'snakeyaml-engine', '2.7')
-require_jar('org.logstash.integrations', 'plugin', '4.0.0')
+require_jar('org.logstash.integrations', 'plugin', '4.0.1')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-snmp
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -483,7 +483,7 @@ files:
 - spec/unit/inputs/common_spec.rb
 - spec/unit/inputs/snmp_spec.rb
 - spec/unit/inputs/snmptrap_spec.rb
-- vendor/jar-dependencies/org/logstash/integrations/plugin/4.0.0/plugin-4.0.0.jar
+- vendor/jar-dependencies/org/logstash/integrations/plugin/4.0.1/plugin-4.0.1.jar
 - vendor/jar-dependencies/org/snakeyaml/snakeyaml-engine/2.7/snakeyaml-engine-2.7.jar
 - vendor/jar-dependencies/org/snmp4j/snmp4j/3.8.0/snmp4j-3.8.0.jar
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html