Class: Fluent::EventRouter

Inherits:
Object
  • Object
show all
Defined in:
lib/fluent/event_router.rb

Overview

EventRouter is responsible to route events to a collector.

It has a list of MatchPattern and Collector pairs:

+----------------+     +-----------------+
|  MatchPattern  |     |    Collector    |
+----------------+     +-----------------+
|   access.**  ---------> type forward   |
|     logs.**  ---------> type copy      |
|  archive.**  ---------> type s3        |
+----------------+     +-----------------+

EventRouter does:

1) receive an event at ‘#emit` methods 2) match the event’s tag with the MatchPatterns 3) forward the event to the corresponding Collector

Collector is either of Output, Filter or other EventRouter.

Defined Under Namespace

Classes: MatchCache, Pipeline, Rule

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default_collector, emit_error_handler) ⇒ EventRouter

Returns a new instance of EventRouter.



45
46
47
48
49
50
 
# File 'lib/fluent/event_router.rb', line 45

def initialize(default_collector, emit_error_handler)
  @match_rules = []
  @match_cache = MatchCache.new
  @default_collector = default_collector
  @emit_error_handler = emit_error_handler
end

Instance Attribute Details

#default_collector ⇒ Object

Returns the value of attribute default_collector.



52
53
54
 
# File 'lib/fluent/event_router.rb', line 52

def default_collector
  @default_collector
end

#emit_error_handler ⇒ Object

Returns the value of attribute emit_error_handler.



53
54
55
 
# File 'lib/fluent/event_router.rb', line 53

def emit_error_handler
  @emit_error_handler
end

Instance Method Details

#add_rule(pattern, collector) ⇒ Object

called by Agent to add new match pattern and collector



82
83
84
 
# File 'lib/fluent/event_router.rb', line 82

def add_rule(pattern, collector)
  @match_rules << Rule.new(pattern, collector)
end

#emit(tag, time, record) ⇒ Object 



86
87
88
89
90
 
# File 'lib/fluent/event_router.rb', line 86

def emit(tag, time, record)
  unless record.nil?
    emit_stream(tag, OneEventStream.new(time, record))
  end
end

#emit_array(tag, array) ⇒ Object 



92
93
94
 
# File 'lib/fluent/event_router.rb', line 92

def emit_array(tag, array)
  emit_stream(tag, ArrayEventStream.new(array))
end

#emit_error_event(tag, time, record, error) ⇒ Object 



102
103
104
 
# File 'lib/fluent/event_router.rb', line 102

def emit_error_event(tag, time, record, error)
  @emit_error_handler.emit_error_event(tag, time, record, error)
end

#emit_stream(tag, es) ⇒ Object 



96
97
98
99
100
 
# File 'lib/fluent/event_router.rb', line 96

def emit_stream(tag, es)
  match(tag).emit_events(tag, es)
rescue => e
  @emit_error_handler.handle_emits_error(tag, es, e)
end

#match(tag) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/fluent/event_router.rb', line 110

def match(tag)
  collector = @match_cache.get(tag) {
    find(tag) || @default_collector
  }
  collector
end

#match?(tag) ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/fluent/event_router.rb', line 106

def match?(tag)
  !!find(tag)
end

#suppress_missing_match! ⇒ Object 



75
76
77
78
79
 
# File 'lib/fluent/event_router.rb', line 75

def suppress_missing_match!
  if @default_collector.respond_to?(:suppress_missing_match!)
    @default_collector.suppress_missing_match!
  end
end