logstash-codec-csv 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6f3dc6030f103dc961e34e2babeeccd8fe64884
+  data.tar.gz: 7a26a6c91a3f5cfd272a7ce75e38e46c8fe53bc5
+SHA512:
+  metadata.gz: ec21f23421f5da8349534a2c3f787a7a4f04be9166b078c296538679bac1da9f1fbbedb3b401dde2a5d274c7a00adbce71b27fc04642d6017379e82a0d06a952
+  data.tar.gz: b5219a99d9bac584872604117631f99c1377195ea77317ffb867ff3f59d572cc60f3c50ee013a074ab86dd281998853e9883eb74e605fa35e6bd3c04e1312107

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.1.2
+  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+# 0.1.1
+  - New dependency requirements for logstash-core for the 5.0 release
+## 0.1.0
+  - Initial version of the codec, this first version include feature parity with the current CSV filter, this the ability to set column names, the column separator, a quote char, decide if autogeneration of columns is ok, type conversion and skip empty columns.
+  - This initial version also include an option to treat the first
+chunk of data seen as containing the headers. This functionality
+will be useful when reading CSV files (all at once, usually) that
+contain this information.

data/CONTRIBUTORS

@@ -0,0 +1,16 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Colin Surprenant (colinsurprenant)
+* Jordan Sissel (jordansissel)
+* João Duarte (jsvd)
+* Nick Ethier (nickethier)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,97 @@
+# Logstash CSV Codec
+
+## WIP: Under Development, NOT FOR PRODUCTION
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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/).
+
+- 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
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/codecs/csv.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+require "logstash/codecs/base"
+require "logstash/util/charset"
+require "csv"
+
+class LogStash::Codecs::CSV < LogStash::Codecs::Base
+
+  config_name "csv"
+
+  # Define a list of column names (in the order they appear in the CSV,
+  # as if it were a header line). If `columns` is not configured, or there
+  # are not enough columns specified, the default column names are
+  # "column1", "column2", etc. In the case that there are more columns
+  # in the data than specified in this column list, extra columns will be auto-numbered:
+  # (e.g. "user_defined_1", "user_defined_2", "column3", "column4", etc.)
+  config :columns, :validate => :array, :default => []
+
+  # Define the column separator value. If this is not specified, the default
+  # is a comma `,`.
+  # Optional.
+  config :separator, :validate => :string, :default => ","
+
+  # Define the character used to quote CSV fields. If this is not specified
+  # the default is a double quote `"`.
+  # Optional.
+  config :quote_char, :validate => :string, :default => '"'
+
+  # Treats the first line received as the hearder information, this information will
+  # be used to compose the field names in the generated events. Note this information can
+  # be reset on demand, useful for example when dealing with new files in the file input
+  # or new request in the http_poller. Default => false
+  config :include_headers, :validate => :boolean, :default => false
+
+  # Define whether column names should autogenerated or not.
+  # Defaults to true. If set to false, columns not having a header specified will not be parsed.
+  config :autogenerate_column_names, :validate => :boolean, :default => true
+
+  # Define whether empty columns should be skipped.
+  # Defaults to false. If set to true, columns containing no value will not get set.
+  config :skip_empty_columns, :validate => :boolean, :default => false
+
+  # Define a set of datatype conversions to be applied to columns.
+  # Possible conversions are integer, float, date, date_time, boolean
+  #
+  # # Example:
+  # [source,ruby]
+  #     filter {
+  #       csv {
+  #         convert => { "column1" => "integer", "column2" => "boolean" }
+  #       }
+  #     }
+  config :convert, :validate => :hash, :default => {}
+
+  ##
+  # List of valid conversion types used for the convert option
+  ##
+  VALID_CONVERT_TYPES = [ "integer", "float", "date", "date_time", "boolean" ].freeze
+
+
+  # The character encoding used in this codec. Examples include "UTF-8" and
+  # "CP1252".
+  config :charset, :validate => ::Encoding.name_list, :default => "UTF-8"
+
+  def register
+    @converter = LogStash::Util::Charset.new(@charset)
+    @converter.logger = @logger
+
+    # validate conversion types to be the valid ones.
+    @convert.each_pair do |column, type|
+      if !VALID_CONVERT_TYPES.include?(type)
+        raise LogStash::ConfigurationError, "#{type} is not a valid conversion type."
+      end
+    end
+
+    @headers = false
+    @options = { :col_sep => @separator, :quote_char => @quote_char }
+  end
+
+  def decode(data)
+    data = @converter.convert(data)
+    begin
+      values = CSV.parse_line(data, @options)
+      if @include_headers && !@headers
+        @headers = true
+        @options[:headers] = values
+      else
+        decoded = {}
+        values.each_with_index do |fields, index|
+          field_name, value = nil, nil
+          if fields.is_a?(String) && !( @skip_empty_columns && fields.nil?)  # No headers
+            next if ignore_field?(index)
+            field_name =  ( !@columns[index].nil? ? @columns[index] : "column#{(index+1)}")
+            value      = fields
+          elsif fields.is_a?(Array) # Got headers
+            field_name = fields[0]
+            value      = fields[1]
+          end
+          next unless field_name
+          decoded[field_name] = if should_transform?(field_name)
+                                  transform(field_name, value)
+                                else
+                                  value
+                                end
+        end
+        yield LogStash::Event.new(decoded) if block_given?
+      end
+    rescue CSV::MalformedCSVError => e
+      @logger.info("CSV parse failure. Falling back to plain-text", :error => e, :data => data)
+      yield LogStash::Event.new("message" => data, "tags" => ["_csvparsefailure"]) if block_given?
+    end
+  end
+
+  def encode(event)
+    csv_data = CSV.generate_line(event.to_hash.values, @options)
+    @on_event.call(event, csv_data)
+  end
+
+  def reset
+    @headers = false
+    @options.delete(:headers)
+  end
+
+  private
+
+  def ignore_field?(index)
+    !@columns[index] && !@autogenerate_column_names
+  end
+
+  def should_transform?(field_name)
+    !@convert[field_name].nil?
+  end
+
+  def transform(field_name, value)
+    transformation = @convert[field_name].to_sym
+    converters[transformation].call(value)
+  end
+
+  def converters
+    @converters ||= {
+      :integer => lambda do |value|
+        CSV::Converters[:integer].call(value)
+      end,
+      :float => lambda do |value|
+        CSV::Converters[:float].call(value)
+
+      end,
+      :date => lambda do |value|
+        CSV::Converters[:date].call(value)
+
+      end,
+      :date_time => lambda do |value|
+        CSV::Converters[:date_time].call(value)
+      end,
+      :boolean => lambda do |value|
+        value = value.strip.downcase
+        return false if value == "false"
+        return true  if value == "true"
+        return value
+      end
+    }
+  end
+
+end # class LogStash::Codecs::Plain

