├── .gitignore ├── .travis.yml ├── Gemfile ├── LICENSE ├── README.md ├── Rakefile ├── fluent-plugin-route.gemspec ├── lib └── fluent │ └── plugin │ └── out_route.rb └── test └── plugin └── test_out_route.rb /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | .bundle 4 | .config 5 | .yardoc 6 | Gemfile.lock 7 | InstalledFiles 8 | _yardoc 9 | coverage 10 | doc/ 11 | lib/bundler/man 12 | pkg 13 | rdoc 14 | spec/reports 15 | test/tmp 16 | test/version_tmp 17 | tmp 18 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 3 | - 2.1 4 | - 2.2 5 | - 2.3.1 6 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | # Specify your gem's dependencies in fluent-plugin-route.gemspec 4 | gemspec 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2011-2018 Fluentd Authors 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fluent-plugin-route 2 | 3 | [Fluentd](http://fluentd.org) output plugin to rewrite tags to route messages. 4 | 5 | ## Requirements 6 | 7 | | fluent-plugin-route | fluentd | ruby | 8 | |---------------------|------------|--------| 9 | | >= 1.0.0 | >= v0.14.0 | >= 2.1 | 10 | | < 1.0.0 | < v0.14.0 | >= 1.9 | 11 | 12 | ## Configuration 13 | 14 | ### Example 1: Use only tag 15 | 16 | 17 | @type route 18 | remove_tag_prefix worker 19 | 20 | add_tag_prefix metrics.event 21 | copy # For fall-through. Without copy, routing is stopped here. 22 | 23 | 24 | add_tag_prefix backup 25 | copy 26 | 27 | 28 | 29 | 30 | @type stdout 31 | 32 | 33 | 34 | @type file 35 | path /var/log/fluent/bakcup 36 | 37 | 38 | ### Example 2: Use label 39 | 40 | 41 | @type route 42 | remove_tag_prefix worker 43 | add_tag_prefix metrics.event 44 | 45 | copy 46 | 47 | 48 | copy 49 | @label @BACKUP 50 | 51 | 52 | 53 | 54 | @type stdout 55 | 56 | 57 | 63 | 64 | ## TODO 65 | 66 | * tests 67 | 68 | ## Copyright 69 | 70 | * Copyright 71 | * The [original version of `out_route`](https://github.com/frsyuki/fluent-plugin-route) is written by @frsyuki. 72 | * TAGOMORI Satoshi (tagomoris) 73 | * License 74 | * Apache License, Version 2.0 75 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env rake 2 | require "bundler/gem_tasks" 3 | 4 | require 'rake/testtask' 5 | Rake::TestTask.new(:test) do |test| 6 | test.libs << 'lib' << 'test' 7 | test.pattern = 'test/**/test_*.rb' 8 | test.verbose = true 9 | end 10 | 11 | task :default => :test 12 | -------------------------------------------------------------------------------- /fluent-plugin-route.gemspec: -------------------------------------------------------------------------------- 1 | Gem::Specification.new do |gem| 2 | gem.name = "fluent-plugin-route" 3 | gem.version = "1.0.0" 4 | gem.authors = ["TAGOMORI Satoshi", "FURUHASHI Sadayuki"] 5 | gem.email = ["tagomoris@gmail.com", "frsyuki@gmail.com"] 6 | gem.summary = %q{Fluentd plugin to route messages in fluentd processes} 7 | gem.description = %q{This is copy of out_route.rb originally written by frsyuki} 8 | gem.homepage = "https://github.com/tagomoris/fluent-plugin-route" 9 | gem.license = "Apache-2.0" 10 | 11 | gem.files = `git ls-files`.split($\) 12 | gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) } 13 | gem.test_files = gem.files.grep(%r{^(test|spec|features)/}) 14 | gem.require_paths = ["lib"] 15 | 16 | gem.add_runtime_dependency "fluentd", ">= 0.14.0" 17 | gem.add_development_dependency "rake" 18 | gem.add_development_dependency "test-unit" 19 | end 20 | -------------------------------------------------------------------------------- /lib/fluent/plugin/out_route.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Fluent 3 | # 4 | # Copyright (C) 2011 FURUHASHI Sadayuki 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | require 'fluent/plugin/bare_output' 19 | require 'fluent/match' 20 | 21 | module Fluent::Plugin 22 | class RouteOutput < BareOutput 23 | Fluent::Plugin.register_output('route', self) 24 | 25 | helpers :event_emitter 26 | 27 | config_section :route, param_name: :route_configs, multi: true, required: true do 28 | config_argument :pattern, :string, default: '**' 29 | config_param :@label, :string, default: nil 30 | config_param :remove_tag_prefix, :string, default: nil 31 | config_param :add_tag_prefix, :string, default: nil 32 | config_param :copy, :bool, default: false 33 | end 34 | 35 | config_param :remove_tag_prefix, :string, default: nil 36 | config_param :add_tag_prefix, :string, default: nil 37 | 38 | config_param :match_cache_size, :integer, default: 256 39 | config_param :tag_cache_size, :integer, default: 256 40 | 41 | attr_reader :routes 42 | 43 | def tag_modifier(remove_tag_prefix, add_tag_prefix) 44 | tag_cache_size = @tag_cache_size 45 | cache = {} 46 | mutex = Mutex.new 47 | removed_prefix = remove_tag_prefix ? remove_tag_prefix + "." : "" 48 | added_prefix = add_tag_prefix ? add_tag_prefix + "." : "" 49 | ->(tag){ 50 | if cached = cache[tag] 51 | cached 52 | else 53 | modified = tag.start_with?(removed_prefix) ? tag.sub(removed_prefix, added_prefix) : added_prefix + tag 54 | mutex.synchronize do 55 | if cache.size >= tag_cache_size 56 | remove_keys = cache.keys[0...(tag_cache_size / 2)] 57 | cache.delete_if{|key, _value| remove_keys.include?(key) } 58 | end 59 | cache[tag] = modified 60 | end 61 | modified 62 | end 63 | } 64 | end 65 | 66 | def configure(conf) 67 | if conf.elements(name: 'store').size > 0 68 | raise Fluent::ConfigError, " section is not available in route plugin" 69 | end 70 | 71 | super 72 | 73 | @match_cache = {} 74 | @routes = [] 75 | @route_configs.each do |rc| 76 | route_router = event_emitter_router(rc['@label']) 77 | modifier = tag_modifier(rc.remove_tag_prefix, rc.add_tag_prefix) 78 | @routes << Route.new(rc.pattern, route_router, modifier, rc.copy) 79 | end 80 | @default_tag_modifier = (@remove_tag_prefix || @add_tag_prefix) ? tag_modifier(@remove_tag_prefix, @add_tag_prefix) : nil 81 | @mutex = Mutex.new 82 | end 83 | 84 | class Route 85 | def initialize(pattern, router, tag_modifier, copy) 86 | @router = router 87 | @pattern = Fluent::MatchPattern.create(pattern) 88 | @tag_modifier = tag_modifier 89 | @copy = copy 90 | end 91 | 92 | def match?(tag) 93 | @pattern.match(tag) 94 | end 95 | 96 | def copy? 97 | @copy 98 | end 99 | 100 | def emit(tag, es) 101 | tag = @tag_modifier.call(tag) 102 | @router.emit_stream(tag, es) 103 | end 104 | end 105 | 106 | def process(tag, es) 107 | modified_tag, targets = @match_cache[tag] 108 | unless targets 109 | modified_tag = @default_tag_modifier ? @default_tag_modifier.call(tag) : tag 110 | targets = [] 111 | @routes.each do |r| 112 | if r.match?(modified_tag) 113 | targets << r 114 | break unless r.copy? 115 | end 116 | end 117 | 118 | @mutex.synchronize do 119 | if @match_cache.size >= @match_cache_size 120 | remove_keys = @match_cache.keys[0...(@match_cache_size / 2)] 121 | @match_cache.delete_if{|key, _value| remove_keys.include?(key) } 122 | end 123 | @match_cache[tag] = [modified_tag, targets] 124 | end 125 | end 126 | 127 | case targets.size 128 | when 0 129 | # do nothing 130 | when 1 131 | targets.first.emit(modified_tag, es) 132 | else 133 | targets.each do |target| 134 | dup_es = if es.respond_to?(:dup) 135 | es.dup 136 | else 137 | m_es = MultiEventStream.new 138 | es.each{|t,r| m_es.add(t, r) } 139 | m_es 140 | end 141 | target.emit(modified_tag, dup_es) 142 | end 143 | end 144 | end 145 | end 146 | end 147 | -------------------------------------------------------------------------------- /test/plugin/test_out_route.rb: -------------------------------------------------------------------------------- 1 | require 'fluent/plugin/out_route' 2 | 3 | require 'fluent/test' 4 | require 'fluent/test/driver/multi_output' 5 | require 'fluent/test/driver/event_feeder' 6 | 7 | require 'fluent/test/helpers' 8 | include Fluent::Test::Helpers 9 | 10 | class RouteOutputTest < Test::Unit::TestCase 11 | def setup 12 | Fluent::Test.setup 13 | end 14 | 15 | CONFIG = %[ 16 | remove_tag_prefix t 17 | 18 | remove_tag_prefix t1 19 | add_tag_prefix yay 20 | 21 | 22 | remove_tag_prefix t2 23 | add_tag_prefix foo 24 | 25 | 26 | @label @primary 27 | copy 28 | 29 | 30 | @label @backup 31 | 32 | ] 33 | 34 | def create_driver(conf) 35 | d = Fluent::Test::Driver::BaseOwner.new(Fluent::Plugin::RouteOutput) 36 | d.extend(Fluent::Test::Driver::EventFeeder) 37 | Fluent::Engine.root_agent.define_singleton_method(:find_label) do |label_name| 38 | obj = Object.new 39 | obj.define_singleton_method(:event_router){ d.instance.router } # for test... 40 | obj 41 | end 42 | d.configure(conf) 43 | end 44 | 45 | def test_configure 46 | # TODO: write 47 | end 48 | 49 | def test_emit_t1 50 | d = create_driver(CONFIG) 51 | 52 | time = event_time("2011-11-11 11:11:11 UTC") 53 | d.run(default_tag: "t.t1.test", expect_records: 2) do 54 | d.feed(time, {"a" => 1}) 55 | d.feed(time, {"a" => 2}) 56 | end 57 | 58 | events = d.events 59 | assert_equal 2, events.size 60 | 61 | assert_equal ["yay.test", time, {"a" => 1}], events[0] 62 | assert_equal ["yay.test", time, {"a" => 2}], events[1] 63 | end 64 | 65 | def test_emit_t2 66 | d = create_driver(CONFIG) 67 | 68 | time = event_time("2011-11-11 11:11:11 UTC") 69 | d.run(default_tag: "t.t2.test", expect_records: 2) do 70 | d.feed(time, {"a" => 1}) 71 | d.feed(time, {"a" => 2}) 72 | end 73 | 74 | events = d.events 75 | assert_equal 2, events.size 76 | 77 | assert_equal ["foo.test", time, {"a" => 1}], events[0] 78 | assert_equal ["foo.test", time, {"a" => 2}], events[1] 79 | end 80 | 81 | def test_emit_others 82 | d = create_driver(CONFIG) 83 | 84 | time = event_time("2011-11-11 11:11:11 UTC") 85 | d.run(default_tag: "t.t3.test", expect_records: 4) do 86 | d.feed(time, {"a" => 1}) 87 | d.feed(time, {"a" => 2}) 88 | end 89 | 90 | events = d.events 91 | assert_equal 4, events.size 92 | 93 | assert_equal ["t3.test", time, {"a" => 1}], events[0] 94 | assert_equal ["t3.test", time, {"a" => 1}], events[1] 95 | assert_equal ["t3.test", time, {"a" => 2}], events[2] 96 | assert_equal ["t3.test", time, {"a" => 2}], events[3] 97 | end 98 | end 99 | --------------------------------------------------------------------------------