Class: Logster::Logger

Inherits:
Logger
  • Object
show all
Defined in:
lib/logster/logger.rb

Direct Known Subclasses

DeferLogger

Constant Summary collapse

LOGSTER_ENV = 
"logster_env"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(store) ⇒ Logger

Returns a new instance of Logger.



12
13
14
15
16
17
18
19
 
# File 'lib/logster/logger.rb', line 12

def initialize(store)
  super(nil)
  @store = store
  @chained = []
  @subscribers = []
  @skip_store = false
  @logster_override_level_key = "logster_override_level_#{object_id}"
end

Instance Attribute Details

#chained ⇒ Object (readonly)

Returns the value of attribute chained.



10
11
12
 
# File 'lib/logster/logger.rb', line 10

def chained
  @chained
end

#skip_store ⇒ Object

Returns the value of attribute skip_store.



9
10
11
 
# File 'lib/logster/logger.rb', line 9

def skip_store
  @skip_store
end

#store ⇒ Object

Returns the value of attribute store.



9
10
11
 
# File 'lib/logster/logger.rb', line 9

def store
  @store
end

Instance Method Details

#add(*args, &block) ⇒ Object 



59
60
61
 
# File 'lib/logster/logger.rb', line 59

def add(*args, &block)
  add_with_opts(*args, &block)
end

#add_to_chained(logger, severity, message, progname, opts = nil, &block) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/logster/logger.rb', line 44

def add_to_chained(logger, severity, message, progname, opts = nil, &block)
  if logger.respond_to? :skip_store
    old = logger.skip_store
    logger.skip_store = @skip_store
  end

  if logger.is_a?(Logster::Logger)
    logger.add(severity, message, progname, opts, &block)
  else
    logger.add(severity, message, progname, &block)
  end
ensure
  logger.skip_store = old if logger.respond_to? :skip_store
end

#add_with_opts(severity, message = nil, progname = progname(), opts = nil, &block) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
 
# File 'lib/logster/logger.rb', line 67

def add_with_opts(severity, message = nil, progname = progname(), opts = nil, &block)
  return true if severity < level

  # it is not fun losing messages cause encoding is bad
  # protect all messages by scrubbing if needed
  message = message.scrub if message && !message.valid_encoding?

  # we want to get the backtrace as early as possible so that logster's
  # own methods don't show up as the first few frames in the backtrace
  if !opts || !opts.key?(:backtrace)
    opts ||= {}
    backtrace = message.backtrace if message.kind_of?(::Exception)
    backtrace ||= progname.backtrace if progname.kind_of?(::Exception)
    if !backtrace
      backtrace = caller_locations
      backtrace.shift while backtrace.first.path.end_with?("/logger.rb")
    end
    backtrace = backtrace.join("\n")
    opts[:backtrace] = backtrace
  end

  notify_subscribers(severity, message, progname, opts, &block)
  add_to_chained_loggers(severity, message, progname, opts, &block)

  return if @skip_store

  progname ||= @progname
  if message.nil?
    if block_given?
      message = yield
    else
      message = progname
      progname = @progname
    end
  end

  message = formatter.call(severity, Time.now, progname, message) if formatter

  opts ||= {}
  opts[:env] ||= Thread.current[LOGSTER_ENV]

  report_to_store(severity, progname, message, opts)
rescue => e
  # don't blow up if STDERR is somehow closed
  begin
    STDERR.puts "Failed to report error: #{e} #{severity} #{message} #{progname}"
  rescue StandardError
    nil
  end
end

#chain(logger) ⇒ Object 



29
30
31
 
# File 'lib/logster/logger.rb', line 29

def chain(logger)
  @chained << logger
end

#level ⇒ Object 



63
64
65
 
# File 'lib/logster/logger.rb', line 63

def level
  Thread.current[@logster_override_level_key] || @level
end

#override_level ⇒ Object 



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

def override_level
  Thread.current[@logster_override_level_key]
end

#override_level=(val) ⇒ Object 



21
22
23
 
# File 'lib/logster/logger.rb', line 21

def override_level=(val)
  Thread.current[@logster_override_level_key] = val
end

#subscribe(&block) ⇒ Object

Subscribe to log events.

Example:

logger.subscribe do |severity, message, progname, opts, &block|
  YourCustomLogger.log(severity, message, progname, opts, &block)
end



40
41
42
 
# File 'lib/logster/logger.rb', line 40

def subscribe(&block)
  @subscribers << block
end