fluent-plugin-time_parser 0.0.6 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 581b6c1bcc8546fb9c4de7e835100c3c4ccf8325
+  data.tar.gz: 54288fe1474709bbd11a2cdfa70b9b8e3575b8ac
+SHA512:
+  metadata.gz: 58171ffa45dada9b15dd4a2b53c25bff4144e7ff20e785991a3dc55dd7eeb3f44b3fa8760a502c8fce45c5fe47d5ba369c80c2b5481da993f2fe969f9bc3c530
+  data.tar.gz: 476cc0d39402b799ab0ef320e97792bb012f70056ce88b8dbe50c202e8eac3f2c72c0c5e0358ababfd003e9f8835941082d2669381385afcccf405096bc5ff98

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.5
+  - 2.4.2
+
+gemfile:
+ - Gemfile
+
+script: bundle exec rake test
+sudo: false

data/LICENSE

@@ -1,2 +1,2 @@
-Copyright (c) 2012 Kentaro Kuribayashi
+Copyright (c) 2017 Carlos Donderis
 Apache License, Version 2.0

data/README.md

@@ -1,4 +1,4 @@
-# fluent-plugin-time_parser
+# fluent-plugin-time_parser, a plugin for [Fluentd](http://fluentd.org)
 
 ## Component
 TimeParserOutput
@@ -13,7 +13,7 @@ Will take a time attribute and will extract the date and the hour for a given ti
   type time_parser
 
   key            time
