Class: Prefab::LoggerClient

Inherits:
Logger
  • Object
show all
Defined in:
lib/prefab/logger_client.rb

Constant Summary collapse

SEP = 
'.'
BASE_KEY = 
'log-level'
UNKNOWN_PATH = 
'unknown.'
LOG_LEVEL_LOOKUPS = 
{
  PrefabProto::LogLevel::NOT_SET_LOG_LEVEL => ::Logger::DEBUG,
  PrefabProto::LogLevel::TRACE => ::Logger::DEBUG,
  PrefabProto::LogLevel::DEBUG => ::Logger::DEBUG,
  PrefabProto::LogLevel::INFO => ::Logger::INFO,
  PrefabProto::LogLevel::WARN => ::Logger::WARN,
  PrefabProto::LogLevel::ERROR => ::Logger::ERROR,
  PrefabProto::LogLevel::FATAL => ::Logger::FATAL
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(logdev, log_path_aggregator: nil, formatter: Options::DEFAULT_LOG_FORMATTER, prefix: nil) ⇒ LoggerClient

Returns a new instance of LoggerClient.



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/prefab/logger_client.rb', line 25

def initialize(logdev, log_path_aggregator: nil, formatter: Options::DEFAULT_LOG_FORMATTER, prefix: nil)
  super(logdev)
  self.formatter = formatter
  @config_client = BootstrappingConfigClient.new
  @silences = Concurrent::Map.new(initial_capacity: 2)
  @recurse_check = Concurrent::Map.new(initial_capacity: 2)
  @prefix = "#{prefix}#{prefix && '.'}"

  @context_keys = Concurrent::Set.new

  @log_path_aggregator = log_path_aggregator
  @@shared_instance = self
end

Instance Attribute Details

#context_keys ⇒ Object (readonly)

Returns the value of attribute context_keys.



23
24
25
 
# File 'lib/prefab/logger_client.rb', line 23

def context_keys
  @context_keys
end

Class Method Details

.instance ⇒ Object 



19
20
21
 
# File 'lib/prefab/logger_client.rb', line 19

def self.instance
  @@shared_instance ||= LoggerClient.new($stdout)
end

Instance Method Details

#add_context_keys(*keys) ⇒ Object 



39
40
41
 
# File 'lib/prefab/logger_client.rb', line 39

def add_context_keys(*keys)
  @context_keys += keys
end

#add_internal(severity, message, progname, loc, log_context = {}, &block) ⇒ Object

InternalLoggers Will Call This



55
56
57
58
59
60
 
# File 'lib/prefab/logger_client.rb', line 55

def add_internal(severity, message, progname, loc, log_context={}, &block)
  path_loc = get_loc_path(loc)
  path = @prefix + path_loc

  log(message, path, progname, severity, log_context, &block)
end

#config_client=(config_client) ⇒ Object 



139
140
141
 
# File 'lib/prefab/logger_client.rb', line 139

def config_client=(config_client)
  @config_client = config_client
end

#debug(progname = nil, **log_context, &block) ⇒ Object 



95
96
97
 
# File 'lib/prefab/logger_client.rb', line 95

def debug(progname = nil, **log_context, &block)
  add_internal(DEBUG, nil, progname, caller_locations(1, 1)[0], log_context, &block)
end

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/prefab/logger_client.rb', line 115

def debug?
  true
end

#error(progname = nil, **log_context, &block) ⇒ Object 



107
108
109
 
# File 'lib/prefab/logger_client.rb', line 107

def error(progname = nil, **log_context, &block)
  add_internal(ERROR, nil, progname, caller_locations(1, 1)[0], log_context, &block)
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/prefab/logger_client.rb', line 127

def error?
  true
end

#fatal(progname = nil, **log_context, &block) ⇒ Object 



111
112
113
 
# File 'lib/prefab/logger_client.rb', line 111

def fatal(progname = nil, **log_context, &block)
  add_internal(FATAL, nil, progname, caller_locations(1, 1)[0], log_context, &block)
end

#fatal? ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/prefab/logger_client.rb', line 131

def fatal?
  true
end

#info(progname = nil, **log_context, &block) ⇒ Object 



99
100
101
 
# File 'lib/prefab/logger_client.rb', line 99

def info(progname = nil, **log_context, &block)
  add_internal(INFO, nil, progname, caller_locations(1, 1)[0], log_context, &block)
end

#info? ⇒ Boolean

Returns:

  • (Boolean) 


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

def info?
  true
end

#internal_logger(path = nil) ⇒ Object 



50
51
52
 
# File 'lib/prefab/logger_client.rb', line 50

def internal_logger(path=nil)
  InternalLogger.new(path, self)
end

#level ⇒ Object 



135
136
137
 
# File 'lib/prefab/logger_client.rb', line 135

def level
  DEBUG
end

#local_log_id ⇒ Object 



143
144
145
 
# File 'lib/prefab/logger_client.rb', line 143

def local_log_id
  Thread.current.__id__
end

#log(message, path, progname, severity, log_context = {}) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/prefab/logger_client.rb', line 72

def log(message, path, progname, severity, log_context={})
  severity ||= ::Logger::UNKNOWN
  @log_path_aggregator&.push(path, severity)

  return true if @logdev.nil? || severity < level_of(path) || @silences[local_log_id]

  progname = @progname if progname.nil?

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

  @logdev.write(
    format_message(format_severity(severity), Time.now, progname, message, path, stringify_keys(log_context.merge(fetch_context_for_context_keys)))
  )
  true
end

#log_internal(severity, message, path, log_context = {}, &block) ⇒ Object 



62
63
64
65
66
67
68
69
70
 
# File 'lib/prefab/logger_client.rb', line 62

def log_internal(severity, message, path, log_context={}, &block)
  return if @recurse_check[local_log_id]
  @recurse_check[local_log_id] = true
  begin
    log(message, path, nil, severity, log_context, &block)
  ensure
    @recurse_check[local_log_id] = false
  end
end

#silence ⇒ Object 



147
148
149
150
151
152
 
# File 'lib/prefab/logger_client.rb', line 147

def silence
  @silences[local_log_id] = true
  yield self
ensure
  @silences[local_log_id] = false
end

#warn(progname = nil, **log_context, &block) ⇒ Object 



103
104
105
 
# File 'lib/prefab/logger_client.rb', line 103

def warn(progname = nil, **log_context, &block)
  add_internal(WARN, nil, progname, caller_locations(1, 1)[0], log_context, &block)
end

#warn? ⇒ Boolean

Returns:

  • (Boolean) 


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

def warn?
  true
end

#with_context_keys(*keys) ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/prefab/logger_client.rb', line 43

def with_context_keys(*keys)
  @context_keys += keys
  yield
ensure
  @context_keys -= keys
end