Class: Fluent::EngineClass

Inherits:
Object
  • Object
show all
Includes:
MessagePackFactory::Mixin
Defined in:
lib/fluent/engine.rb

Constant Summary collapse

MAINLOOP_SLEEP_INTERVAL = 
0.3
MATCH_CACHE_SIZE = 
1024
LOG_EMIT_INTERVAL = 
0.1

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MessagePackFactory::Mixin

#msgpack_factory, #msgpack_packer, #msgpack_unpacker

Constructor Details

#initialize ⇒ EngineClass

Returns a new instance of EngineClass.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/fluent/engine.rb', line 30

def initialize
  @root_agent = nil
  @default_loop = nil
  @engine_stopped = false
  @_worker_id = nil

  @log_event_router = nil
  @log_emit_thread = nil
  @log_event_loop_stop = false
  @log_event_loop_graceful_stop = false
  @log_event_queue = []
  @log_event_verbose = false

  @suppress_config_dump = false

  @system_config = SystemConfig.new

  @dry_run_mode = false
end

Instance Attribute Details

#dry_run_mode ⇒ Object

Returns the value of attribute dry_run_mode.



59
60
61
 
# File 'lib/fluent/engine.rb', line 59

def dry_run_mode
  @dry_run_mode
end

#matches ⇒ Object (readonly)

Returns the value of attribute matches.



56
57
58
 
# File 'lib/fluent/engine.rb', line 56

def matches
  @matches
end

#root_agent ⇒ Object (readonly)

Returns the value of attribute root_agent.



55
56
57
 
# File 'lib/fluent/engine.rb', line 55

def root_agent
  @root_agent
end

#sources ⇒ Object (readonly)

Returns the value of attribute sources.



56
57
58
 
# File 'lib/fluent/engine.rb', line 56

def sources
  @sources
end

#system_config ⇒ Object (readonly)

Returns the value of attribute system_config.



57
58
59
 
# File 'lib/fluent/engine.rb', line 57

def system_config
  @system_config
end

Instance Method Details

#add_plugin_dir(dir) ⇒ Object 



168
169
170
 
# File 'lib/fluent/engine.rb', line 168

def add_plugin_dir(dir)
  Plugin.add_plugin_dir(dir)
end

#configure(conf) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/fluent/engine.rb', line 125

def configure(conf)
  # plugins / configuration dumps
  Gem::Specification.find_all.select{|x| x.name =~ /^fluent(d|-(plugin|mixin)-.*)$/}.each do |spec|
    $log.info :worker0, "gem '#{spec.name}' version '#{spec.version}'"
  end

  @root_agent.configure(conf)

  begin
    log_event_agent = @root_agent.find_label(Fluent::Log::LOG_EVENT_LABEL)
    log_event_router = log_event_agent.event_router

    # suppress mismatched tags only for <label @FLUENT_LOG> label.
    # it's not suppressed in default event router for non-log-event events
    log_event_router.suppress_missing_match!

    @log_event_router = log_event_router

    unmatched_tags = Fluent::Log.event_tags.select{|t| !@log_event_router.match?(t) }
    unless unmatched_tags.empty?
      $log.warn "match for some tags of log events are not defined (to be ignored)", tags: unmatched_tags
    end
  rescue ArgumentError # ArgumentError "#{label_name} label not found"
    # use default event router if <label @FLUENT_LOG> is missing in configuration
    log_event_router = @root_agent.event_router

    if Fluent::Log.event_tags.any?{|t| log_event_router.match?(t) }
      @log_event_router = log_event_router

      unmatched_tags = Fluent::Log.event_tags.select{|t| !@log_event_router.match?(t) }
      unless unmatched_tags.empty?
        $log.warn "match for some tags of log events are not defined (to be ignored)", tags: unmatched_tags
      end
    end
  end

  $log.enable_event(true) if @log_event_router

  unless @suppress_config_dump
    $log.info :supervisor, "using configuration file: #{conf.to_s.rstrip}"
  end
end

#emit(tag, time, record) ⇒ Object 



172
173
174
 
# File 'lib/fluent/engine.rb', line 172

def emit(tag, time, record)
  raise "BUG: use router.emit instead of Engine.emit"
end

#emit_array(tag, array) ⇒ Object 



176
177
178
 
# File 'lib/fluent/engine.rb', line 176

def emit_array(tag, array)
  raise "BUG: use router.emit_array instead of Engine.emit_array"
end

#emit_stream(tag, es) ⇒ Object 



180
181
182
 
# File 'lib/fluent/engine.rb', line 180

def emit_stream(tag, es)
  raise "BUG: use router.emit_stream instead of Engine.emit_stream"
end

#flush! ⇒ Object 



184
185
186
 
# File 'lib/fluent/engine.rb', line 184

def flush!
  @root_agent.flush!
end

#init(system_config) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/fluent/engine.rb', line 61

