Class: Fluent::Plugin::MonitorAgentDetailInput

Inherits:
Input
  • Object
show all
Defined in:
lib/fluent/plugin/in_monitor_agent_detail.rb

Defined Under Namespace

Classes: ConfigMonitorServlet, JSONConfigMonitorServlet, JSONMonitorServlet, LTSVConfigMonitorServlet, LTSVMonitorServlet, MonitorServlet

Constant Summary collapse

MONITOR_INFO = 
{
  'output_plugin' => ->(){ is_a?(::Fluent::Plugin::Output) },
  'buffer_queue_length' => ->(){ throw(:skip) unless instance_variable_defined?(:@buffer) && !@buffer.nil? && @buffer.is_a?(::Fluent::Plugin::Buffer); @buffer.queue.size },
  'buffer_total_queued_size' => ->(){ throw(:skip) unless instance_variable_defined?(:@buffer) && !@buffer.nil? && @buffer.is_a?(::Fluent::Plugin::Buffer); @buffer.stage_size + @buffer.queue_size },
  'buffer_total_queued_ratio' => ->(){ throw(:skip) unless instance_variable_defined?(:@buffer) && !@buffer.nil? && @buffer.is_a?(::Fluent::Plugin::Buffer); ((@buffer.stage_size + @buffer.queue_size) / @buffer.total_limit_size.to_f).round(4) },
  'retry_count' => ->(){ instance_variable_defined?(:@num_errors) ? @num_errors : nil },
}
IGNORE_ATTRIBUTES = 
%i(@config_root_section @config @masked_config)
RETRY_INFO = 
{
    'start' => '@start',
    'steps' => '@steps',
    'next_time' => '@next_time',
}

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MonitorAgentDetailInput

Returns a new instance of MonitorAgentDetailInput.



220
221
222
223
224
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 220

def initialize
  super

  @first_warn = false
end

Instance Method Details

#all_plugins ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 284

def all_plugins
  array = []

  # get all input plugins
  array.concat Fluent::Engine.root_agent.inputs

  # get all output plugins
  array.concat Fluent::Engine.root_agent.outputs

  # get all filter plugins
  array.concat Fluent::Engine.root_agent.filters

  Fluent::Engine.root_agent.labels.each { |name, l|
    # TODO: Add label name to outputs / filters for identifing plugins
    array.concat l.outputs
    array.concat l.filters
  }

  array
end

#configure(conf) ⇒ Object 



226
227
228
229
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 226

def configure(conf)
  super
  @port += fluentd_worker_id
end

#fluentd_opts ⇒ Object 



433
434
435
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 433

def fluentd_opts
  @fluentd_opts ||= get_fluentd_opts
end

#get_fluentd_opts ⇒ Object 



437
438
439
440
441
442
443
444
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 437

def get_fluentd_opts
  opts = {}
  ObjectSpace.each_object(Fluent::Supervisor) { |obj|
    opts.merge!(obj.options)
    break
  }
  opts
end

#get_monitor_info(pe, opts = {}) ⇒ Object

