Class: Fluent::Config::Element

Inherits:
Hash
  • Object
show all
Defined in:
lib/fluent/config/element.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, arg, attrs, elements, unused = nil) ⇒ Element

Returns a new instance of Element.



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

def initialize(name, arg, attrs, elements, unused = nil)
  @name = name
  @arg = arg
  @elements = elements
  super()
  attrs.each { |k, v|
    self[k] = v
  }
  @unused = unused || attrs.keys
  @v1_config = false
  @corresponding_proxies = [] # some plugins use flat parameters, e.g. in_http doesn't provide <format> section for parser.
  @unused_in = false # if this element is not used in plugins, correspoing plugin name and parent element name is set, e.g. [source, plugin class].
end

Instance Attribute Details

#arg ⇒ Object

Returns the value of attribute arg.



37
38
39
 
# File 'lib/fluent/config/element.rb', line 37

def arg
  @arg
end

#corresponding_proxies ⇒ Object

Returns the value of attribute corresponding_proxies.



37
38
39
 
# File 'lib/fluent/config/element.rb', line 37

def corresponding_proxies
  @corresponding_proxies
end

#elements ⇒ Object

Returns the value of attribute elements.



37
38
39
 
# File 'lib/fluent/config/element.rb', line 37

def elements
  @elements
end

#name ⇒ Object

Returns the value of attribute name.



37
38
39
 
# File 'lib/fluent/config/element.rb', line 37

def name
  @name
end

#unused ⇒ Object

Returns the value of attribute unused.



37
38
39
 
# File 'lib/fluent/config/element.rb', line 37

def unused
  @unused
end

#unused_in ⇒ Object

Returns the value of attribute unused_in.



37
38
39
 
# File 'lib/fluent/config/element.rb', line 37

def unused_in
  @unused_in
end

#v1_config ⇒ Object

Returns the value of attribute v1_config.



37
38
39
 
# File 'lib/fluent/config/element.rb', line 37

def v1_config
  @v1_config
end

Class Method Details

.unescape_parameter(v) ⇒ Object 



147
148
149
150
151
 
# File 'lib/fluent/config/element.rb', line 147

def self.unescape_parameter(v)
  result = ''
  v.each_char { |c| result << LiteralParser.unescape_char(c) }
  result
end

Instance Method Details

#+(o) ⇒ Object 



60
61
62
63
64
 
# File 'lib/fluent/config/element.rb', line 60

def +(o)
  e = Element.new(@name.dup, @arg.dup, o.merge(self), @elements + o.elements, (@unused + o.unused).uniq)
  e.v1_config = @v1_config
  e
end

#==(o) ⇒ Object

This method assumes o is an Element object. Should return false for nil or other object



52
53
54
55
56
57
58
 
# File 'lib/fluent/config/element.rb', line 52

def ==(o)
  self.name == o.name && self.arg == o.arg &&
    self.keys.size == o.keys.size &&
    self.keys.reduce(true){|r, k| r && self[k] == o[k] } &&
    self.elements.size == o.elements.size &&
    [self.elements, o.elements].transpose.reduce(true){|r, e| r && e[0] == e[1] }
end

#[](key) ⇒ Object 



84
85
86
87
88
 
# File 'lib/fluent/config/element.rb', line 84

def [](key)
  @unused_in = false # ditto
  @unused.delete(key)
  super
end

#add_element(name, arg = '') ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/fluent/config/element.rb', line 39

def add_element(name, arg='')
  e = Element.new(name, arg, {}, [])
  e.v1_config = @v1_config
  @elements << e
  e
end

#check_not_fetched(&block) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/fluent/config/element.rb', line 90

def check_not_fetched(&block)
  each_key { |key|
    if @unused.include?(key)
      block.call(key, self)
    end
  }
  @elements.each { |e|
    e.check_not_fetched(&block)
  }
end

#each_element(*names, &block) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/fluent/config/element.rb', line 66

def each_element(*names, &block)
  if names.empty?
    @elements.each(&block)
  else
    @elements.each { |e|
      if names.include?(e.name)
        block.yield(e)
      end
    }
  end
end

#has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
81
82
 
# File 'lib/fluent/config/element.rb', line 78

def has_key?(key)
  @unused_in = false # some sections, e.g. <store> in copy, is not defined by config_section so clear unused flag for better warning message in chgeck_not_fetched.
  @unused.delete(key)
  super
end

#inspect ⇒ Object 



46
47
48
49
 
# File 'lib/fluent/config/element.rb', line 46

def inspect
  attrs = super
  "name:#{@name}, arg:#{@arg}, " + attrs + ", " + @elements.inspect
end

#secret_param?(key) ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/fluent/config/element.rb', line 133

def secret_param?(key)
  return false if @corresponding_proxies.empty?

  param_key = key.to_sym
  @corresponding_proxies.each { |proxy|
    block, opts = proxy.params[param_key]
    if opts && opts.has_key?(:secret)
      return opts[:secret]
    end
  }

  false
end

#to_masked_element ⇒ Object 



124
125
126
127
128
129
130
131
 
# File 'lib/fluent/config/element.rb', line 124

def to_masked_element
  new_elems = @elements.map { |e| e.to_masked_element }
  new_elem = Element.new(@name, @arg, {}, new_elems, @unused)
  each_pair { |k, v|
    new_elem[k] = secret_param?(k) ? 'xxxxxx' : v
  }
  new_elem
end

#to_s(nest = 0) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/fluent/config/element.rb', line 101

def to_s(nest = 0)
  indent = "  " * nest
  nindent = "  " * (nest + 1)
  out = ""
  if @arg.empty?
    out << "#{indent}<#{@name}>\n"
  else
    out << "#{indent}<#{@name} #{@arg}>\n"
  end
  each_pair { |k, v|
    if secret_param?(k)
      out << "#{nindent}#{k} xxxxxx\n"
    else
      out << "#{nindent}#{k} #{v}\n"
    end
  }
  @elements.each { |e|
    out << e.to_s(nest + 1)
  }
  out << "#{indent}</#{@name}>\n"
  out
end