logstash-filter-environment 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fb95a543d05d09be531ed514dc660132ec645dd
-  data.tar.gz: a13bef8b92f06451003a72bd50403bc0cf5c3e6d
+  metadata.gz: bd5b350100ea0ef093319daf3e7106b5a36eda13
+  data.tar.gz: 1c057a2e6b9f1886befa9370340c7b42fe4a7381
 SHA512:
-  metadata.gz: aa18f8655cced361fc3a969a0729770e61035b198c871cf4c1b48e08318c031e84e2214e476989687e2eef02b0a80a346d5eac800a68fd58eea9adb487cc0037
-  data.tar.gz: 2bbcc8826fe2326a381f4ca015086b87a293aad1816530ee066a387d63614558edc7405d0938f1f9cf54d07cb5707017b19713c31b759ce16c4863dbed83a214
+  metadata.gz: 4c5ce86876ef75c7225086ce07a30d0153b9eb29b2abdebf9143555451bafcaa033df8b7f72a4ca1a1e4a990ed01bd5f94099c957b2546c5946e9e66b9b0ba59
+  data.tar.gz: d68dbadc27bba72d745fb0dab167805d5f2fbcd3e858809967c022c04adaab5cf93c812c0d140bb91113e49d0576483569c496a5f2b86d1b433bfbc62bf2c554

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-gemspec
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,83 @@
+:plugin: environment
+:type: filter
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Environment filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This filter stores environment variables as subfields in the `@metadata` field.
+You can then use these values in other parts of the pipeline.
+
+Adding environment variables is as easy as:
+   filter {
+     environment {
+       add_metadata_from_env => { "field_name" => "ENV_VAR_NAME" }
+     }
+   }
+
+Accessing stored environment variables is now done through the `@metadata` field:
+
+   ["@metadata"]["field_name"]
+
+This would reference field `field_name`, which in the above example references
+the `ENV_VAR_NAME` environment variable.
+
+IMPORTANT: Previous versions of this plugin put the environment variables as
+fields at the root level of the event.  Current versions make use of the
+`@metadata` field, as outlined.  You have to change `add_field_from_env` in
+the older versions to `add_metadata_from_env` in the newer version.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Environment Filter Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-add_metadata_from_env>> |<<hash,hash>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-add_metadata_from_env"]
+===== `add_metadata_from_env` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+Specify a hash of field names and the environment variable name with the
+value you want imported into Logstash. For example:
+
+   add_metadata_from_env => { "field_name" => "ENV_VAR_NAME" }
+
+or
+
+   add_metadata_from_env => {
+     "field1" => "ENV1"
+     "field2" => "ENV2"
+     # "field_n" => "ENV_n"
+   }
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-environment.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-environment'
-  s.version         = '3.0.0'
+  s.version         = '3.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Set fields from environment variables"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-environment
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/environment.rb
 - logstash-filter-environment.gemspec
 - spec/filters/environment_spec.rb