fluent-plugin-tagdata 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGRkNzRkZTFjMDk1Y2FmYjVmZDY4NjIyMDBkZGNiNTI4MTQ5YmExNA==
+  data.tar.gz: !binary |-
+    NTIzODI3ZDNiMDFjMTc1OWYwNTk5ODEzMTcxNzUwNDA4OTFiZTA5Mw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTEwMDQxMmVhNmQyZDdkMTdlN2QyMjBmMTkyYzFlYjQ0OWI2MTRjNWU0ZjIy
+    Y2JhNTE0MTQ0ODk3ZmJkNDFjMmNmYjEyOGIxZjRmNzU4OGE0MTEzN2RlYzcy
+    NmY1MDE5ZmJjOWMyYjA5MzUxZmJhMjhkNzAzYTNlNjE1N2Q0YTM=
+  data.tar.gz: !binary |-
+    YzdmNjEzZjY0NTBjOWI4ODA1MDVlZWJhYzkzMTc5YTJiYmUyNWMyYmMxOTA3
+    MjcyMjUzMGMzMjJkNThkMzdhYmIzZDdjMGMyMTY0YzdjMzI1MzRmM2RhODE4
+    YTJhZmE4NzgyMmJhYmIzYzE2MmFhM2VmMjE5YzVmYmU4NjZkZTI=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'minitest'

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2013- Fukui Masayuki
+
+   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,106 @@
+# fluent-plugin-tagdata
+
+Fluentd plugin to put the tag records in the data.
+
+## Component
+
+### Output
+
+Fluentd plugin to put the tag records in the data.
+
+## Synopsis
+
+Imagin you have a config as below:
+
+```
+<match example.**>
+  type tagdata
+  out_keys server,protocol,domain
+  add_tag_prefix    filtered.
+  remove_tag_prefix example.
+</match>
+```
+
+And you feed such a value into fluentd:
+
+```
+"example.straycat.http.www.example.com" => {
+  "host":"localhost",
+	"user":"-",
+	"method":"GET",
+	"path":"/sample.html",
+	"code":"200",
+	"size":"1234",
+	"referer":"-",
+	"agent":"Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.22 (KHTML, like Gecko) Chrome/25.0.1364.172 Safari/537.22",
+	"response":"1234567"
+}
+```
+
+Then you'll get re-emmited tag/record below:
+
+```
+"filtered.straycat.http.www.example.com" => {
+  "host":"localhost",
+	"user":"-",
+	"method":"GET",
+	"path":"/sample.html",
+	"code":"200",
+	"size":"1234",
+	"referer":"-",
+	"agent":"Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.22 (KHTML, like Gecko) Chrome/25.0.1364.172 Safari/537.22",
+	"response":"1234567",
+	"server":"straycat",
+	"protocol":"http",
+	"domain":"http.www.example.com"
+}
+```
+
+## Configuration
+
+### out_keys
+
+The `out_keys` is used to point keys whose value contains CSV-formatted string.
+
+### firstpoint
+
+The `firstpoint` is used to a first point number of piriod-separated-tags.
+Default value is 1.
+
+### remove_tag_prefix, remove_tag_suffix, add_tag_prefix, add_tag_suffix
+
+These params are included from `Fluent::HandleTagNameMixin`. See that code for details.
+
+You must add at least one of these params.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-tagdata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-tagdata
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+### Copyright
+
+Copyright (c) 2013- Fukui Masayuki (@msfukui)
+
+### License
+
+Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,10 @@
+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/fluent-plugin-tagdata.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-tagdata"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Fukui Masayuki"]
+  spec.email         = ["msfukui@gmail.com"]
+  spec.description   = %q{Fluentd plugin to put the tag records in the data.}
+  spec.summary       = %q{Fluentd plugin to put the tag records in the data.}
+  spec.homepage      = "https://github.com/msfukui/fluent-plugin-tagdata"
+
+  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"
+  spec.add_development_dependency 'fluentd'
+  spec.add_runtime_dependency     'fluentd'
+end

data/lib/fluent/plugin/out_tagdata.rb

