class Fluent::Plugin::Base

Constants

State

Attributes

under_plugin_development[RW]

Public Class Methods

new() click to toggle source
Calls superclass method Fluent::Configurable::new
# File lib/fluent/plugin/base.rb, line 31
def initialize
  super
  @_state = State.new(false, false, false, false, false, false, false, false, false)
  @_context_router = nil
  @_fluentd_worker_id = nil
  @under_plugin_development = false
end

Public Instance Methods

after_shutdown() click to toggle source
# File lib/fluent/plugin/base.rb, line 105
def after_shutdown
  @_state.after_shutdown = true
  self
end
after_shutdown?() click to toggle source
# File lib/fluent/plugin/base.rb, line 144
def after_shutdown?
  @_state.after_shutdown
end
after_start() click to toggle source
# File lib/fluent/plugin/base.rb, line 85
def after_start
  @_state.after_start = true
  self
end
after_started?() click to toggle source
# File lib/fluent/plugin/base.rb, line 128
def after_started?
  @_state.after_start
end
before_shutdown() click to toggle source
# File lib/fluent/plugin/base.rb, line 95
def before_shutdown
  @_state.before_shutdown = true
  self
end
before_shutdown?() click to toggle source
# File lib/fluent/plugin/base.rb, line 136
def before_shutdown?
  @_state.before_shutdown
end
close() click to toggle source
# File lib/fluent/plugin/base.rb, line 110
def close
  @_state.close = true
  self
end
closed?() click to toggle source
# File lib/fluent/plugin/base.rb, line 148
def closed?
  @_state.close
end
configure(conf) click to toggle source
Calls superclass method Fluent::Configurable#configure
# File lib/fluent/plugin/base.rb, line 53
def configure(conf)
  super
  @_state ||= State.new(false, false, false, false, false, false, false, false, false)
  @_state.configure = true
  self
end
configured?() click to toggle source
# File lib/fluent/plugin/base.rb, line 120
def configured?
  @_state.configure
end
context_router() click to toggle source
# File lib/fluent/plugin/base.rb, line 76
def context_router
  @_context_router
end
context_router=(router) click to toggle source
# File lib/fluent/plugin/base.rb, line 72
def context_router=(router)
  @_context_router = router
end
fluentd_worker_id() click to toggle source
# File lib/fluent/plugin/base.rb, line 47
def fluentd_worker_id
  return @_fluentd_worker_id if @_fluentd_worker_id
  @_fluentd_worker_id = (ENV['SERVERENGINE_WORKER_ID'] || 0).to_i
  @_fluentd_worker_id
end
has_router?() click to toggle source
# File lib/fluent/plugin/base.rb, line 39
def has_router?
  false
end
inspect() click to toggle source
# File lib/fluent/plugin/base.rb, line 156
def inspect
  # Plugin instances are sometimes too big to dump because it may have too many thins (buffer,storage, ...)
  # Original commit comment says that:
  #   To emulate normal inspect behavior `ruby -e'o=Object.new;p o;p (o.__id__<<1).to_s(16)'`.
  #   https://github.com/ruby/ruby/blob/trunk/gc.c#L788
  "#<%s:%014x>" % [self.class.name, '0x%014x' % (__id__ << 1)]
end
multi_workers_ready?() click to toggle source
# File lib/fluent/plugin/base.rb, line 60
def multi_workers_ready?
  true
end
plugin_root_dir() click to toggle source
# File lib/fluent/plugin/base.rb, line 43
def plugin_root_dir
  nil # override this in plugin_id.rb
end
shutdown() click to toggle source
# File lib/fluent/plugin/base.rb, line 100
def shutdown
  @_state.shutdown = true
  self
end
shutdown?() click to toggle source
# File lib/fluent/plugin/base.rb, line 140
def shutdown?
  @_state.shutdown
end
start() click to toggle source
# File lib/fluent/plugin/base.rb, line 80
def start
  @_state.start = true
  self
end
started?() click to toggle source
# File lib/fluent/plugin/base.rb, line 124
def started?
  @_state.start
end
stop() click to toggle source
# File lib/fluent/plugin/base.rb, line 90
def stop
  @_state.stop = true
  self
end
stopped?() click to toggle source
# File lib/fluent/plugin/base.rb, line 132
def stopped?
  @_state.stop
end
string_safe_encoding(str) { |str| ... } click to toggle source
# File lib/fluent/plugin/base.rb, line 64
def string_safe_encoding(str)
  unless str.valid_encoding?
    log.info "invalid byte sequence is replaced in `#{str}`" if self.respond_to?(:log)
    str = str.scrub('?')
  end
  yield str
end
terminate() click to toggle source
# File lib/fluent/plugin/base.rb, line 115
def terminate
  @_state.terminate = true
  self
end
terminated?() click to toggle source
# File lib/fluent/plugin/base.rb, line 152
def terminated?
  @_state.terminate
end