Class: Fluent::CalcOutput

Inherits:
Output
  • Object
show all
Defined in:
lib/fluent/plugin/out_calc.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CalcOutput

Returns a new instance of CalcOutput.



5
6
7
8
 
# File 'lib/fluent/plugin/out_calc.rb', line 5

def initialize
  super
  require 'pathname'
end

Instance Attribute Details

#last_checked ⇒ Object

Returns the value of attribute last_checked.



32
33
34
 
# File 'lib/fluent/plugin/out_calc.rb', line 32

def last_checked
  @last_checked
end

#matches ⇒ Object

Returns the value of attribute matches.



29
30
31
 
# File 'lib/fluent/plugin/out_calc.rb', line 29

def matches
  @matches
end

#saved_at ⇒ Object

Returns the value of attribute saved_at.



31
32
33
 
# File 'lib/fluent/plugin/out_calc.rb', line 31

def saved_at
  @saved_at
end

#saved_duration ⇒ Object

Returns the value of attribute saved_duration.



30
31
32
 
# File 'lib/fluent/plugin/out_calc.rb', line 30

def saved_duration
  @saved_duration
end

Instance Method Details

#configure(conf) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/fluent/plugin/out_calc.rb', line 34

def configure(conf)
  super

  @interval = @interval.to_i
  @sum = Regexp.new(@sum) if @sum
  @max = Regexp.new(@max) if @max
  @min = Regexp.new(@min) if @min
  @avg = Regexp.new(@avg) if @avg
  @sum_keys = @sum_keys ? @sum_keys.split(',') : []
  @max_keys = @max_keys ? @max_keys.split(',') : []
  @min_keys = @min_keys ? @min_keys.split(',') : []
  @avg_keys = @avg_keys ? @avg_keys.split(',') : []

  unless ['tag', 'all'].include?(@aggregate)
    raise Fluent::ConfigError, "aggregate allows tag/all"
  end

  case @aggregate
  when 'all'
    raise Fluent::ConfigError, "tag must be specified for aggregate all" if @tag.nil?
  end

  @matches = {}
  @mutex = Mutex.new
end

#emit(tag, es, chain) ⇒ Object

Called when new line comes. This method actually does not emit



92
93
94
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
124
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
 
# File 'lib/fluent/plugin/out_calc.rb', line 92

def emit(tag, es, chain)
  tag = 'all' if @aggregate == 'all'
  # calc
  matches = { :count => 0, :sum => {}, :max => {}, :min => {}, :avg => {} }
  es.each do |time, record|
    @sum_keys.each do |key|
      next unless record[key] and value = record[key].to_f
      matches[:sum][key] = sum(matches[:sum][key], value)
    end
    @max_keys.each do |key|
      next unless record[key] and value = record[key].to_f
      matches[:max][key] = max(matches[:max][key], value)
    end
    @min_keys.each do |key|
      next unless record[key] and value = record[key].to_f
      matches[:min][key] = min(matches[:min][key], value)
    end
    @avg_keys.each do |key|
      next unless record[key] and value = record[key].to_f
      matches[:avg][key] = sum(matches[:avg][key], value)
    end
    record.keys.each do |key|
      value = record[key].to_f
      if @sum and @sum.match(key)
        matches[:sum][key] = sum(matches[:sum][key], value)
      end
      if @max and @max.match(key)
        matches[:max][key] = max(matches[:max][key], value)
      end
      if @min and @min.match(key)
        matches[:min][key] = min(matches[:min][key], value)
      end
      if @avg and @avg.match(key)
        matches[:avg][key] = sum(matches[:avg][key], value) # sum yet
      end
    end if @sum || @max || @min || @avg
    matches[:count] += 1
  end

  # thread safe merge
  @matches[tag] ||= { :count => 0, :sum => {}, :max => {}, :min => {}, :avg => {} }
  @mutex.synchronize do
    matches[:sum].keys.each do |key|
      @matches[tag][:sum][key] = sum(@matches[tag][:sum][key], matches[:sum][key])
    end
    matches[:max].keys.each do |key|
      @matches[tag][:max][key] = max(@matches[tag][:max][key], matches[:max][key])
    end
    matches[:min].keys.each do |key|
      @matches[tag][:min][key] = min(@matches[tag][:min][key], matches[:min][key])
    end
    matches[:avg].keys.each do |key|
      @matches[tag][:avg][key] = sum(@matches[tag][:avg][key], matches[:avg][key]) # sum yet
    end
    @matches[tag][:count] += matches[:count]
  end

  chain.next
rescue => e
  $log.warn "#{e.class} #{e.message} #{e.backtrace.first}"
end

#flush_emit(step) ⇒ Object

This method is the real one to emit



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/fluent/plugin/out_calc.rb', line 173

def flush_emit(step)
  time = Fluent::Engine.now
  flushed_matches, @matches = @matches, initial_matches(@matches)

  flushed_matches.keys.each do |tag|
    matches = flushed_matches[tag]
    output = generate_output(matches)
    tag = @tag ? @tag : "#{@add_tag_prefix}.#{tag}"
    Fluent::Engine.emit(tag, time, output) if output
  end
end

#generate_output(matches) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/fluent/plugin/out_calc.rb', line 185