@@ -0,0 +1,52 @@
+module Fluent
+	class TagdataOutput < Output
+		include Fluent::HandleTagNameMixin
+		class Error < StandardError; end
+
+		Fluent::Plugin.register_output('tagdata', self)
+
+		config_param :out_keys, :default => [] do |val|
+			val.split(',')
+		end
+		config_param :firstpoint, :integer, :default => 1
+
+		def configure(conf)
+			super
+			if @out_keys.empty?
+				raise ConfigError, "out_tagdata: out_keys option is required on out_tagdata output."
+			end
+			if @firstpoint < 0
+				raise ConfigError, "out_tagdata: firstpoint option is required a zero or positive number."
+			end
+		end
+
+		def emit(tag, es, chain)
+			es.each do |time,record|
+				tagd = tag.dup
+				get_mapped_tag_to_out_keys(tagd, time, record)
+				filter_record(tagd, time, record)
+				Fluent::Engine.emit(tagd, time, record)
+			end
+			chain.next
+		end
+
+		def get_mapped_tag_to_out_keys(tag, time, record)
+			tags = tag.split('.')
+			@firstpoint.times do
+				tags.shift
+			end
+			tagdata = {}
+			key_end = nil
+			@out_keys.each do |key,value|
+				tagdata.store( key, tags.shift )
+				key_end = key
+			end
+			if !tags.empty?
+				tagdata[key_end] = tagdata[key_end] + '.' + tags.join('.')
+			end
+			tagdata.each do |key,value|
+				record[key] = value
+			end
+		end
+	end
+end

data/test/helper.rb

@@ -0,0 +1,32 @@
+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/out_tagdata'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_tagdata.rb

@@ -0,0 +1,89 @@
+require 'helper'
+
+class TagdataOutputTest < Test::Unit::TestCase
+	def setup
+		Fluent::Test.setup
+	end
+
+	DEFAULT_CONFIG = %[
+		out_keys server,protocol,domain
+		firstpoint 1
+		add_tag_prefix    filtered.
+		remove_tag_prefix example.
+	]
+
+	def create_driver(conf = DEFAULT_CONFIG, tag = 'example.straycat.http.www.example.com')
+		Fluent::Test::OutputTestDriver.new(Fluent::TagdataOutput, tag).configure(conf)
+	end
+
+	def test_configure
+		# when 'out_keys' is set
+		d = create_driver
+		assert_equal ["server","protocol","domain"], d.instance.out_keys
+		assert_equal 1,                              d.instance.firstpoint
+		assert_equal 'filtered.',                    d.instance.add_tag_prefix
+		assert_equal /^example\./,                   d.instance.remove_tag_prefix
+		
+		# when 'out_keys' not set
+		assert_raise(Fluent::ConfigError) do
+			create_driver(%[
+				add_tag_prefix    filtered.
+				remove_tag_prefix example.
+      ])
+    end
+
+		# when 'firstpoint' not positive number
+		assert_raise(Fluent::ConfigError) do
+			create_driver(%[
+				out_keys server,protocol,domain
+				firstpoint -1
+				add_tag_prefix    filtered.
+				remove_tag_prefix example.
+      ])
+    end
+	end
+
+	def test_filter_record
+		d = create_driver(DEFAULT_CONFIG)
+		tag = 'example.test'
+		record = { 'dummy' => 'dummy' }
+
+		d.instance.filter_record(tag,Time.now,record)
+
+		assert_equal 'filtered.test', tag
+	end
+
+	def test_emit
+		d = create_driver(DEFAULT_CONFIG)
+		time = Time.now.to_i
+		d.run do
+			d.emit( {
+				'host' => 'localhost',
+				'user' => '-',
+				'method' => 'GET',
+				'path' => '/sample.html',
+				'code' => '200',
+				'size' => '1234',
+				'referer' => '-',
+				'agent' => 'Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.22 (KHTML, like Gecko) Chrome/25.0.1364.172 Safari/537.22',
+				'response' => '1234567' },
+				time)
+		end
+		emits = d.emits
+
+		assert_equal 1, emits.count
+
+		assert_equal 'filtered.straycat.http.www.example.com', emits[0][0]
+		assert_equal time, emits[0][1]
+
+		assert_equal [
+			'host','user','method','path','code','size','referer','agent','response',
+			'server','protocol','domain'
+		], emits[0][2].keys
+
+		assert_equal 'straycat', emits[0][2]['server']
+		assert_equal 'http', emits[0][2]['protocol']
+		assert_equal 'www.example.com', emits[0][2]['domain']
+
+	end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-tagdata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fukui Masayuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 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: '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'
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin to put the tag records in the data.
+email:
+- msfukui@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-tagdata.gemspec
+- lib/fluent/plugin/out_tagdata.rb
+- test/helper.rb
+- test/plugin/test_out_tagdata.rb
+homepage: https://github.com/msfukui/fluent-plugin-tagdata
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to put the tag records in the data.
+test_files:
+- test/helper.rb
+- test/plugin/test_out_tagdata.rb