Class: Hedgelog

Inherits:
Object
  • Object
show all
Defined in:
lib/hedgelog.rb,
lib/hedgelog/context.rb,
lib/hedgelog/version.rb,
lib/hedgelog/scrubber.rb,
lib/hedgelog/normalizer.rb,
lib/hedgelog/scrub_replacement.rb

Defined Under Namespace

Classes: Context, Normalizer, ScrubReplacement, Scrubber

Constant Summary collapse

LEVELS = 
%w[DEBUG INFO WARN ERROR FATAL UNKNOWN].each_with_object({}).with_index do |(v, h), i|
  h[v] = i
  h[v.downcase] = i
  h[v.to_sym] = i
  h[v.downcase.to_sym] = i
  h[i] = v.downcase.to_sym
end.freeze
TOP_LEVEL_KEYS = 
%i[app channel level level_name message request_id timestamp].freeze
RESERVED_KEYS = 
%i[app level level_name timestamp context caller].freeze
TIMESTAMP_FORMAT = 
'%Y-%m-%dT%H:%M:%S.%6N%z'
BACKTRACE_RE = 
Regexp.new("([^:]+):([0-9]+)(?::in `(.*)')?")
VERSION = 
'0.2.0'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(logdev = STDOUT, shift_age = nil, shift_size = nil, cleaner = nil) ⇒ Hedgelog

Returns a new instance of Hedgelog.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/hedgelog.rb', line 28

def initialize(logdev = STDOUT, shift_age = nil, shift_size = nil, cleaner=nil)
  @level = LEVELS[:debug]
  @channel = nil
  @logdev = nil
  @app = nil
  @scrubber = Hedgelog::Scrubber.new(cleaner)
  @normalizer = Hedgelog::Normalizer.new
  @channel_context = Hedgelog::Context.new(@scrubber, @normalizer)

  if logdev.is_a?(self.class)
    @channel = logdev
  else
    @logdev = Logger::LogDevice.new(logdev, shift_age: shift_age, shift_size: shift_size)
  end
end

Instance Attribute Details

#app=(value) ⇒ Object (writeonly)

Sets the attribute app

Parameters:

  • value —

    the value to set the attribute app to.



26
27
28
 
# File 'lib/hedgelog.rb', line 26

def app=(value)
  @app = value
end

#level ⇒ Object

Returns the value of attribute level.



25
26
27
 
# File 'lib/hedgelog.rb', line 25

def level
  @level
end

Instance Method Details

#[](key) ⇒ Object 



70
71
72
 
# File 'lib/hedgelog.rb', line 70

def [](key)
  @channel_context[key]
end

#[]=(key, val) ⇒ Object 



66
67
68
 
# File 'lib/hedgelog.rb', line 66

def []=(key, val)
  @channel_context[key] = val
end

#add(severity = , message = nil, progname = nil, context = {}, &block) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/hedgelog.rb', line 51

def add(severity = LEVELS[:unknown], message = nil, progname = nil, context = {}, &block)
  return true if (@logdev.nil? && @channel.nil?) || severity < @level

  message, context = *yield if block
  context ||= {}

  context = Hedgelog::Context.new(@scrubber, @normalizer, context) unless context.is_a? Hedgelog::Context
  context.merge!(@channel_context)
  context[:message] ||= message

  return write(severity, context) if @logdev

  @channel&.add(severity, nil, progname, context)
end

#channel(name) ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/hedgelog.rb', line 82

def channel(name)
  sc = self.class.new(self)
  sc.level = @level
  channel_name = name
  channel_name = "#{self[:channel]} => #{name}" if self[:channel]
  sc[:channel] = channel_name
  sc
end

#clear_channel_context ⇒ Object 



78
79
80
 
# File 'lib/hedgelog.rb', line 78

def clear_channel_context
  @channel_context = {}
end

#delete(key) ⇒ Object 



74
75
76
 
# File 'lib/hedgelog.rb', line 74

def delete(key)
  @channel_context.delete(key)
end

#formatter ⇒ Object 



119
120
121
 
# File 'lib/hedgelog.rb', line 119

def formatter
  ::Logger::Formatter.new
end

#formatter=(_value) ⇒ Object 



123
124
125
 
# File 'lib/hedgelog.rb', line 123

def formatter=(_value)
  formatter
end

#silence(temporary_level = ) ⇒ Object 



110
111
112
113
114
115
116
117
 
# File 'lib/hedgelog.rb', line 110

def silence(temporary_level = LEVELS[:error])
  old_level = level
  self.level = temporary_level

  yield self
ensure
  self.level = old_level
end