Module: Fluent::PluginId

Included in:
Fluent::Plugin::BareOutput, Fluent::Plugin::Filter, Fluent::Plugin::Input, Fluent::Plugin::MultiOutput, Fluent::Plugin::Output, Test::Driver::OwnerDummy
Defined in:
lib/fluent/plugin_id.rb

Constant Summary collapse

@@configured_ids = 
Set.new

Instance Method Summary collapse

Instance Method Details

#configure(conf) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/fluent/plugin_id.rb', line 23

def configure(conf)
  @id = conf['@id']
  @_id_configured = !!@id # plugin id is explicitly configured by users (or not)
  if @id
    @id = @id.to_s
    if @@configured_ids.include?(@id) && !plugin_id_for_test?
      raise Fluent::ConfigError, "Duplicated plugin id `#{@id}`. Check whole configuration and fix it."
    end
    @@configured_ids.add(@id)
  end

  super
end

#plugin_id ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/fluent/plugin_id.rb', line 55

def plugin_id
  if instance_variable_defined?("@id")
    @id || "object:#{object_id.to_s(16)}"
  else
    "object:#{object_id.to_s(16)}"
  end
end

#plugin_id_configured? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
52
53
 
# File 'lib/fluent/plugin_id.rb', line 49

def plugin_id_configured?
  if instance_variable_defined?("@_id_configured")
    @_id_configured
  end
end

#plugin_id_for_test? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/fluent/plugin_id.rb', line 37

def plugin_id_for_test?
  caller_locations.each do |location|
    # Thread::Backtrace::Location#path returns base filename or absolute path.
    # #absolute_path returns absolute_path always.
    # https://bugs.ruby-lang.org/issues/12159
    if location.absolute_path =~ /\/test_[^\/]+\.rb$/ # location.path =~ /test_.+\.rb$/
      return true
    end
  end
  false
end