Class: OpenC3::Logger

Inherits:
Object show all
Defined in:
lib/openc3/utilities/logger.rb

Overview

Supports different levels of logging and only writes if the level is exceeded.

Constant Summary collapse

DEBUG =

DEBUG only prints DEBUG messages

::Logger::DEBUG
INFO =

INFO prints INFO, DEBUG messages

::Logger::INFO
WARN =

WARN prints WARN, INFO, DEBUG messages

::Logger::WARN
ERROR =

ERROR prints ERROR, WARN, INFO, DEBUG messages

::Logger::ERROR
FATAL =

FATAL prints FATAL, ERROR, WARN, INFO, DEBUG messages

::Logger::FATAL
DEBUG_LEVEL = 
'DEBUG'
INFO_LEVEL = 
'INFO'
WARN_LEVEL = 
'WARN'
ERROR_LEVEL = 
'ERROR'
FATAL_LEVEL = 
'FATAL'
LOG =

Types

'log'
NOTIFICATION = 
'notification'
ALERT = 
'alert'
EPHEMERAL = 
'ephemeral'
@@mutex = 
Mutex.new
@@instance = 
nil
@@scope = 
ENV['OPENC3_SCOPE']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(level = Logger::INFO) ⇒ Logger

Returns a new instance of Logger.

Parameters:

  • level (Integer) (defaults to: Logger::INFO) —

    The initial logging level



76
77
78
79
80
81
82
83
 
# File 'lib/openc3/utilities/logger.rb', line 76

def initialize(level = Logger::INFO)
  @stdout = true
  @level = level
  @detail_string = nil
  @container_name = Socket.gethostname
  @microservice_name = nil
  @no_store = ENV['OPENC3_NO_STORE']
end

Instance Attribute Details

#microservice_name ⇒ String

Returns Microservice name.

Returns:

  • (String) —

    Microservice name



46
47
48
 
# File 'lib/openc3/utilities/logger.rb', line 46

def microservice_name
  @microservice_name
end

Class Method Details

.build_log_data(log_level, message, user: nil, type: nil, url: nil, other: nil) ⇒ Object 



195
196
197
 
# File 'lib/openc3/utilities/logger.rb', line 195

def self.build_log_data(log_level, message, user: nil, type: nil, url: nil, other: nil)
  self.instance.build_log_data(log_level, message, user: user, type: type, url: url, other: other)
end