get monitor info from the plugin ‘pe` and return a hash object



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 351

def get_monitor_info(pe, opts={})
  obj = {}

  # Common plugin information
  obj['plugin_id'] = pe.plugin_id
  obj['plugin_category'] = plugin_category(pe)
  obj['type'] = pe.config['@type']
  obj['config'] = pe.config if opts[:with_config]

  # run MONITOR_INFO in plugins' instance context and store the info to obj
  MONITOR_INFO.each_pair {|key,code|
    begin
      catch(:skip) do
        obj[key] = pe.instance_exec(&code)
      end
    rescue NoMethodError => e
      unless @first_warn
        log.error "NoMethodError in monitoring plugins", key: key, plugin: pe.class, error: e
        log.error_backtrace
        @first_warn = true
      end
    rescue => e
      log.warn "unexpected error in monitoring plugins", key: key, plugin: pe.class, error: e
    end
  }

  obj['retry'] = get_retry_info(pe.retry) if opts[:with_retry] and pe.instance_variable_defined?(:@retry)

  # include all instance variables if :with_debug_info is set
  if opts[:with_debug_info]
    iv = {}
    pe.instance_eval do
      instance_variables.each {|sym|
        next if IGNORE_ATTRIBUTES.include?(sym)
        key = sym.to_s[1..-1]  # removes first '@'
        iv[key] = instance_variable_get(sym)
      }
    end
    obj['instance_variables'] = iv
  elsif ivars = opts[:ivars]
    iv = {}
    ivars.each {|name|
      iname = "@#{name}"
      iv[name] = pe.instance_variable_get(iname) if pe.instance_variable_defined?(iname)
    }
    obj['instance_variables'] = iv
  end

  obj
end

#get_retry_info(pe_retry) ⇒ Object 



408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 408

def get_retry_info(pe_retry)
  retry_variables = {}

  if pe_retry
    RETRY_INFO.each_pair { |key, param|
      retry_variables[key] = pe_retry.instance_variable_get(param)
    }
  end

  retry_variables
end

#multi_workers_ready? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 231

def multi_workers_ready?
  true
end

#plugin_category(pe) ⇒ Object 



420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 420

def plugin_category(pe)
  case pe
  when Fluent::Plugin::Input
    'input'.freeze
  when Fluent::Plugin::Output, Fluent::Plugin::MultiOutput, Fluent::Plugin::BareOutput
    'output'.freeze
  when Fluent::Plugin::Filter
    'filter'.freeze
  else
    'unknown'.freeze
  end
end

#plugin_info_by_id(plugin_id, opts = {}) ⇒ Object

search a plugin by plugin_id



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 320

def plugin_info_by_id(plugin_id, opts={})
  found = all_plugins.find {|pe|
    pe.respond_to?(:plugin_id) && pe.plugin_id.to_s == plugin_id
  }
  if found
    get_monitor_info(found, opts)
  else
    nil
  end
end

#plugin_info_by_tag(tag, opts = {}) ⇒ Object

try to match the tag and get the info from the matched output plugin TODO: Support output in label



307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 307

def plugin_info_by_tag(tag, opts={})
  matches = Fluent::Engine.root_agent.event_router.instance_variable_get(:@match_rules)
  matches.each { |rule|
    if rule.match?(tag)
      if rule.collector.is_a?(Fluent::Plugin::Output) || rule.collector.is_a?(Fluent::Output)
        return get_monitor_info(rule.collector, opts)
      end
    end
  }
  nil
end

#plugins_info_all(opts = {}) ⇒ Object 



342
343
344
345
346
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 342

def plugins_info_all(opts={})
  all_plugins.map {|pe|
    get_monitor_info(pe, opts)
  }
end

#plugins_info_by_type(type, opts = {}) ⇒ Object

This method returns an array because multiple plugins could have the same type



333
334
335
336
337
338
339
340
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 333

def plugins_info_by_type(type, opts={})
  array = all_plugins.select {|pe|
    (pe.config['@type'] == type) rescue nil
  }
  array.map {|pe|
    get_monitor_info(pe, opts)
  }
end

#shutdown ⇒ Object 



267
268
269
270
271
272
273
274
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 267

def shutdown
  if @srv
    @srv.shutdown
    @srv = nil
  end

  super
end

#start ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/fluent/plugin/in_monitor_agent_detail.rb', line 235

def start
  super

  log.debug "listening monitoring http server on http://#{@bind}:#{@port}/api/plugins for worker#{fluentd_worker_id}"
  @srv = WEBrick::HTTPServer.new({
      BindAddress: @bind,
      Port: @port,
      Logger: WEBrick::Log.new(STDERR, WEBrick::Log::FATAL),
      AccessLog: [],
    })
  @srv.mount('/api/plugins', LTSVMonitorServlet, self)
  @srv.mount('/api/plugins.json', JSONMonitorServlet, self)
  @srv.mount('/api/config', LTSVConfigMonitorServlet, self)
  @srv.mount('/api/config.json', JSONConfigMonitorServlet, self)
  thread_create :in_monitor_agent_servlet do
    @srv.start
  end
  if @tag
    log.debug "tag parameter is specified. Emit plugins info to '#{@tag}'"

    opts = {with_config: false, with_retry: false}
    timer_execute(:in_monitor_agent_emit, @emit_interval, repeat: true) {
      es = Fluent::MultiEventStream.new
      now = Fluent::Engine.now
      plugins_info_all(opts).each { |record|
        es.add(now, record)
      }
      router.emit_stream(@tag, es)
    }
  end
end