Class: Kitchen::Logger::StructuredLogdevLogger

Inherits:
Object
  • Object
show all
Includes:
Logger::Severity
Defined in:
lib/kitchen/logger.rb

Overview

Internal class that emits one JSON object per log event.

Constant Summary collapse

SEVERITY_NAMES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Maps stdlib Logger severity constants to their lowercase string names as they appear in emitted JSON events.

Returns:

  • (Hash{Integer => String}) —

    severity constant to name mapping

{
  DEBUG => "debug",
  INFO => "info",
  WARN => "warn",
  ERROR => "error",
  FATAL => "fatal",
  UNKNOWN => "unknown",
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(logdev, metadata_provider) ⇒ StructuredLogdevLogger

Returns a new instance of StructuredLogdevLogger.



613
614
615
616
617
618
619
620
 
# File 'lib/kitchen/logger.rb', line 613

def initialize(logdev, metadata_provider)
  @logdev = logdev
  @metadata_provider = metadata_provider
  @level = INFO
  @progname = "Kitchen"
  @sequence = 0
  @mutex = Mutex.new
end

Instance Attribute Details

#datetime_format ⇒ Object

Returns the value of attribute datetime_format.



611
612
613
 
# File 'lib/kitchen/logger.rb', line 611

def datetime_format
  @datetime_format
end

#level ⇒ Object

Returns the value of attribute level.



609
610
611
 
# File 'lib/kitchen/logger.rb', line 609

def level
  @level
end

#progname ⇒ Object

Returns the value of attribute progname.



610
611
612
 
# File 'lib/kitchen/logger.rb', line 610

def progname
  @progname
end

Instance Method Details

#<<(msg) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Appends raw stream output, emitting a structured event per complete line.

Parameters:

  • msg (String) —

    a chunk of stream output



651
652
653
 
# File 'lib/kitchen/logger.rb', line 651

def <<(msg)
  line_buffer << msg
end

#add(severity, message = nil, progname = nil) { ... } ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes a log event if the given severity meets the current level.

Parameters:

  • severity (Integer) —

    a stdlib Logger severity constant

  • message (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used, falling back to progname

  • progname (#to_s, nil) (defaults to: nil) —

    used as the message when both message and a block are absent

Yields:

  • evaluates to the message to log, only when the severity is high enough to be recorded

Returns:

  • (true) —

    always, once the event has been considered



633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/kitchen/logger.rb', line 633

def add(severity, message = nil, progname = nil)
  severity ||= UNKNOWN
  return true if severity < level

  message = if message.nil?
              block_given? ? yield : progname
            else
              message
            end
  write_event(severity, message, "log")
end

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Writes a banner event at info severity.

Parameters:

  • msg (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used

Yields:

  • evaluates to the message to log



662
663
664
665
 
# File 'lib/kitchen/logger.rb', line 662

def banner(msg = nil)
  message = block_given? ? yield : msg
  write_event(INFO, message, "banner") unless INFO < level
end

#close ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Closes the underlying log device if it is open and supports closing.



769
770
771
772
773
774
775
776
777
 
# File 'lib/kitchen/logger.rb', line 769

def close
  return unless @logdev.respond_to?(:close)

  if @logdev.respond_to?(:closed?)
    @logdev.close unless @logdev.closed?
  else
    @logdev.close
  end
end

#debug(msg = nil) { ... } ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes a log event at debug severity.

Parameters:

  • msg (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used

Yields:

  • evaluates to the message to log

Returns:

  • (true) 


686
687
688
 
# File 'lib/kitchen/logger.rb', line 686

def debug(msg = nil, &block)
  add(DEBUG, msg, nil, &block)
end

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


745
746
747
 
# File 'lib/kitchen/logger.rb', line 745

def debug?
  level <= DEBUG
end

#error(msg = nil) { ... } ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes a log event at error severity.

Parameters:

  • msg (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used

Yields:

  • evaluates to the message to log

Returns:

  • (true) 


719
720
721
 
# File 'lib/kitchen/logger.rb', line 719

def error(msg = nil, &block)
  add(ERROR, msg, nil, &block)
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 


757
758
759
 
# File 'lib/kitchen/logger.rb', line 757

def error?
  level <= ERROR
end

#fatal(msg = nil) { ... } ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes a log event at fatal severity.

Parameters:

  • msg (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used

Yields:

  • evaluates to the message to log

Returns:

  • (true) 


730
731
732
 
# File 'lib/kitchen/logger.rb', line 730

def fatal(msg = nil, &block)
  add(FATAL, msg, nil, &block)
end

#fatal? ⇒ Boolean

Returns:

  • (Boolean) 


761
762
763
 
# File 'lib/kitchen/logger.rb', line 761

def fatal?
  level <= FATAL
end

#info(msg = nil) { ... } ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes a log event at info severity.

Parameters:

  • msg (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used

Yields:

  • evaluates to the message to log

Returns:

  • (true) 


697
698
699
 
# File 'lib/kitchen/logger.rb', line 697

def info(msg = nil, &block)
  add(INFO, msg, nil, &block)
end

#info? ⇒ Boolean

Returns:

  • (Boolean) 


749
750
751
 
# File 'lib/kitchen/logger.rb', line 749

def info?
  level <= INFO
end

#stream(severity, msg) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Writes a stream event at the given severity.

Parameters:

  • severity (Integer, Symbol) —

    a stdlib Logger severity constant or its symbol name

  • msg (#to_s) —

    the message to log



674
675
676
677
 
# File 'lib/kitchen/logger.rb', line 674

def stream(severity, msg)
  severity = severity_const(severity)
  write_event(severity, msg, "stream") unless severity < level
end

#unknown(msg = nil) { ... } ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes a log event at unknown severity.

Parameters:

  • msg (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used

Yields:

  • evaluates to the message to log

Returns:

  • (true) 


741
742
743
 
# File 'lib/kitchen/logger.rb', line 741

def unknown(msg = nil, &block)
  add(UNKNOWN, msg, nil, &block)
end

#warn(msg = nil) { ... } ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes a log event at warn severity.

Parameters:

  • msg (#to_s, nil) (defaults to: nil) —

    the message to log; when nil the block's value is used

Yields:

  • evaluates to the message to log

Returns:

  • (true) 


708
709
710
 
# File 'lib/kitchen/logger.rb', line 708

def warn(msg = nil, &block)
  add(WARN, msg, nil, &block)
end

#warn? ⇒ Boolean

Returns:

  • (Boolean) 


753
754
755
 
# File 'lib/kitchen/logger.rb', line 753

def warn?
  level <= WARN
end