.debug(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



127
128
129
 
# File 'lib/openc3/utilities/logger.rb', line 127

def self.debug(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  self.instance.debug(message, scope: scope, user: user, type: type, url: url, other: other, &block)
end

.error(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



142
143
144
 
# File 'lib/openc3/utilities/logger.rb', line 142

def self.error(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  self.instance.error(message, scope: scope, user: user, type: type, url: url, other: other, &block)
end

.fatal(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



147
148
149
 
# File 'lib/openc3/utilities/logger.rb', line 147

def self.fatal(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  self.instance.fatal(message, scope: scope, user: user, type: type, url: url, other: other, &block)
end

.info(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



132
133
134
 
# File 'lib/openc3/utilities/logger.rb', line 132

def self.info(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  self.instance.info(message, scope: scope, user: user, type: type, url: url, other: other, &block)
end

.instance ⇒ Logger

Returns The logger instance.

Returns:

  • (Logger) —

    The logger instance



152
153
154
155
156
157
158
159
 
# File 'lib/openc3/utilities/logger.rb', line 152

def self.instance
  return @@instance if @@instance

  @@mutex.synchronize do
    @@instance ||= self.new
  end
  @@instance
end

.microservice_name ⇒ Object 



90
91
92
 
# File 'lib/openc3/utilities/logger.rb', line 90

def self.microservice_name
  self.instance.microservice_name
end

.microservice_name=(name) ⇒ Object 



94
95
96
 
# File 'lib/openc3/utilities/logger.rb', line 94

def self.microservice_name=(name)
  self.instance.microservice_name = name
end

.scope ⇒ Object 



161
162
163
 
# File 'lib/openc3/utilities/logger.rb', line 161

def self.scope
  return @@scope
end

.scope=(scope) ⇒ Object 



165
166
167
 
# File 'lib/openc3/utilities/logger.rb', line 165

def self.scope=(scope)
  @@scope = scope
end

.warn(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



137
138
139
 
# File 'lib/openc3/utilities/logger.rb', line 137

def self.warn(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  self.instance.warn(message, scope: scope, user: user, type: type, url: url, other: other, &block)
end

Instance Method Details

#build_log_data(log_level, message, user: nil, type: nil, url: nil, other: nil, &block) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/openc3/utilities/logger.rb', line 177

def build_log_data(log_level, message, user: nil, type: nil, url: nil, other: nil, &block)
  time = Time.now.utc
  # timestamp iso8601 with 6 decimal places to match the python output format
  data = { time: time.to_nsec_from_epoch, '@timestamp' => time.iso8601(6), level: log_level }
  data[:microservice_name] = @microservice_name if @microservice_name
  data[:detail] = @detail_string if @detail_string
  data[:user] = user if user # Enterprise: If a user is passed, put its name. Don't include user data if no user was passed.
  if block_given?
    message = yield
  end
  data[:container_name] = @container_name
  data[:message] = message if message
  data[:type] = type if type
  data[:url] = url if url
  data = data.merge(other) if other
  return data
end

#debug(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



102
103
104
 
# File 'lib/openc3/utilities/logger.rb', line 102

def debug(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  log_message(DEBUG_LEVEL, message, scope: scope, user: user, type: type, url: url, other: other, &block) if @level <= DEBUG
end

#detail_string ⇒ String

Returns Additional detail to add to messages.

Returns:

  • (String) —

    Additional detail to add to messages



43
 
# File 'lib/openc3/utilities/logger.rb', line 43

instance_attr_accessor :detail_string

#error(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



117
118
119
 
# File 'lib/openc3/utilities/logger.rb', line 117

def error(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  log_message(ERROR_LEVEL, message, scope: scope, user: user, type: type, url: url, other: other, &block) if @level <= ERROR
end

#fatal(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



122
123
124
 
# File 'lib/openc3/utilities/logger.rb', line 122

def fatal(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  log_message(FATAL_LEVEL, message, scope: scope, user: user, type: type, url: url, other: other, &block) if @level <= FATAL
end

#info(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



107
108
109
 
# File 'lib/openc3/utilities/logger.rb', line 107

def info(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  log_message(INFO_LEVEL, message, scope: scope, user: user, type: type, url: url, other: other, &block) if @level <= INFO
end

#level ⇒ Integer

Returns The logging level.

Returns:

  • (Integer) —

    The logging level



40
 
# File 'lib/openc3/utilities/logger.rb', line 40

instance_attr_accessor :level

#scope ⇒ Object 



169
170
171
 
# File 'lib/openc3/utilities/logger.rb', line 169

def scope
  return @@scope
end

#scope=(scope) ⇒ Object 



173
174
175
 
# File 'lib/openc3/utilities/logger.rb', line 173

def scope=(scope)
  @@scope = scope
end

#stdout ⇒ Boolean

Returns Whether to output the message to stdout.

Returns:

  • (Boolean) —

    Whether to output the message to stdout



37
 
# File 'lib/openc3/utilities/logger.rb', line 37

instance_attr_accessor :stdout

#warn(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block) ⇒ Object

Parameters:

  • message (String) (defaults to: nil) —

    The message to print if the log level is at or below the method name log level.

  • block (Proc) —

    Block to call which should return a string to append to the log message



112
113
114
 
# File 'lib/openc3/utilities/logger.rb', line 112

def warn(message = nil, scope: @@scope, user: nil, type: LOG, url: nil, other: nil, &block)
  log_message(WARN_LEVEL, message, scope: scope, user: user, type: type, url: url, other: other, &block) if @level <= WARN
end