data/logstash-codec-csv.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-codec-csv'
+  s.version         = '0.1.2'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "The csv codec take CSV data, parses it and passes it away"
+  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"
+  s.authors         = ["Elasticsearch"]
+  s.email           = 'info@elasticsearch.com'
+  s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "codec" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/codecs/csv_spec.rb

@@ -0,0 +1,206 @@
+# encoding: utf-8
+require "logstash/codecs/csv"
+require "logstash/event"
+
+describe LogStash::Codecs::CSV do
+
+  subject(:codec) { LogStash::Codecs::CSV.new(config) }
+  let(:config)    { Hash.new }
+
+  before(:each) do
+    codec.register
+  end
+
+  describe "decode" do
+
+    let(:data) { "big,bird,sesame street" }
+
+    it "return an event from CSV data" do
+      codec.decode(data) do |event|
+        expect(event["column1"]).to eq("big")
+        expect(event["column2"]).to eq("bird")
+        expect(event["column3"]).to eq("sesame street")
+      end
+    end
+
+    describe "given column names" do
+      let(:doc)    { "big,bird,sesame street" }
+      let(:config) do
+        { "columns" => ["first", "last", "address" ] }
+      end
+
+      it "extract all the values" do
+        codec.decode(data) do |event|
+          expect(event["first"]).to eq("big")
+          expect(event["last"]).to eq("bird")
+          expect(event["address"]).to eq("sesame street")
+        end
+      end
+
+      context "parse csv skipping empty columns" do
+
+        let(:data)    { "val1,,val3" }
+
+        let(:config) do
+          { "skip_empty_columns" => true,
+            "columns" => ["custom1", "custom2", "custom3"] }
+        end
+
+        it "extract all the values" do
+          codec.decode(data) do |event|
+            expect(event["custom1"]).to eq("val1")
+            expect(event.to_hash).not_to include("custom2")
+            expect(event["custom3"]).to eq("val3")
+          end
+        end
+      end
+
+      context "parse csv without autogeneration of names" do
+
+        let(:data)    { "val1,val2,val3" }
+        let(:config) do
+          {  "autogenerate_column_names" => false,
+             "columns" => ["custom1", "custom2"] }
+        end
+
+        it "extract all the values" do
+          codec.decode(data) do |event|
+            expect(event["custom1"]).to eq("val1")
+            expect(event["custom2"]).to eq("val2")
+            expect(event["column3"]).to be_falsey
+          end
+        end
+      end
+
+    end
+
+    describe "custom separator" do
+      let(:data) { "big,bird;sesame street" }
+
+      let(:config) do
+        { "separator" => ";" }
+      end
+
+      it "return an event from CSV data" do
+        codec.decode(data) do |event|
+          expect(event["column1"]).to eq("big,bird")
+          expect(event["column2"]).to eq("sesame street")
+        end
+      end
+    end
+
+    describe "quote char" do
+      let(:data) { "big,bird,'sesame street'" }
+
+      let(:config) do
+        { "quote_char" => "'"}
+      end
+
+      it "return an event from CSV data" do
+        codec.decode(data) do |event|
+          expect(event["column1"]).to eq("big")
+          expect(event["column2"]).to eq("bird")
+          expect(event["column3"]).to eq("sesame street")
+        end
+      end
+
+      context "using the default one" do
+        let(:data) { 'big,bird,"sesame, street"' }
+        let(:config) { Hash.new }
+
+        it "return an event from CSV data" do
+          codec.decode(data) do |event|
+            expect(event["column1"]).to eq("big")
+            expect(event["column2"]).to eq("bird")
+            expect(event["column3"]).to eq("sesame, street")
+          end
+        end
+      end
+
+      context "using a null" do
+        let(:data) { 'big,bird,"sesame" street' }
+        let(:config) do
+          { "quote_char" => "\x00" }
+        end
+
+        it "return an event from CSV data" do
+          codec.decode(data) do |event|
+            expect(event["column1"]).to eq("big")
+            expect(event["column2"]).to eq("bird")
+            expect(event["column3"]).to eq('"sesame" street')
+          end
+        end
+      end
+    end
+
+    describe "having headers" do
+
+      let(:data) do
+        [ "size,animal,movie", "big,bird,sesame street"]
+      end
+
+      let(:new_data) do
+        [ "host,country,city", "example.com,germany,berlin"]
+      end
+
+      let(:config) do
+        { "include_headers" => true }
+      end
+
+      it "include header information when requested" do
+        codec.decode(data[0]) # Read the headers
+        codec.decode(data[1]) do |event|
+          expect(event["size"]).to eq("big")
+          expect(event["animal"]).to eq("bird")
+          expect(event["movie"]).to eq("sesame street")
+        end
+      end
+
+      it "reset headers and fetch the new ones" do
+        data.each do |row|
+          codec.decode(row)
+        end
+        codec.reset
+        codec.decode(new_data[0]) # set the new headers
+        codec.decode(new_data[1]) do |event|
+          expect(event["host"]).to eq("example.com")
+          expect(event["country"]).to eq("germany")
+          expect(event["city"]).to eq("berlin")
+        end
+      end
+    end
+
+    describe "using field convertion" do
+
+      let(:config) do
+        { "convert" => { "column1" => "integer", "column3" => "boolean" } }
+      end
+      let(:data)   { "1234,bird,false" }
+
+      it "get converted values to the expected type" do
+        codec.decode(data) do |event|        
+          expect(event["column1"]).to eq(1234)
+          expect(event["column2"]).to eq("bird")
+          expect(event["column3"]).to eq(false)
+        end
+      end
+
+      context "when using column names" do
+
+        let(:config) do
+          { "convert" => { "custom1" => "integer", "custom3" => "boolean" },
+            "columns" => ["custom1", "custom2", "custom3"] }
+        end
+
+        it "get converted values to the expected type" do
+          codec.decode(data) do |event|
+            expect(event["custom1"]).to eq(1234)
+            expect(event["custom2"]).to eq("bird")
+            expect(event["custom3"]).to eq(false)
+          end
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: logstash-codec-csv
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Elasticsearch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+email: info@elasticsearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/codecs/csv.rb
+- logstash-codec-csv.gemspec
+- spec/codecs/csv_spec.rb
+homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: codec
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: The csv codec take CSV data, parses it and passes it away
+test_files:
+- spec/codecs/csv_spec.rb