-  add_tag_prefix extracted.
+  tag extracted.${tag}
   time_zone      Asia/Tokyo
 </match>
 ```
@@ -43,11 +43,13 @@ Then you'll get re-emmited tags/records like so:
 
 `key` is used to point a key whose value contains the time you want to parse.
 
-### remove_tag_prefix, remove_tag_suffix, add_tag_prefix, add_tag_suffix
+### tag
 
-These params are included from `Fluent::HandleTagNameMixin`. See the code for details.
+In this param, users can write placeholders.
 
-You must add at least one of these params.
+Please use placeholders ${tag}, ${tag[0]}, ${tag[1]} in configuration.
+
+Note that `Fluent::HandleTagNameMixin` dependency is removed in v0.14 style of this plugin.
 
 ### time_zone
 

data/fluent-plugin-time_parser.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |gem|
   gem.name          = 'fluent-plugin-time_parser'
-  gem.version       = '0.0.6'
-  gem.authors       = ['Carlos Donderis', 'Michael H. Oshita']
+  gem.version       = '0.1.0'
+  gem.authors       = ['Carlos Donderis', 'Michael H. Oshita', 'Hiroshi Hatake']
   gem.email         = ['cdonderis@gmail.com', 'ijinpublic+github@gmail.com']
   gem.homepage      = 'http://github.com/cads/fluent-plugin-time_parser'
   gem.description   = %q{Fluentd plugin to parse the time parameter.}
@@ -13,8 +13,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'fluentd'
   gem.add_development_dependency 'tzinfo'
+  gem.add_development_dependency 'test-unit', '~> 3.2'
   gem.add_runtime_dependency     'tzinfo'
-  gem.add_runtime_dependency     'fluentd'
+  gem.add_runtime_dependency     'fluentd', ['>= 0.14.0', '< 2']
 end

data/lib/fluent/plugin/out_time_parser.rb

@@ -1,27 +1,31 @@
 require 'time'
 require 'tzinfo'
+require 'fluent/plugin/output'
 
-module Fluent
+module Fluent::Plugin
   class TimeParserOutput < Output
-    include Fluent::HandleTagNameMixin
     Fluent::Plugin.register_output('time_parser', self)
 
+    helpers :event_emitter, :compat_parameters
+
+    DEFAULT_BUFFER_TYPE = "memory"
+
+    config_param :tag, :string
     config_param :key, :string, :default => 'time'
     config_param :time_zone, :string, :default => ''
     config_param :parsed_time_tag, :string, :default => 'parsed_time'
     config_param :parsed_hour_tag, :string, :default => 'parsed_hour'
     config_param :parsed_date_tag, :string, :default => 'parsed_date'
 
+    config_section :buffer do
+      config_set_default :@type, DEFAULT_BUFFER_TYPE
+      config_set_default :chunk_keys, ['tag']
+    end
+
     def configure(conf)
+      compat_parameters_convert(conf, :buffer)
       super
-      if (
-          !remove_tag_prefix &&
-          !remove_tag_suffix &&
-          !add_tag_prefix    &&
-          !add_tag_suffix
-      )
-        raise ConfigError, "out_extract_query_params: At least one of remove_tag_prefix/remove_tag_suffix/add_tag_prefix/add_tag_suffix is required to be set."
-      end
+      raise Fluent::ConfigError, "'tag' in chunk_keys is required." if not @chunk_key_tag
     end
 
     def start
@@ -32,13 +36,13 @@ module Fluent
       super
     end
 
-    def emit(tag, es, chain)
-      es.each {|time,record|
+    def write(chunk)
+      tag = extract_placeholders(@tag, chunk.metadata)
+      chunk.msgpack_each {|time,record|
         t = tag.dup
         filter_record(t, time, record)
-        Engine.emit(t, time, record)
+        router.emit(t, time, record)
       }
-      chain.next
     end
 
     def filter_record(tag, time, record)
@@ -63,11 +67,10 @@ module Fluent
         record[parsed_hour_tag] = hour
 
       rescue ArgumentError => error
-        $log.warn("out_extract_query_params: #{error.message}")
+        log.warn("out_extract_query_params: #{error.message}")
       rescue TZInfo::InvalidTimezoneIdentifier
-        $log.warn("Timezone Not Valid, please refer to http://tzinfo.rubyforge.org/doc/classes/TZInfo/Timezone.html for valid timezones")
+        log.warn("Timezone Not Valid, please refer to http://tzinfo.rubyforge.org/doc/classes/TZInfo/Timezone.html for valid timezones")
       end
-      super(tag, time, record)
     end
   end
 end

data/test/plugin/test_out_time_parser.rb

@@ -12,29 +12,29 @@ class TimeParserOutputTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  def create_driver(conf, tag = 'test')
-    Fluent::Test::OutputTestDriver.new(
-      Fluent::TimeParserOutput, tag
+  def create_driver(conf)
+    Fluent::Test::Driver::Output.new(
+      Fluent::Plugin::TimeParserOutput
     ).configure(conf)
   end
 
   def test_configure
     d = create_driver(%[
       key            test
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      Asia/Tokyo
     ])
     assert_equal 'test', d.instance.key
-    assert_equal 'extracted.', d.instance.add_tag_prefix
+    assert_equal 'extracted.${tag}', d.instance.tag
     assert_equal 'Asia/Tokyo',   d.instance.time_zone
 
     #Default Key
     d = create_driver(%[
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      Asia/Tokyo
     ])
     assert_equal 'time', d.instance.key
-    assert_equal 'extracted.', d.instance.add_tag_prefix
+    assert_equal 'extracted.${tag}', d.instance.tag
     assert_equal 'Asia/Tokyo',   d.instance.time_zone
 
     #No Prefix
@@ -47,16 +47,16 @@ class TimeParserOutputTest < Test::Unit::TestCase
     #No TimeZone
     d = create_driver(%[
       key            test
-      add_tag_prefix extracted.
+      tag extracted.${tag}
     ])
     assert_equal 'test', d.instance.key
-    assert_equal 'extracted.', d.instance.add_tag_prefix
+    assert_equal 'extracted.${tag}', d.instance.tag
   end
 
   def test_filter_record
     d = create_driver(%[
       key            time
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      Asia/Tokyo
     ])
     tag    = 'test'
@@ -72,7 +72,7 @@ class TimeParserOutputTest < Test::Unit::TestCase
   def test_girigiri_records
     d = create_driver(%[
       key            time
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      Japan
     ])
     tag    = 'test'
@@ -88,7 +88,7 @@ class TimeParserOutputTest < Test::Unit::TestCase
   def test_filter_record_bad_parameters
     d = create_driver(%[
       key            time
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      myPlace
     ])
     tag    = 'test'
@@ -109,31 +109,46 @@ class TimeParserOutputTest < Test::Unit::TestCase
   def test_emit
     d = create_driver(%[
       key            time
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      Asia/Tokyo
     ])
 
-    d.run { d.emit('time' => TIME) }
-    emits = d.emits
+    d.run(default_tag: 'test') { d.feed('time' => TIME) }
+    emits = d.events
 
     assert_equal 1, emits.count
     assert_equal 'extracted.test', emits[0][0]
     assert_equal TIME, emits[0][2]['time']
   end
 
+  def test_emit_without_tag_prefix
+    d = create_driver(%[
+      key            time
+      tag            ${tag[1]}
+      time_zone      Asia/Tokyo
+    ])
+
+    d.run(default_tag: 'removed.test') { d.feed('time' => TIME) }
+    emits = d.events
+
+    assert_equal 1, emits.count
+    assert_equal 'test', emits[0][0]
+    assert_equal TIME, emits[0][2]['time']
+  end
+
   def test_emit_multi
     d = create_driver(%[
       key            time
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      Asia/Tokyo
     ])
 
-    d.run do
-      d.emit('time' => TIME)
-      d.emit('time' => TIME)
-      d.emit('time' => TIME)
+    d.run(default_tag: 'test') do
+      d.feed('time' => TIME)
+      d.feed('time' => TIME)
+      d.feed('time' => TIME)
     end
-    emits = d.emits
+    emits = d.events
 
     assert_equal 3, emits.count
     0.upto(2) do |i|
@@ -145,12 +160,12 @@ class TimeParserOutputTest < Test::Unit::TestCase
   def test_emit_with_invalid_time
     d = create_driver(%[
       key            time
-      add_tag_prefix extracted.
+      tag extracted.${tag}
       time_zone      Asia/Tokyo
     ])
     wrong_time = 'wrong time'
-    d.run { d.emit('time' => wrong_time) }
-    emits = d.emits
+    d.run(default_tag: 'test') { d.feed('time' => wrong_time) }
+    emits = d.events
 
     assert_equal 1, emits.count
     assert_equal 'extracted.test', emits[0][0]

data/test/test_helper.rb

@@ -4,6 +4,8 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'fluent/test'
+require 'fluent/test/helpers'
+require 'fluent/test/driver/output'
 
 unless ENV.has_key?('VERBOSE')
   nulllogger = Object.new
@@ -18,4 +20,5 @@ end
 require 'fluent/plugin/out_time_parser'
 
 class Test::Unit::TestCase
+  include Fluent::Test::Helpers
 end

metadata

@@ -1,97 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-time_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Carlos Donderis
 - Michael H. Oshita
+- Hiroshi Hatake
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2017-09-20 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
+  name: tzinfo
   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: tzinfo
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   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'
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: Fluentd plugin to parse the time parameter.
 email:
 - cdonderis@gmail.com
@@ -100,7 +96,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -111,27 +108,26 @@ files:
 - test/test_helper.rb
 homepage: http://github.com/cads/fluent-plugin-time_parser
 licenses: []
+metadata: {}
 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.24
+rubygems_version: 2.6.13
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fluentd plugin to parse the time parameter.
 test_files:
 - test/plugin/test_out_time_parser.rb