logstash-output-exec 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29fcfb399581aa75e8e3d73001763a92bf6f457a
-  data.tar.gz: b9d8df492e0c01c14e8199b378938e052585b75f
+  metadata.gz: 878a5afa87427168d9349c5d012a8c36e12f6481
+  data.tar.gz: 2307b161995ac098f1cd39a37410cb7aef5981a9
 SHA512:
-  metadata.gz: ad0d473dcd805260cfdf029bcb22284f112eb9674db15ce970614f0ab4379d9fdb7dbb3f9c2ad40023efe6df5794e29e905d8c52ebd0ece32fb58c765e40d275
-  data.tar.gz: fddac5679e43d4dc3fffa405f30237c2a2a34e7267209d0ca9abf1a139f874dffa2dca0a76e135b9292a71f8ffc457ad678d5d106d66e102aeef0587990c46f7
+  metadata.gz: 523bf56aad6e7fb6ce2744572c6687bae3fff9ba4808f5a2716aeecdc201aa177e9597844dbeb59549d08eb177c42ea406e206f11da3fd8e0d2aa2531df0913b
+  data.tar.gz: 7c87c1afed14a970954e6a78ae30741cc172b5eb79ba1dd9379b089f70e7ea258cd5cf222903c1d0ba8b3ae537de23ff0acb05c6f866b8625a1e4e4e6b917197

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.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,86 @@
+:plugin: exec
+:type: output
+
+///////////////////////////////////////////
+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}"]
+
+=== Exec output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+The exec output will run a command for each event received. Ruby's
+`system()` function will be used, i.e. the command string will
+be passed to a shell. You can use `%{name}` and other dynamic strings
+in the command to pass select fields from the event to the child
+process. Example:
+[source,ruby]
+    output {
+      if [type] == "abuse" {
+        exec {
+          command => "iptables -A INPUT -s %{clientip} -j DROP"
+        }
+      }
+    }
+
+WARNING: If you want it non-blocking you should use `&` or `dtach`
+or other such techniques. There is no timeout for the commands being
+run so misbehaving commands could otherwise stall the Logstash
+pipeline indefinitely.
+
+WARNING: Exercise great caution with `%{name}` field placeholders.
+The contents of the field will be included verbatim without any
+sanitization, i.e. any shell metacharacters from the field values
+will be passed straight to the shell.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Exec Output 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}-command>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-quiet>> |<<boolean,boolean>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-command"]
+===== `command` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Command line to execute via subprocess. Use `dtach` or `screen` to
+make it non blocking. This value can include `%{name}` and other
+dynamic strings.
+
+[id="plugins-{type}s-{plugin}-quiet"]
+===== `quiet` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+display the result of the command to the terminal
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-exec.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-exec'
-  s.version         = '3.1.0'
+  s.version         = '3.1.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output will run a command for any matching event."
   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"
@@ -10,7 +10,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-output-exec
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-06 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/exec.rb
 - logstash-output-exec.gemspec
 - spec/outputs/exec_spec.rb