fluent-plugin-path2tag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27be571636b1a6fd51e55b7911446aa9321d4202
+  data.tar.gz: 00c3ea92080757ad63ca7d688fa9f7486b93d541
+SHA512:
+  metadata.gz: 1a30cdb68667a72bbf1b15dca69d49ed786d5a7f796c03647ddb35abb65b8f566f616cfce80ed34c91e4c5cf20f2ca2abbe1e9d1e2dcc97b1e54759b8490b2ef
+  data.tar.gz: 8987a837cd93f1f595ee7ea59f08dfa3fa46444632be8c1985e5b3fc40317d7396c4f20d85dd5af5dc8cd796155f6318e98f12596b8afddcbf87ce49dfb9efc2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,51 @@
+# fluent-plugin-path2tag
+
+## Overview
+
+## Installation
+
+```
+# for system installed fluentd
+$ gem install fluent-plugin-path2tag
+
+# for td-agent (Legacy)
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install ffluent-plugin-path2tag -v 0.0.1
+
+# for td-agent2 (with fluentd v0.12)
+$ sudo td-agent-gem install fluent-plugin-path2tag -v 0.0.1
+```
+
+## Configuration
+
+### Syntax
+```
+path2tag <path_key_name> <data_key_name>
+
+```
+
+### Usage
+```
+<source>
+  @type tail
+  format ltsv
+  tag nginx.access
+  path /var/log/nginx/access.log
+  pos_file /var/log/td-agent/buffer/access.log.pos
+</source>
+
+<match nginx.access>
+    @type path2tag
+    path2tag request_uri request_body
+</match>
+
+<match path2tag.clear>
+  @type null
+</match>
+```
+
+## License
+
+Copyright (c) 2017- Shota Kuwahara  
+[MIT License](http://opensource.org/licenses/MIT)
+
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/path2tag"
+
+# 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(__FILE__)

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-path2tag.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+#lib = File.expand_path("../lib", __FILE__)
+#$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path("../lib", __FILE__)
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-path2tag"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Shota Kuwahara"]
+  spec.email         = ["shota.kuwahara@skuwa229.com"]
+
+  spec.summary       = %q{Fluentd Output filter plugin.}
+  spec.homepage      = "http://skuwa229.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "test-unit", ">= 3.1.0"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "fluentd", [">= 0.10.0", "< 0.14.0"]
+end

data/lib/fluent/plugin/path2tag/version.rb

@@ -0,0 +1,7 @@
+module Fluent
+  module Plugin
+    module Path2tag
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/fluent/plugin/path2tag.rb

@@ -0,0 +1,56 @@
+class Fluent::Path2tagOutput < Fluent::Output
+  Fluent::Plugin.register_output('path2tag', self)
+
+  def configure(conf)
+    super
+
+    @rewriterules = []
+    conf.keys.select{|k| k =~ /^path2tag$/}.each do |key|
+      path_key, data_key = conf[key].split(" ")
+      if path_key.nil? || data_key.nil?
+        raise Fluent::ConfigError, "failed to parse path2tag at #{key} #{conf[key]}"
+      end
+
+      @rewriterules.push([path_key, data_key])
+      log.info "adding path2tag rule: #{key} #{@rewriterules.last}"
+    end
+
+    unless @rewriterules.length > 0
+      raise Fluent::ConfigError, "missing path2tag rule"
+    end
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time,record|
+      rewrited_tag, newrecord = rewrite_tag_record(tag, record)
+      if newrecord.nil? then
+        router.emit(rewrited_tag, time, record)
+      else
+        router.emit(rewrited_tag, time, newrecord)
+      end
+    end
+
+    chain.next
+  end
+
+  def rewrite_tag_record(tag, record)
+    path_key, data_key = @rewriterules[0]
+
+    unless record.has_key?(path_key)
+      log.warn "record has no path_key <#{path_key}>"
+      return "path2tag.clear", nil
+    end
+
+    unless record.has_key?(data_key)
+      log.warn "record has no data_key <#{data_key}>"
+      return "path2tag.clear", nil
+    end
+
+    newtag = record[path_key]
+    if newtag.start_with?("/")
+      newtag = newtag.sub("/", "")
+    end
+    newtag = newtag.gsub("/", ".")
+    return newtag, record[data_key]
+  end
+end

