logstash-filter-environment 0.1.5 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a53e0f386b66828be7c72efffdbfc533ad52cdf3
-  data.tar.gz: c68c657c37c5e79d83f90d95efe5fc9ab2a9cc5d
+  metadata.gz: e18db4701bc094d9aebd4fd92dbf1cac0ddbfde6
+  data.tar.gz: 36fd9fd8b5b6250fc19de93b4a15524362b2fdb9
 SHA512:
-  metadata.gz: 23face99e4f55994db8da845bf42faa55cf3ed08acf688db294cf704db46ffe9bbb9cc677db86d7c15ebcb805e419844fc4b37dcca3fc8b67e00772ad26aa0bd
-  data.tar.gz: 8dc9b27ea55b0e4eb91443f1b22778deec2fecf1825650579c210ea8c8290972ba5812ed447e907e2f13bb2cc3c32342bebd888db059135780301381584957c8
+  metadata.gz: da82518c7b001758e8651eec04434eb4a8bc0f61f396239a96cd8bb8dba2b12675296e2cf5d5b9d29b121c801058828f87f5c4dea8b5cf1fb6425bd348463137
+  data.tar.gz: e48ffc5db95774c7d8852865e19e62c509b4ac2534f9345e2fdef46539629ea7a574f4713c4fe7bcc9faf05defc20bf582034c942c92e9d5e528d05afce9c53c

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+
+1.0.0
+  - Use @metadata instead of root-level fields
+  - This is a breaking change.  Users will need to switch to use @metadata subfields in their configurations.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -1,19 +1,19 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
-Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
 ## Developing
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/environment.rb

@@ -3,13 +3,43 @@ require "logstash/filters/base"
 require "logstash/namespace"
 
 
-# Set fields from environment variables
+# 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.
 class LogStash::Filters::Environment < LogStash::Filters::Base
   config_name "environment"
 
-  # Specify a hash of fields to the environment variable
-  # A hash of matches of `field => environment` variable
-  config :add_field_from_env, :validate => :hash, :default => {}
+  # 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"
+  #    }
+  config :add_metadata_from_env, :validate => :hash, :default => {}
 
   public
   def register
@@ -18,9 +48,9 @@ class LogStash::Filters::Environment < LogStash::Filters::Base
 
   public
   def filter(event)
-    return unless filter?(event)
-    @add_field_from_env.each do |field, env|
-      event[field] = ENV[env]
+    
+    @add_metadata_from_env.each do |field, env|
+      event["@metadata"][field] = ENV[env]
     end
     filter_matched(event)
   end # def filter

data/logstash-filter-environment.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-environment'
-  s.version         = '0.1.5'
+  s.version         = '2.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/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 = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,8 +20,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.snapshot", "< 3.0.0"
 
   s.add_development_dependency 'logstash-devutils'
 end
-

data/spec/filters/environment_spec.rb

@@ -2,7 +2,7 @@ require "logstash/devutils/rspec/spec_helper"
 require "logstash/filters/environment"
 
 describe LogStash::Filters::Environment do
-  
+
 
   describe "add a field from the environment" do
     # The logstash config goes here.
@@ -10,7 +10,7 @@ describe LogStash::Filters::Environment do
     config <<-CONFIG
       filter {
         environment {
-          add_field_from_env => [ "newfield", "MY_ENV_VAR" ]
+          add_metadata_from_env => [ "newfield", "MY_ENV_VAR" ]
         }
       }
     CONFIG
@@ -18,7 +18,7 @@ describe LogStash::Filters::Environment do
     ENV["MY_ENV_VAR"] = "hello world"
 
     sample "example" do
-      insist { subject["newfield"] } == "hello world"
+      insist { subject["@metadata"]["newfield"] } == "hello world"
     end
   end
 
@@ -29,7 +29,7 @@ describe LogStash::Filters::Environment do
       filter {
         environment {
           type => "foo"
-          add_field_from_env => [ "newfield", "MY_ENV_VAR" ]
+          add_metadata_from_env => [ "newfield", "MY_ENV_VAR" ]
         }
       }
     CONFIG
@@ -37,7 +37,7 @@ describe LogStash::Filters::Environment do
     ENV["MY_ENV_VAR"] = "hello world"
 
     sample("type" => "bar", "message" => "fizz") do
-      insist { subject["newfield"] }.nil?
+      insist { subject["@metadata"]["newfield"] }.nil?
     end
   end
 end

metadata

@@ -1,24 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-environment
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 2.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   name: logstash-core
   prerelease: false
   type: :runtime
@@ -26,10 +26,10 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -50,12 +50,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
+- NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/filters/environment.rb
 - logstash-filter-environment.gemspec
 - spec/filters/environment_spec.rb
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Set fields from environment variables

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"