logstash-output-csv 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf27eb2bd2a2c7f319206b2551e773db1b1384fa
-  data.tar.gz: b39854c4fb69d80283c5948dd51b8e024403995c
+  metadata.gz: 1383b217b90791fecbff26c7dc354ee59dd5cbfc
+  data.tar.gz: f627906184033e7e110dcdfe6e8eacfe0f3524bb
 SHA512:
-  metadata.gz: abfe83405456fb2f8104ba51c3728c3548db5707971009d4490f5c6276158c934d995350723e3a63465e7379ac421db2106fce3906a37d0cb8c6de282e0e0909
-  data.tar.gz: 7e8a4ff31b01e17edfe7dfcbfef730898e293fd8cc2bae3c2d9a1ec2c5002dd0037bdd59f74b63fb769cc0f9a41986b19c6ba9ca5ec5573a8003e9f6ffe3fd51
+  metadata.gz: 00d9b949660281296cd9e1c632f1bfbb56a33a4f154e30e1d27e9e2312f8e06ee65fbf89de12bf73720fd00c17888782f943af11f7bc6f2904d41929dcd8bde3
+  data.tar.gz: 94ec80dfcbeacfecb7a82f1477c20331b533760c29d502fd47936643f58180c497682a7559770bdbc8cd251ea553034656faf0b8e365de277cd5b55860da18e4

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,175 @@
+:plugin: csv
+: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}"]
+
+=== Csv output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+CSV output.
+
+Write events to disk in CSV or other delimited format
+Based on the file output, many config values are shared
+Uses the Ruby csv library internally
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Csv 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}-csv_options>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-dir_mode>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-fields>> |<<array,array>>|Yes
+| <<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
+| <<plugins-{type}s-{plugin}-spreadsheet_safe>> |<<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}-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}-csv_options"]
+===== `csv_options` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{}`
+
+Options for CSV output. This is passed directly to the Ruby stdlib to_csv function.
+Full documentation is available on the http://ruby-doc.org/stdlib-2.0.0/libdoc/csv/rdoc/index.html[Ruby CSV documentation page].
+A typical use case would be to use alternative column or row seperators eg: `csv_options => {"col_sep" => "\t" "row_sep" => "\r\n"}` gives tab seperated data with windows line endings
+
+[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}-fields"]
+===== `fields` 
+
+  * This is a required setting.
+  * Value type is <<array,array>>
+  * There is no default value for this setting.
+
+The field names from the event that should be written to the CSV file.
+Fields are written to the CSV in the same order as the array.
+If a field does not exist on the event, an empty string will be written.
+Supports field reference syntax eg: `fields => ["field1", "[nested][field]"]`.
+
+[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.
+
+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}"}
+ }
+}
+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}-spreadsheet_safe"]
+===== `spreadsheet_safe` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Option to not escape/munge string values. Please note turning off this option
+may not make the values safe in your spreadsheet application
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-csv.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-csv'
-  s.version         = '3.0.3'
+  s.version         = '3.0.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Write events to disk in CSV or other delimited format"
   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-csv
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-20 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/csv.rb
 - logstash-output-csv.gemspec
 - spec/outputs/csv_spec.rb