fluent-plugin-with-extra-fields-parser 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 hiraro
+
+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,134 @@
+# fluent-plugin-with-extra-fields-parser
+
+
+## Installation
+
+```
+$ /opt/td-agent/embedded/bin/fluent-gem install fluent-plugin-with-extra-fields-parser
+```
+
+## Usage
+
+```
+####
+## Source descriptions:
+##
+
+## syslog
+<source>
+
+  # I want to process the syslog of my yamaha rtx1100...
+
+  # example output format 1.
+  # [INSPECT] PP[01][out][101] TCP xxx.xxx.xx.xxx:xxx > xxx.xx.
+xx.xxx:80 (2016/02/23 10:59:24)
+
+  # example output format 2.
+  # PP[01] Rejected at IN(2000) filter: TCP xx.xxx.xxx.xx:xxx
+
+  type syslog
+  tag raw.rtx1100
+  format none
+
+</source>
+
+####
+## Output descriptions:
+##
+
+<match raw.rtx1100.**>
+
+  # ...so I use tagomoris/fluent-plugin-parser
+
+  type parser
+  key_name message
+
+  # ...and repeatedly/fluent-plugin-multi-format-parser
+
+  format multi_format
+  remove_prefix raw
+  add_prefix parsed
+
+  <pattern>
+
+      # ...and this plugin
+
+      format with_extra_fields
+      
+      base_format /^\[INSPECT\]\s+(?<target>.+)\[(?<direction>.+)\]\[(?<filter_num>\d+)\]\s+(?<proto>.+)\s+(?<src_ip>.+):(?<src_port>.+)\s+>\s+(?<dest_ip>.+):(?<dest_port>.+)\s+\((?<time>.+)\)$/
+      time_format '%Y/%m/%d %H:%M:%S'
+
+      # ...to embed log_type field
+
+      extra_fields { "log_type": "inspect" }
+
+  </pattern>
+  <pattern>
+
+      format with_extra_fields
+
+      base_format /^(?<target>.+)\s+Rejected\s+at\s+(?<direction>.+)\((?<filter_num>\d+)\)\s+filter:\s+(?<proto>.+)\s+(?<src_ip>.+):(?<src_port>.+)\s+>\s+(?<dest_ip>.+):(?<dest_port>.+)$/
+
+      extra_fields { "log_type": "reject" }
+
+  </pattern>
+</match>
+
+
+<match parsed.rtx1100.**>
+
+  # you'll get log_type here.
+  # so, rewrite the tag using the log_type field
+  # with fluent/fluent-plugin-rewrite-tag-filter
+
+  type rewrite_tag_filter
+
+  rewriterule1 log_type   ^inspect$       rtx1100.inspect
+  rewriterule2 log_type   ^reject$        rtx1100.reject
+
+</match>
+
+<match rtx1100.inspect.**>
+
+  # and store into elasticsearch
+  # with uken/fluent-plugin-elasticsearch
+
+  type elasticsearch
+  logstash_format true
+  logstash_prefix rtx1100-inspect
+  include_tag_key true
+  tag_key @log_name
+  hosts localhost:9200
+  buffer_type memory
+  num_threads 1
+  flush_interval 60
+  retry_wait 1.0
+  retry_limit 17
+
+</match>
+
+<match rtx1100.reject.**>
+
+  type elasticsearch
+  logstash_format true
+  logstash_prefix rtx1100-reject
+  include_tag_key true
+  tag_key @log_name
+  hosts localhost:9200
+  buffer_type memory
+  num_threads 1
+  flush_interval 60
+  retry_wait 1.0
+  retry_limit 17
+
+</match>
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/hiraro/fluent-plugin-with-extra-fields-parser).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/with/extra/fields/parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fluent-plugin-with-extra-fields-parser.gemspec

@@ -0,0 +1,23 @@
+# 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-with-extra-fields-parser"
+  spec.version       = "0.0.1"
+  spec.authors       = ["hiraro"]
+  spec.email         = ["traurig.orz@gmail.com"]
+
+  spec.summary       = %q{Fluentd parser plugin}
+  spec.description   = %q{Appends extra fields after parse.}
+  spec.homepage      = "https://github.com/hiraro/fluentd-plugin-with-extra-fields-parser"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "fluentd", "~> 0.12.0"
+  spec.add_runtime_dependency "json", ">= 1.4.3"
+end

data/lib/fluent/plugin/parser_with_extra_fields.rb

@@ -0,0 +1,47 @@
+require 'fluent/log'
+require 'json'
+
+module Fluent
+  class TextParser
+    class WithExtraFieldsParser < Parser
+      Plugin.register_parser('with_extra_fields', self)
+
+      config_param :base_format, :string
+      config_param :suppress_parse_error_log, :bool, :default => false
+
+      def initialize
+        super
+        @parser = nil
+        @extra_fields = {}
+      end
+
+      def configure(conf)
+        super
+        @parser = Plugin.new_parser(@base_format)
+        @parser.configure(conf)
+        
+        JSON.parse(conf["extra_fields"]).each { |k, v|
+          @extra_fields[k] = v
+        }
+      end
+
+      def parse(text)
+        begin
+          @parser.parse(text) { |time, record|
+            if time && record
+              @extra_fields.each { |k, v|
+                record[k] = v
+              }
+              yield time, record
+              return
+            end
+          }
+        rescue => e
+          $log.warn "parse failed #{e.message}" unless @suppress_parse_error_log
+        end
+        yield nil, nil
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-with-extra-fields-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- hiraro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+description: Appends extra fields after parse.
+email:
+- traurig.orz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-with-extra-fields-parser.gemspec
+- lib/fluent/plugin/parser_with_extra_fields.rb
+homepage: https://github.com/hiraro/fluentd-plugin-with-extra-fields-parser
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fluentd parser plugin
+test_files: []