fluent-plugin-filter_linefeeder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66883b27b28fa3518b6999804326c7039493b617
+  data.tar.gz: b2661252f996455df9b74e7538353dc706758de3
+SHA512:
+  metadata.gz: 8260a22c6cd57da7b7e6e6defc0d9050c240bcaa408f22df857fba740c7db21a84218d81409dd0d5edfc89058d84228de77791df73e669a55c5b3f1b3739eb02
+  data.tar.gz: f09a890ffb835e2b3faebdcd37d7acc50a84ebda4a0a1bc529c66fbb2ab9392003d1a72dc1f828846cba858785e78b8d65f4ad85c2d051ddfe6fffeb95130816

data/.gitignore

@@ -0,0 +1,14 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+.ruby-version
+pkg/*

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.0.1
+
+First version
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Naotoshi Seo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# fluent-plugin-filter_linefeeder
+
+[![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-filter_linefeeder.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-filter_linefeeder)
+
+A Fluentd filter plugin to convert '\n' to "\n" (line feed)
+
+## What to do
+
+I usually output rails application stacktrace logs with one line using my [oneline_log_formatter](https://github.com/sonots/oneline_log_formatter) so that I can easily collect logs.
+This plugin recovers its '\n' strings into "\n" (line feed)
+
+## Requirements
+
+Fluentd >= v0.12
+
+## Install
+
+Use RubyGems:
+
+```
+gem install fluent-plugin-filter_linefeeder
+```
+
+## Configuration Example
+
+See [example.conf](example.conf)
+
+## Parameters
+
+* keys
+  * record keys to target
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2015 Naotoshi Seo. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+desc 'Run test_unit based test'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = Dir["test/**/test_*.rb"].sort
+  t.verbose = true
+  #t.warning = true
+end
+task :default => :test
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/example.conf

@@ -0,0 +1,14 @@
+<source>
+  type dummy
+  tag dummy
+  dummy {"message":"foo\\nbar"}
+</source>
+
+<filter **>
+  type linefeeder
+  keys message
+</filter>
+
+<match **>
+  type stdout
+</match>

data/fluent-plugin-filter_linefeeder.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-filter_linefeeder"
+  s.version     = "0.0.1"
+  s.authors     = ["Naotoshi Seo"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-filter_linefeeder"
+  s.summary     = "A Fluentd filter plugin to convert '\n' to \"\n\" (line feed)"
+  s.description = s.summary
+  s.licenses    = ["MIT"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd", ">= 0.12"
+  s.add_runtime_dependency "string-scrub" if RUBY_VERSION.to_f < 2.1
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/filter_linefeeder.rb

@@ -0,0 +1,35 @@
+module Fluent
+  class LinefeederFilter < Filter
+    Fluent::Plugin.register_filter('linefeeder', self)
+
+    config_param :keys do |val|
+      val.split(',')
+    end
+
+    def initialize
+      require 'string/scrub' if RUBY_VERSION.to_f < 2.1
+      super
+    end
+
+    def configure(conf)
+      super
+    end
+
+    def filter(tag, time, record)
+      keys.each do |key|
+        linefeed!(record[key]) if record[key]
+      end
+      record
+    end
+
+    def linefeed!(string)
+      begin
+        string.gsub!("\\n", "\n")
+      rescue ArgumentError => e
+        raise e unless e.message.index("invalid byte sequence in") == 0
+        string.scrub!('?')
+        retry
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end

data/test/test_filter_linefeeder.rb

@@ -0,0 +1,47 @@
+require_relative 'helper'
+require 'fluent/plugin/filter_linefeeder'
+
+class LinefeederFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  setup do
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(LinefeederFilter).configure(conf, true)
+  end
+
+  def filter(d, msg)
+    d.run { d.filter(msg, @time) }
+    d.filtered_as_array.first[2]
+  end
+
+  sub_test_case 'configure' do
+    def test_keys
+      assert_raise Fluent::ConfigError do
+        create_driver('')
+      end
+
+      d = create_driver(%[keys a,b])
+      assert_equal ["a","b"],  d.instance.keys
+    end
+  end
+
+  sub_test_case 'filter' do
+    def test_linefeed
+      d = create_driver(%[keys message])
+      msg = { 'message' => "foo\\nbar" }
+      filtered = filter(d, msg)
+      assert_equal "foo\nbar", filtered['message']
+    end
+
+    def test_scrub
+      d = create_driver(%[keys message])
+      msg = { 'message' => "\xff".force_encoding('UTF-8') }
+      filtered = filter(d, msg)
+      assert_equal "?", filtered['message']
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter_linefeeder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Fluentd filter plugin to convert ' ' to " " (line feed)
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example.conf
+- fluent-plugin-filter_linefeeder.gemspec
+- lib/fluent/plugin/filter_linefeeder.rb
+- test/helper.rb
+- test/test_filter_linefeeder.rb
+homepage: https://github.com/sonots/fluent-plugin-filter_linefeeder
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Fluentd filter plugin to convert ' ' to " " (line feed)
+test_files:
+- test/helper.rb
+- test/test_filter_linefeeder.rb