logstash-output-file 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adaf924485fd1bb625fde5bd5461cace6c429c08
-  data.tar.gz: bf174048dd7393c9183a9c56765df469dee688b2
+  metadata.gz: e143e3304bce2de4661eda2c3530f0c12d9fb92c
+  data.tar.gz: 2dce1e652301a8aac23edf284b43d9dba7ace304
 SHA512:
-  metadata.gz: 3a0dbd7eace73e237997122f6441c8ad00f9dcf982f6533be8002dcc0bf2ee1cdcd15e705f1c2bc5ffed59eb639dd4650c8e71fb6875dd9edccfc2d4053e0709
-  data.tar.gz: f8dcaf8b47a11076224b889d903310e0a03ab44d0e1795ec0f1df15d4a7845079389cf62336c042d5c10e38caf90c9a48573e9360796ce740a5f09b6b6830035
+  metadata.gz: 9458c1873ac9a0f2d8a1dc723cd772bb1f9a5e14a202eb34ccab67199e0a281de790933c9bb8b19c31253448313ad780e027768dc14f06ae009598ef6a1bc621
+  data.tar.gz: 06dff36877a2a496473fdf11c123712833f4572f9bf57e5e71a28e0286fdd12917edd67eabeee0936d3c149019bd8c3b2b3f2358fa08d297764486ab61353024

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,136 @@
+:plugin: file
+: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}"]
+
+=== File output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This output writes events to files on disk. You can use fields
+from the event as parts of the filename and/or path.
+
+By default, this output writes one event per line in **json** format.
+You can customise the line format using the `line` codec like
+[source,ruby]
+output {
+ file {
+   path => ...
+   codec => line { format => "custom format: %{message}"}
+ }
+}
+
+[id="plugins-{type}s-{plugin}-options"]
+==== File 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}-create_if_deleted>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-dir_mode>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-file_mode>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-filename_failure>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-flush_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-gzip>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-path>> |<<string,string>>|Yes
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-create_if_deleted"]
+===== `create_if_deleted` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+If the configured file is deleted, but an event is handled by the plugin, 
+the plugin will recreate the file. Default => true
+
+[id="plugins-{type}s-{plugin}-dir_mode"]
+===== `dir_mode` 
+
+  * Value type is <<number,number>>
+  * Default value is `-1`
+
+Dir access mode to use. Note that due to the bug in jruby system umask
+is ignored on linux: https://github.com/jruby/jruby/issues/3426
+Setting it to -1 uses default OS value.
+Example: `"dir_mode" => 0750`
+
+[id="plugins-{type}s-{plugin}-file_mode"]
+===== `file_mode` 
+
+  * Value type is <<number,number>>
+  * Default value is `-1`
+
+File access mode to use. Note that due to the bug in jruby system umask
+is ignored on linux: https://github.com/jruby/jruby/issues/3426
+Setting it to -1 uses default OS value.
+Example: `"file_mode" => 0640`
+
+[id="plugins-{type}s-{plugin}-filename_failure"]
+===== `filename_failure` 
+
+  * Value type is <<string,string>>
+  * Default value is `"_filepath_failures"`
+
+If the generated path is invalid, the events will be saved
+into this file and inside the defined path.
+
+[id="plugins-{type}s-{plugin}-flush_interval"]
+===== `flush_interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `2`
+
+Flush interval (in seconds) for flushing writes to log files.
+0 will flush on every message.
+
+[id="plugins-{type}s-{plugin}-gzip"]
+===== `gzip` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Gzip the output stream before writing to disk.
+
+[id="plugins-{type}s-{plugin}-path"]
+===== `path` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The path to the file to write. Event fields can be used here,
+like `/var/log/logstash/%{host}/%{application}`
+One may also utilize the path option for date-based log
+rotation via the joda time format. This will use the event
+timestamp.
+E.g.: `path => "./test-%{+YYYY-MM-dd}.txt"` to create
+`./test-2013-05-29.txt`
+
+If you use an absolute path you cannot start with a dynamic string.
+E.g: `/%{myfield}/`, `/test-%{myfield}/` are not valid paths
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-file.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-file'
-  s.version         = '4.0.1'
+  s.version         = '4.0.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This output will write events to files on disk"
   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-output-file
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/file.rb
 - logstash-output-file.gemspec
 - spec/outputs/file_spec.rb