Class: OpenHAB::Logger
- Inherits:
-
Object
- Object
- OpenHAB::Logger
- Defined in:
- lib/openhab/log.rb
Overview
Ruby Logger that forwards messages at appropriate levels to openHAB Logger
Constant Summary collapse
- PREFIX =
The base prefix for all loggers from this gem.
"org.openhab.automation.jrubyscripting"
- LEVELS =
Returns Supported logging levels.
%i[trace debug warn info error].freeze
Instance Attribute Summary collapse
-
#level ⇒ :error, ...
The current log level.
Class Method Summary collapse
-
.events ⇒ Logger
The events logger (events.log).
-
.gem_root ⇒ Logger
The root logger for this gem.
-
.root ⇒ Logger
The root logger (all of openHAB).
Instance Method Summary collapse
-
#debug(msg = nil) { ... } ⇒ void
Log a message at debug level.
-
#debug? ⇒ true, false
If the logger is enabled at debug level.
-
#error(msg = nil) { ... } ⇒ void
Log a message at error level.
-
#error? ⇒ true, false
If the logger is enabled at error level.
-
#info(msg = nil) { ... } ⇒ void
Log a message at info level.
-
#info? ⇒ true, false
If the logger is enabled at info level.
- #inspect ⇒ String (also: #to_s)
-
#log_exception(exception) ⇒ void
Print error and stack trace without calls to internal classes.
-
#name ⇒ String
The logger name.
-
#trace(msg = nil) { ... } ⇒ void
Log a message at trace level.
-
#trace? ⇒ true, false
If the logger is enabled at trace level.
-
#warn(msg = nil) { ... } ⇒ void
Log a message at warn level.
-
#warn? ⇒ true, false
If the logger is enabled at warn level.
Instance Attribute Details
#level ⇒ :error, ...
When a logger's level is modified, the logging infrastructure has to reload, and logging may be completely unavailable for a short time.
Returns The current log level.
270 271 272 |
# File 'lib/openhab/log.rb', line 270 def level Logger.log_service.get_level(name)[name]&.downcase&.to_sym end |
Class Method Details
.events ⇒ Logger
The events logger (events.log)
186 187 188 |
# File 'lib/openhab/log.rb', line 186 def events Log.logger("openhab.event") end |
.gem_root ⇒ Logger
The root logger for this gem
180 181 182 |
# File 'lib/openhab/log.rb', line 180 def gem_root Log.logger(PREFIX) end |
.root ⇒ Logger
The root logger (all of openHAB)
174 175 176 |
# File 'lib/openhab/log.rb', line 174 def root Log.logger(org.slf4j.Logger::ROOT_LOGGER_NAME) end |
Instance Method Details
#debug(msg = nil) { ... } ⇒ void
This method returns an undefined value.
Log a message at debug level.
286 |
# File 'lib/openhab/log.rb', line 286 def_level_method(:debug) |
#debug? ⇒ true, false
If the logger is enabled at debug level.
287 |
# File 'lib/openhab/log.rb', line 287 def_level_predicate(:debug) |
#error(msg = nil) { ... } ⇒ void
This method returns an undefined value.
Log a message at error level.
280 |
# File 'lib/openhab/log.rb', line 280 def_level_method(:error) |
#error? ⇒ true, false
If the logger is enabled at error level.
281 |
# File 'lib/openhab/log.rb', line 281 def_level_predicate(:error) |
#info(msg = nil) { ... } ⇒ void
This method returns an undefined value.
Log a message at info level.
284 |
# File 'lib/openhab/log.rb', line 284 def_level_method(:info) |
#info? ⇒ true, false
If the logger is enabled at info level.
285 |
# File 'lib/openhab/log.rb', line 285 def_level_predicate(:info) |
#inspect ⇒ String Also known as: to_s
251 252 253 |
# File 'lib/openhab/log.rb', line 251 def inspect "#<OpenHAB::Logger #{name}>" end |
#log_exception(exception) ⇒ void
This method returns an undefined value.
Print error and stack trace without calls to internal classes
297 298 299 300 301 302 |
# File 'lib/openhab/log.rb', line 297 def log_exception(exception) exception = clean_backtrace(exception) error do "#{exception.message} (#{exception.class})\n#{exception.backtrace&.join("\n")}" end end |
#name ⇒ String
The logger name
246 247 248 |
# File 'lib/openhab/log.rb', line 246 def name @slf4j_logger.name end |
#trace(msg = nil) { ... } ⇒ void
This method returns an undefined value.
Log a message at trace level.
288 |
# File 'lib/openhab/log.rb', line 288 def_level_method(:trace) |
#trace? ⇒ true, false
If the logger is enabled at trace level.
289 |
# File 'lib/openhab/log.rb', line 289 def_level_predicate(:trace) |
#warn(msg = nil) { ... } ⇒ void
This method returns an undefined value.
Log a message at warn level.
282 |
# File 'lib/openhab/log.rb', line 282 def_level_method(:warn) |
#warn? ⇒ true, false
If the logger is enabled at warn level.
283 |
# File 'lib/openhab/log.rb', line 283 def_level_predicate(:warn) |