fluent-plugin-color-stripper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9aa4b23ec2a3be836b31af80604b4ec83f88aff7
+  data.tar.gz: 4f9ed855efadc5d05e432d3ca164bd56bb370528
+SHA512:
+  metadata.gz: e1bb4d36f0e5c9306238cc24ef42da1c45fc0331ce0008379abb1840d405187b8407d4efc79e2971404bde4848963ce74b81f4a205b477279808521eaacc9b36
+  data.tar.gz: f726c7ae003a91dda548eb7873e13547943193eac08c602ba913d6c65706463da226042d0996a8a4caa0d846d5a234306be6300de06935ae30886ff8dbe5946f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-color-stripper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ably
+
+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,61 @@
+# Fluent::Plugin::ColorStripper
+
+An out plugin for [Fluentd](http://fluentd.org) to strip ANSI color from log files.  No more nasty logs from apps that use color that appear similar to:
+
+    [0;33;49mWARN [0m : [0;33;49mRate limit of 6 notifications per hour met for Http monitor 'test' for 'server
+    '[0m
+
+You can specify all or specific fields to have the ANSI color stripped
+
+## Installation
+
+    $ gem install fluent-plugin-color-stripper
+
+## Usage
+
+    <match input.tag>
+        type color_stripper
+        tag  output.tag
+        strip_fields key1, key2
+    </match>
+
+Pass this record:
+
+    input.tag: {
+        "key1": "\033[30mvalue1\033[0m",
+        "key2": "\033[31mvalue2\033[0m"
+        "key3": "\033[32mvalue3\033[0m"
+    }
+
+Then you get:
+
+    output.tag: {
+        "key1": "value1",
+        "key2": "value2",
+        "key3": "\033[32mvalue3\033[0m"
+    }
+
+### strip_fields
+
+If the field `strip_fields` is omitted or is empty then all fields will have their color stripped.
+
+    <match input.tag>
+        type color_stripper
+        tag  output.tag
+    </match>
+
+Pass this record:
+
+    input.tag: {
+        "key1": "\033[30mvalue1\033[0m",
+        "key2": "\033[31mvalue2\033[0m"
+        "key3": "\033[32mvalue3\033[0m"
+    }
+
+Then you get:
+
+    output.tag: {
+        "key1": "value1",
+        "key2": "value2",
+        "key3": "value2"
+    }

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/*.rb']
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-color-stripper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-color-stripper"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Matthew O'Riordan"]
+  spec.email         = ["matt@ably.io "]
+  spec.description   = %q{Output plugin to strip ANSI color codes in the logs.}
+  spec.summary       = %q{Output plugin to strip ANSI color codes in the logs.}
+  spec.homepage      = "https://github.com/mattheworiordan/fluent-plugin-color-stripper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "colorize", "~> 0.7.5"
+  spec.add_runtime_dependency "fluentd", "~> 0.12"
+end

data/lib/fluent/plugin/out_color_stripper.rb

@@ -0,0 +1,55 @@
+module Fluent
+  class ColorStripperOutput < Output
+    Fluent::Plugin.register_output('color_stripper', self)
+
+    config_param :strip_fields, :string, default: nil
+
+    def configure(conf)
+      super
+      @strip_fields_arr = conf['strip_fields'].to_s.split(/\s*,\s*/).map do |field|
+        field unless field.strip.empty?
+      end.compact
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        Engine.emit(@tag, time, format_record(record))
+      end
+
+      chain.next
+    end
+
+    private
+
+    def format_record(record)
+      record.each_with_object({}) do |(key, val), object|
+        object[key] = if strip_field?(key)
+          uncolorize(val)
+        else
+          val
+        end
+      end
+    end
+
+    #
+    # Return uncolorized string
+    #
+    def uncolorize(string)
+      scan_for_colors(string).inject('') do |str, match|
+        str << (match[3] || match[4])
+      end
+    end
+
+    #
+    # Scan for colorized string
+    #
+    def scan_for_colors(string)
+      string.scan(/\033\[([0-9]+);([0-9]+);([0-9]+)m(.+?)\033\[0m|([^\033]+)/m)
+    end
+
+    def strip_field?(field)
+      puts @strip_fields_arr
+      @strip_fields_arr.empty? || @strip_fields_arr.include?(field)
+    end
+  end
+end

data/test/test_color_stripper.rb

@@ -0,0 +1,60 @@
+require 'colorize'
+require 'fluent/test'
+require 'fluent/plugin/out_color_stripper'
+
+class ColorStripperOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf)
+    Fluent::Test::OutputTestDriver.new(Fluent::ColorStripperOutput).configure(conf)
+  end
+
+  def test_selected_fields
+    d1 = create_driver %[
+      type color_stripper
+      tag  formatted
+      strip_fields decolorize, decolorize_also
+    ]
+
+    d1.run do
+      d1.emit({ 'keep_color' => 'red'.colorize(:red), 'decolorize' => 'green'.colorize(:green) })
+      d1.emit({ 'no_color' => 'no_color', 'decolorize_also' => 'yellow'.colorize(:yellow) })
+    end
+
+    assert_equal [
+      {
+        'keep_color' => 'red'.colorize(:red),
+        'decolorize' => 'green'
+      },
+      {
+        'no_color' => 'no_color',
+        'decolorize_also' => 'yellow'
+      }
+    ], d1.records
+  end
+
+  def test_all_fields
+    d1 = create_driver %[
+      type color_stripper
+      tag  formatted
+    ]
+
+    d1.run do
+      d1.emit({ 'color' => 'red'.colorize(:red), 'decolorize' => 'green'.colorize(:green) })
+      d1.emit({ 'no_color' => 'no_color', 'decolorize_also' => 'yellow'.colorize(:yellow) })
+    end
+
+    assert_equal [
+      {
+        'color' => 'red',
+        'decolorize' => 'green'
+      },
+      {
+        'no_color' => 'no_color',
+        'decolorize_also' => 'yellow'
+      }
+    ], d1.records
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-color-stripper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew O'Riordan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !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'
+description: Output plugin to strip ANSI color codes in the logs.
+email:
+- 'matt@ably.io '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-color-stripper.gemspec
+- lib/fluent/plugin/out_color_stripper.rb
+- test/test_color_stripper.rb
+homepage: https://github.com/mattheworiordan/fluent-plugin-color-stripper
+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: Output plugin to strip ANSI color codes in the logs.
+test_files:
+- test/test_color_stripper.rb
+has_rdoc: