logstash-filter-jdbc_streaming 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e521e88f5357fd42a948cfb29dbef356734cbdaf4717e122013f0761e4d9fa
-  data.tar.gz: 75781493683b74fac322f010a2036a73b19a2e81e4611cb12959d73402a8d98e
+  metadata.gz: 6236e1d0673dff75c590651c8ff5814ecb9a76e4982869e1a331a17101f3a2a5
+  data.tar.gz: 942058abe67d1a453ad35b787e3767d72913664a8501fa104a38ab3bec1ca8fb
 SHA512:
-  metadata.gz: 33781dc46d6235fa820a799f082abb7d8cd2063284a6dea5d2aa7b83d99e3689442a1b394945107b676b3c1a49891936175bcb24757ea3a92548d3f0c8711aa8
-  data.tar.gz: 35a03bb6e34966d0e09ef5b8fe906327dac55f83f9352bf301655a6e194d3ac4b1cb43501bfc2b278e768869480d5196986ee9a4ed54a7f0ab76c786faf621fd
+  metadata.gz: dd503c13039572e885d9d8116e4ca64eaa68c3de5a548870228b4179ec4d6708ac1bf4f8e366fc4bbc03e1910f700392eb8ea21ab40ca5a52eda5e71f7aad559
+  data.tar.gz: c2a6829fb50246a6c67a22b0eedcc67e71e7ba5b290d12bf3880c9c89a67ec5e909734766e6c5337d8772ba26eda33c2e8d80b7c2b13a39f44d0fe03bfa41821

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.0.7
+  - Fixed formatting in documentation [#17](https://github.com/logstash-plugins/logstash-filter-jdbc_streaming/pull/17) and [#28](https://github.com/logstash-plugins/logstash-filter-jdbc_streaming/pull/28) 
+
 ## 1.0.6
   - Fixes connection leak in pipeline reloads by properly disconnecting on plugin close
 

data/docs/index.asciidoc

@@ -22,11 +22,12 @@ include::{include_path}/plugin_header.asciidoc[]
 
 This filter executes a SQL query and store the result set in the field
 specified as `target`.
-It will cache the results locally in an LRU cache with expiry
+It will cache the results locally in an LRU cache with expiry.
 
-For example you can load a row based on an id from in the event
+For example, you can load a row based on an id in the event.
 
 [source,ruby]
+-----
 filter {
   jdbc_streaming {
     jdbc_driver_library => "/path/to/mysql-connector-java-5.1.34-bin.jar"
@@ -39,7 +40,7 @@ filter {
     target => "country_details"
   }
 }
-
+-----
 
 [id="plugins-{type}s-{plugin}-options"]
 ==== Jdbc_streaming Filter Configuration Options
@@ -78,13 +79,15 @@ filter plugins.
   * Value type is <<number,number>>
   * Default value is `5.0`
 
-The minimum number of seconds any entry should remain in the cache, defaults to 5 seconds
-A numeric value, you can use decimals for example `{ "cache_expiration" => 0.25 }`
-If there are transient jdbc errors the cache will store empty results for a given
-parameter set and bypass the jbdc lookup, this merges the default_hash into the event, until
-the cache entry expires, then the jdbc lookup will be tried again for the same parameters
-Conversely, while the cache contains valid results any external problem that would cause
-jdbc errors, will not be noticed for the cache_expiration period.
+The minimum number of seconds any entry should remain in the cache. Defaults to 5 seconds.
+
+A numeric value. You can use decimals for example: `cache_expiration => 0.25`.
+If there are transient jdbc errors, the cache will store empty results for a
+given parameter set and bypass the jbdc lookup. This will merge the default_hash
+into the event until the cache entry expires. Then the jdbc lookup will be tried
+again for the same parameters. Conversely, while the cache contains valid results,
+any external problem that would cause jdbc errors will not be noticed for the
+cache_expiration period.
 
 [id="plugins-{type}s-{plugin}-cache_size"]
 ===== `cache_size` 
@@ -92,8 +95,8 @@ jdbc errors, will not be noticed for the cache_expiration period.
   * Value type is <<number,number>>
   * Default value is `500`
 
-The maximum number of cache entries are stored, defaults to 500 entries
-The least recently used entry will be evicted
+The maximum number of cache entries that will be stored. Defaults to 500 entries.
+The least recently used entry will be evicted.
 
 [id="plugins-{type}s-{plugin}-default_hash"]
 ===== `default_hash` 
@@ -102,7 +105,7 @@ The least recently used entry will be evicted
   * Default value is `{}`
 
 Define a default object to use when lookup fails to return a matching row.
-ensure that the key names of this object match the columns from the statement
+Ensure that the key names of this object match the columns from the statement.
 
 [id="plugins-{type}s-{plugin}-jdbc_connection_string"]
 ===== `jdbc_connection_string` 
@@ -129,8 +132,8 @@ JDBC driver class to load, for example "oracle.jdbc.OracleDriver" or "org.apache
   * There is no default value for this setting.
 
 Tentative of abstracting JDBC logic to a mixin
-for potential reuse in other plugins (input/output)
-This method is called when someone includes this module
+for potential reuse in other plugins (input/output).
+This method is called when someone includes this module.
 Add these methods to the 'base' given.
 JDBC driver library path to third party driver library.
 
@@ -166,7 +169,7 @@ Validate connection before use.
   * Default value is `3600`
 
 Connection pool configuration.
-How often to validate a connection (in seconds)
+How often to validate a connection (in seconds).
 
 [id="plugins-{type}s-{plugin}-parameters"]
 ===== `parameters` 
@@ -174,7 +177,7 @@ How often to validate a connection (in seconds)
   * Value type is <<hash,hash>>
   * Default value is `{}`
 
-Hash of query parameter, for example `{ "id" => "id_field" }`
+Hash of query parameter, for example `{ "id" => "id_field" }`.
 
 [id="plugins-{type}s-{plugin}-statement"]
 ===== `statement` 
@@ -184,7 +187,7 @@ Hash of query parameter, for example `{ "id" => "id_field" }`
   * There is no default value for this setting.
 
 Statement to execute.
-To use parameters, use named parameter syntax, for example "SELECT * FROM MYTABLE WHERE ID = :id"
+To use parameters, use named parameter syntax, for example "SELECT * FROM MYTABLE WHERE ID = :id".
 
 [id="plugins-{type}s-{plugin}-tag_on_default_use"]
 ===== `tag_on_default_use` 
@@ -192,7 +195,7 @@ To use parameters, use named parameter syntax, for example "SELECT * FROM MYTABL
   * Value type is <<array,array>>
   * Default value is `["_jdbcstreamingdefaultsused"]`
 
-Append values to the `tags` field if no record was found and default values were used
+Append values to the `tags` field if no record was found and default values were used.
 
 [id="plugins-{type}s-{plugin}-tag_on_failure"]
 ===== `tag_on_failure` 
@@ -200,7 +203,7 @@ Append values to the `tags` field if no record was found and default values were
   * Value type is <<array,array>>
   * Default value is `["_jdbcstreamingfailure"]`
 
-Append values to the `tags` field if sql error occured
+Append values to the `tags` field if sql error occurred.
 
 [id="plugins-{type}s-{plugin}-target"]
 ===== `target` 
@@ -209,8 +212,8 @@ Append values to the `tags` field if sql error occured
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-Define the target field to store the extracted result(s)
-Field is overwritten if exists
+Define the target field to store the extracted result(s).
+Field is overwritten if exists.
 
 [id="plugins-{type}s-{plugin}-use_cache"]
 ===== `use_cache` 
@@ -218,7 +221,7 @@ Field is overwritten if exists
   * Value type is <<boolean,boolean>>
   * Default value is `true`
 
-Enable or disable caching, boolean true or false, defaults to true
+Enable or disable caching, boolean true or false. Defaults to true.
 
 
 

data/logstash-filter-jdbc_streaming.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-filter-jdbc_streaming'
-  s.version         = '1.0.6'
+  s.version         = '1.0.7'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Enrich events with your database data"
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-jdbc_streaming
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement