Class: LogStash::Codecs::Multiline

Inherits:
Base
  • Object
show all
Defined in:
lib/logstash/codecs/multiline.rb

Instance Method Summary collapse

Instance Method Details

#accept(listener) ⇒ Object

def register



174
175
176
177
178
179
180
181
 
# File 'lib/logstash/codecs/multiline.rb', line 174

def accept(listener)
  # memoize references to listener that holds upstream state
  @previous_listener = @last_seen_listener || listener
  @last_seen_listener = listener
  decode(listener.data) do |event|
    what_based_listener.process_event(event)
  end
end

#auto_flush ⇒ Object 



221
222
223
224
225
 
# File 'lib/logstash/codecs/multiline.rb', line 221

def auto_flush
  flush do |event|
    @last_seen_listener.process_event(event)
  end
end

#auto_flush_active? ⇒ Boolean

Returns:

  • (Boolean) 


283
284
285
 
# File 'lib/logstash/codecs/multiline.rb', line 283

def auto_flush_active?
  !@auto_flush_interval.nil?
end

#auto_flush_runner ⇒ Object 



287
288
289
 
# File 'lib/logstash/codecs/multiline.rb', line 287

def auto_flush_runner
  @auto_flush_runner || AutoFlushUnset.new(nil, nil)
end

#buffer(text) ⇒ Object

def decode



196
197
198
199
200
201
202
 
# File 'lib/logstash/codecs/multiline.rb', line 196

def buffer(text)
  @buffer_bytes += text.bytesize
  @buffer.push(text).tap do |b|
    # do start but preserve the return value
    auto_flush_runner.start
  end
end

#buffer_over_limits? ⇒ Boolean

Returns:

  • (Boolean) 


266
267
268
 
# File 'lib/logstash/codecs/multiline.rb', line 266

def buffer_over_limits?
  over_maximum_lines? || over_maximum_bytes?
end

#close ⇒ Object

def encode



275
276
277
278
279
280
281
 
# File 'lib/logstash/codecs/multiline.rb', line 275

def close
  if auto_flush_runner.pending?
    #will cancel task if necessary
    auto_flush_runner.stop
  end
  auto_flush
end

#decode(text, &block) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/logstash/codecs/multiline.rb', line 183

def decode(text, &block)
  text = @converter.convert(text)
  text.split("\n").each do |line|
    match = @grok.match(line)
    @logger.debug("Multiline", :pattern => @pattern, :text => line,
                  :match => !match.nil?, :negate => @negate)

    # Add negate option
    match = (match and !@negate) || (!match and @negate)
    @handler.call(line, match, &block)
  end
end

#do_next(text, matched, &block) ⇒ Object 



248
249
250
251
 
# File 'lib/logstash/codecs/multiline.rb', line 248

def do_next(text, matched, &block)
  buffer(text)
  flush(&block) if !matched || buffer_over_limits?
end

#do_previous(text, matched, &block) ⇒ Object 



253
254
255
256
 
# File 'lib/logstash/codecs/multiline.rb', line 253

def do_previous(text, matched, &block)
  flush(&block) if !matched || buffer_over_limits?
  buffer(text)
end

#doing_previous? ⇒ Boolean

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/logstash/codecs/multiline.rb', line 240

def doing_previous?
  @what == "previous"
end

#encode(event) ⇒ Object 



270
271
272
273
 
# File 'lib/logstash/codecs/multiline.rb', line 270

def encode(event)
  # Nothing to do.
  @on_event.call(event, event)
end

#flush(&block) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/logstash/codecs/multiline.rb', line 204

def flush(&block)
  if block_given? && @buffer.any?
    no_error = true
    events = merge_events
    begin
      yield events
    rescue ::Exception => e
      # need to rescue everything
      # likliest cause: backpressure or timeout by exception
      # can't really do anything but leave the data in the buffer for next time if there is one
      @logger.error("Multiline: flush downstream error", :exception => e)
      no_error = false
    end
    reset_buffer if no_error
  end
end

#merge_events ⇒ Object 



227
228
229
230
231
232
233
 
# File 'lib/logstash/codecs/multiline.rb', line 227

def merge_events
  event = LogStash::Event.new(LogStash::Event::TIMESTAMP => @time, "message" => @buffer.join(NL))
  event.tag @multiline_tag if @multiline_tag && @buffer.size > 1
  event.tag "multiline_codec_max_bytes_reached" if over_maximum_bytes?
  event.tag "multiline_codec_max_lines_reached" if over_maximum_lines?
  event
end

#over_maximum_bytes? ⇒ Boolean

Returns:

  • (Boolean) 


262
263
264
 
# File 'lib/logstash/codecs/multiline.rb', line 262

def over_maximum_bytes?
  @buffer_bytes >= @max_bytes
end

#over_maximum_lines? ⇒ Boolean

Returns:

  • (Boolean) 


258
259
260
 
# File 'lib/logstash/codecs/multiline.rb', line 258

def over_maximum_lines?
  @buffer.size > @max_lines
end

#register ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/logstash/codecs/multiline.rb', line 137

def register
  require "grok-pure" # rubygem 'jls-grok'
  require 'logstash/patterns/core'

  # Detect if we are running from a jarfile, pick the right path.
  patterns_path = []
  patterns_path += [LogStash::Patterns::Core.path]

  @grok = Grok.new

  @patterns_dir = patterns_path.to_a + @patterns_dir
  @patterns_dir.each do |path|
    if ::File.directory?(path)
      path = ::File.join(path, "*")
    end

    Dir.glob(path).each do |file|
      @logger.info("Grok loading patterns from file", :path => file)
      @grok.add_patterns_from_file(file)
    end
  end

  @grok.compile(@pattern)
  @logger.debug("Registered multiline plugin", :type => @type, :config => @config)

  reset_buffer

  @handler = method("do_#{@what}".to_sym)

  @converter = LogStash::Util::Charset.new(@charset)
  @converter.logger = @logger
  if @auto_flush_interval
    # will start on first decode
    @auto_flush_runner = AutoFlush.new(self, @auto_flush_interval)
  end
end

#reset_buffer ⇒ Object 



235
236
237
238
 
# File 'lib/logstash/codecs/multiline.rb', line 235

def reset_buffer
  @buffer = []
  @buffer_bytes = 0
end

#what_based_listener ⇒ Object 



244
245
246
 
# File 'lib/logstash/codecs/multiline.rb', line 244

def what_based_listener
  doing_previous? ? @previous_listener : @last_seen_listener
end