Class: Steno::Sink::Base

Inherits:
Object show all
Defined in:
lib/steno/sink/base.rb

Overview

Sinks represent the final destination for log records. They abstract storage mediums (like files) and transport layers (like sockets).

Direct Known Subclasses

Counter, Fluentd, IO, Syslog

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(codec = nil) ⇒ Base

raw, string-based representation that will be written to the underlying sink.

Parameters:



17
18
19
 
# File 'lib/steno/sink/base.rb', line 17

def initialize(codec = nil)
  @codec = codec
end

Instance Attribute Details

#codec ⇒ Object

Returns the value of attribute codec.



12
13
14
 
# File 'lib/steno/sink/base.rb', line 12

def codec
  @codec
end

Instance Method Details

#add_record(record) ⇒ nil

Adds a record to be flushed at a later time.

Parameters:

  • record (Hash)

Returns:

  • (nil)

Raises:

  • (NotImplementedError) 


26
27
28
 
# File 'lib/steno/sink/base.rb', line 26

def add_record(record)
  raise NotImplementedError
end

#flush ⇒ nil

Flushes any buffered records.

Returns:

  • (nil)

Raises:

  • (NotImplementedError) 


33
34
35
 
# File 'lib/steno/sink/base.rb', line 33

def flush
  raise NotImplementedError
end