def generate_output(matches)
  return nil if matches.empty?
  output = {}
  matches[:sum].keys.each do |key|
    output[key + @sum_suffix] = matches[:sum][key]
  end
  matches[:max].keys.each do |key|
    output[key + @max_suffix] = matches[:max][key]
  end
  matches[:min].keys.each do |key|
    output[key + @min_suffix] = matches[:min][key]
  end
  matches[:avg].keys.each do |key|
    output[key + @avg_suffix] = matches[:avg][key]
    output[key + @avg_suffix] /= matches[:count].to_f if matches[:count] > 0
  end
  output
end

#initial_matches(prev_matches = nil) ⇒ Object 



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

def initial_matches(prev_matches = nil)
  if @zero_emit && prev_matches
    matches = {}
    prev_matches.keys.each do |tag|
      next unless prev_matches[tag][:count] > 0 # Prohibit to emit anymore
      matches[tag] = { :count => 0, :sum => {}, :max => {}, :min => {}, :avg => {} }
      # ToDo: would want default configuration for :max, :min
      prev_matches[tag][:sum].keys.each {|key| matches[tag][:sum][key] = 0 }
      prev_matches[tag][:max].keys.each {|key| matches[tag][:max][key] = 0 }
      prev_matches[tag][:min].keys.each {|key| matches[tag][:min][key] = 0 }
      prev_matches[tag][:avg].keys.each {|key| matches[tag][:avg][key] = 0 }
    end
    matches
  else
    {}
  end
end

#load_status(file_path, interval) ⇒ Object

Load internal status from a file

Parameters:

  • file_path (String)
  • interval (Interger) 


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/fluent/plugin/out_calc.rb', line 246

def load_status(file_path, interval)
  return unless (f = Pathname.new(file_path)).exist?

  begin
    f.open('rb') do |f|
      stored = Marshal.load(f)
      if stored[:aggregate] == @aggregate and
        stored[:sum] == @sum and
        stored[:max] == @max and
        stored[:min] == @min and
        stored[:avg] == @avg

        if !stored[:matches].empty? and !stored[:matches].first[1].has_key?(:max)
          $log.warn "out_calc: stored data does not have compatibility with the current version. ignore stored data"
          return
        end

        if Fluent::Engine.now <= stored[:saved_at] + interval
          @matches = stored[:matches]
          @saved_at = stored[:saved_at]
          @saved_duration = stored[:saved_duration]
          # for lower compatibility
          if counts = stored[:counts]
            @matches.keys.each {|tag| @matches[tag][:count] = counts[tag] }
          end

          # skip the saved duration to continue counting
          @last_checked = Fluent::Engine.now - @saved_duration
        else
          $log.warn "out_calc: stored data is outdated. ignore stored data"
        end
      else
        $log.warn "out_calc: configuration param was changed. ignore stored data"
      end
    end
  rescue => e
    $log.warn "out_calc: Can't load store_file #{e.class} #{e.message}"
  end
end

#max(a, b) ⇒ Object 



208
209
210
 
# File 'lib/fluent/plugin/out_calc.rb', line 208

def max(a, b)
  [a, b].compact.max
end

#min(a, b) ⇒ Object 



212
213
214
 
# File 'lib/fluent/plugin/out_calc.rb', line 212

def min(a, b)
  [a, b].compact.min
end

#save_status(file_path) ⇒ Object

Store internal status into a file

Parameters:

  • file_path (String) 


219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/fluent/plugin/out_calc.rb', line 219

def save_status(file_path)
  return unless file_path

  begin
    Pathname.new(file_path).open('wb') do |f|
      @saved_at = Fluent::Engine.now
      @saved_duration = @saved_at - @last_checked
      Marshal.dump({
        :matches          => @matches,
        :saved_at         => @saved_at,
        :saved_duration   => @saved_duration,
        :aggregate        => @aggregate,
        :sum              => @sum,
        :max              => @max,
        :min              => @min,
        :avg              => @avg,
      }, f)
    end
  rescue => e
    $log.warn "out_calc: Can't write store_file #{e.class} #{e.message}"
  end
end

#shutdown ⇒ Object 



84
85
86
87
88
89
 
# File 'lib/fluent/plugin/out_calc.rb', line 84

def shutdown
  super
  @watcher.terminate
  @watcher.join
  save_status(@store_file) if @store_file
end

#start ⇒ Object 



78
79
80
81
82
 
# File 'lib/fluent/plugin/out_calc.rb', line 78

def start
  super
  load_status(@store_file, @interval) if @store_file
  @watcher = Thread.new(&method(:watcher))
end

#sum(a, b) ⇒ Object 



204
205
206
 
# File 'lib/fluent/plugin/out_calc.rb', line 204

def sum(a, b)
  [a, b].compact.inject(:+)
end

#watcher ⇒ Object

thread callback



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/fluent/plugin/out_calc.rb', line 155

def watcher
  # instance variable, and public accessable, for test
  @last_checked ||= Fluent::Engine.now
  while true
    sleep 0.5
    begin
      if Fluent::Engine.now - @last_checked >= @interval
        now = Fluent::Engine.now
        flush_emit(now - @last_checked)
        @last_checked = now
      end
    rescue => e
      $log.warn "#{e.class} #{e.message} #{e.backtrace.first}"
    end
  end
end