data/spec/fluent/plugin/path2tag_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe Fluent::Plugin::Path2tag do
+  it "has a version number" do
+    expect(Fluent::Plugin::Path2tag::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "fluent/plugin/path2tag"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/path2tag'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_path2tag.rb

@@ -0,0 +1,104 @@
+require 'helper'
+
+class Path2tagTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG_OK = %[
+    path2tag request_uri request_body
+  ]
+
+  CONFIG_NO_RULE = %[
+  ]
+
+  CONFIG_INVALID_RULE = %[
+    path2tag request_uri
+  ]
+
+  CONFIG_NOT_START_WITH_PATH2TAG = %[
+    path_to_tag request_uri request_body
+  ]
+
+  CONFIG_NO_PATH_KEY = %[
+    path2tag uri request_body
+  ]
+
+  CONFIG_NO_DATA_KEY = %[
+    path2tag request_uri body
+  ]
+
+  def create_driver(conf=CONFIG_OK,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::Path2tagOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      create_driver(CONFIG_NO_RULE)
+    }
+    assert_raise(Fluent::ConfigError) {
+      create_driver(CONFIG_INVALID_RULE)
+    }
+    assert_raise(Fluent::ConfigError) {
+      create_driver(CONFIG_NOT_START_WITH_PATH2TAG)
+    }
+    d = create_driver %[
+      path2tag URL BODY
+    ]
+    assert_equal 'URL BODY', d.instance.config['path2tag']
+  end
+
+  def test_emit_ok
+    d1 = create_driver(CONFIG_OK, 'nginx.access')
+    d1.run do
+      d1.emit({'request_uri' => '/logpose/endpoints/ios', 'request_body' => '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}'})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'logpose.endpoints.ios', emits[0][0]
+    assert_equal '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}', emits[0][2]
+  end
+
+  def test_emit_no_path_key
+    d1 = create_driver(CONFIG_NO_PATH_KEY, 'nginx.access')
+    d1.run do
+      d1.emit({'request_uri' => '/logpose/endpoints/ios', 'request_body' => '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}'})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'path2tag.clear', emits[0][0]
+  end
+
+  def test_emit_no_data_key
+    d1 = create_driver(CONFIG_NO_DATA_KEY, 'nginx.access')
+    d1.run do
+      d1.emit({'request_uri' => '/logpose/endpoints/ios', 'request_body' => '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}'})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'path2tag.clear', emits[0][0]
+  end
+
+  def test_emit_path_format_1
+    d1 = create_driver(CONFIG_OK, 'nginx.access')
+    d1.run do
+       d1.emit({'request_uri' => '/logpose/endpoints/ios', 'request_body' => '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}'})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'logpose.endpoints.ios', emits[0][0]
+    assert_equal '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}', emits[0][2]
+  end
+
+  def test_emit_path_format_2
+    d1 = create_driver(CONFIG_OK, 'nginx.access')
+    d1.run do
+       d1.emit({'request_uri' => 'logpose', 'request_body' => '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}'})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'logpose', emits[0][0]
+    assert_equal '{"fluentd_time":"2017-02-20 10:39:14 UTC","unique_id":"123ABC","device_token":"ABC123"}', emits[0][2]
+  end
+end
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-path2tag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shota Kuwahara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !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: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: 
+email:
+- shota.kuwahara@skuwa229.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-path2tag.gemspec
+- lib/fluent/plugin/path2tag.rb
+- lib/fluent/plugin/path2tag/version.rb
+- spec/fluent/plugin/path2tag_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/plugin/test_path2tag.rb
+homepage: http://skuwa229.com/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Fluentd Output filter plugin.
+test_files: []