def init(system_config)
  @system_config = system_config

  suppress_interval(system_config.emit_error_log_interval) unless system_config.emit_error_log_interval.nil?
  @suppress_config_dump = system_config.suppress_config_dump unless system_config.suppress_config_dump.nil?
  @without_source = system_config.without_source unless system_config.without_source.nil?

  @log_event_verbose = system_config.log_event_verbose unless system_config.log_event_verbose.nil?

  @root_agent = RootAgent.new(log: log, system_config: @system_config)

  MessagePackFactory.init

  self
end

#log ⇒ Object 



77
78
79
 
# File 'lib/fluent/engine.rb', line 77

def log
  $log
end

#log_event_loop ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/fluent/engine.rb', line 193

def log_event_loop
  $log.disable_events(Thread.current)

  while sleep(LOG_EMIT_INTERVAL)
    break if @log_event_loop_stop
    break if @log_event_loop_graceful_stop && @log_event_queue.empty?
    next if @log_event_queue.empty?

    # NOTE: thead-safe of slice! depends on GVL
    events = @log_event_queue.slice!(0..-1)
    next if events.empty?

    events.each {|tag,time,record|
      begin
        @log_event_router.emit(tag, time, record)
      rescue => e
        # This $log.error doesn't emit log events, because of `$log.disable_events(Thread.current)` above
        $log.error "failed to emit fluentd's log event", tag: tag, event: record, error: e
      end
    }
  end
end

#now ⇒ Object 



188
189
190
191
 
# File 'lib/fluent/engine.rb', line 188

def now
  # TODO thread update
  Fluent::EventTime.now
end

#parse_config(io, fname, basepath = Dir.pwd, v1_config = false) ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/fluent/engine.rb', line 86

def parse_config(io, fname, basepath = Dir.pwd, v1_config = false)
  if fname =~ /\.rb$/
    require 'fluent/config/dsl'
    Config::DSL::Parser.parse(io, File.join(basepath, fname))
  else
    Config.parse(io, fname, basepath, v1_config)
  end
end

#push_log_event(tag, time, record) ⇒ Object 



259
260
261
262
 
# File 'lib/fluent/engine.rb', line 259

def push_log_event(tag, time, record)
  return if @log_emit_thread.nil?
  @log_event_queue.push([tag, time, record])
end

#run ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/fluent/engine.rb', line 216

def run
  begin
    $log.info "starting fluentd worker", pid: Process.pid, ppid: Process.ppid, worker: worker_id
    start

    if @log_event_router
      $log.enable_event(true)
      @log_emit_thread = Thread.new(&method(:log_event_loop))
      @log_emit_thread.abort_on_exception = true
    end

    $log.info "fluentd worker is now running", worker: worker_id
    sleep MAINLOOP_SLEEP_INTERVAL until @engine_stopped
    $log.info "fluentd worker is now stopping", worker: worker_id

  rescue Exception => e
    $log.error "unexpected error", error: e
    $log.error_backtrace
    raise
  end

  unless @log_event_verbose
    $log.enable_event(false)
    if @log_emit_thread
      # to make sure to emit all log events into router, before shutting down
      @log_event_loop_graceful_stop = true
      @log_emit_thread.join
      @log_emit_thread = nil
    end
  end
  $log.info "shutting down fluentd worker", worker: worker_id
  shutdown
  if @log_emit_thread
    @log_event_loop_stop = true
    @log_emit_thread.join
  end
end

#run_configure(conf) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/fluent/engine.rb', line 95

def run_configure(conf)
  configure(conf)
  conf.check_not_fetched { |key, e|
    parent_name, plugin_name = e.unused_in
    if parent_name
      message = if plugin_name
                  "section <#{e.name}> is not used in <#{parent_name}> of #{plugin_name} plugin"
                else
                  "section <#{e.name}> is not used in <#{parent_name}>"
                end
      if e.for_every_workers?
        $log.warn :worker0, message
      elsif e.for_this_worker?
        $log.warn message
      end
      next
    end
    unless e.name == 'system'
      unless @without_source && e.name == 'source'
        message = "parameter '#{key}' in #{e.to_s.strip} is not used."
        if e.for_every_workers?
          $log.warn :worker0, message
        elsif e.for_this_worker?
          $log.warn message
        end
      end
    end
  }
end

#stop ⇒ Object 



254
255
256
257
 
# File 'lib/fluent/engine.rb', line 254

def stop
  @engine_stopped = true
  nil
end

#suppress_interval(interval_time) ⇒ Object 



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

def suppress_interval(interval_time)
  @suppress_emit_error_log_interval = interval_time
  @next_emit_error_log_time = Time.now.to_i
end

#worker_id ⇒ Object 



264
265
266
267
268
269
270
 
# File 'lib/fluent/engine.rb', line 264

def worker_id
  return @_worker_id if @_worker_id
  # if ENV doesn't have SERVERENGINE_WORKER_ID, it is a worker under --no-supervisor or in tests
  # so it's (almost) a single worker, worker_id=0
  @_worker_id = (ENV['SERVERENGINE_WORKER_ID'] || 0).to_i
  @_worker_id
end