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 = 
{
  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.



556
557
558
559
560
561
562
563
 
# File 'lib/kitchen/logger.rb', line 556

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.



554
555
556
 
# File 'lib/kitchen/logger.rb', line 554

def datetime_format
  @datetime_format
end

#level ⇒ Object

Returns the value of attribute level.



552
553
554
 
# File 'lib/kitchen/logger.rb', line 552

def level
  @level
end

#progname ⇒ Object

Returns the value of attribute progname.



553
554
555
 
# File 'lib/kitchen/logger.rb', line 553

def progname
  @progname
end

Instance Method Details

#<<(msg) ⇒ Object 



577
578
579
 
# File 'lib/kitchen/logger.rb', line 577

def <<(msg)
  line_buffer << msg
end

#add(severity, message = nil, progname = nil) ⇒ Object 



565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/kitchen/logger.rb', line 565

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
 


581
582
583
584
 
# File 'lib/kitchen/logger.rb', line 581

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

#close ⇒ Object 



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

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, &block) ⇒ Object 



591
592
593
 
# File 'lib/kitchen/logger.rb', line 591

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

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


615
616
617
 
# File 'lib/kitchen/logger.rb', line 615

def debug?
  level <= DEBUG
end

#error(msg = nil, &block) ⇒ Object 



603
604
605
 
# File 'lib/kitchen/logger.rb', line 603

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

#error? ⇒ Boolean

Returns:

  • (Boolean) 


627
628
629
 
# File 'lib/kitchen/logger.rb', line 627

def error?
  level <= ERROR
end

#fatal(msg = nil, &block) ⇒ Object 



607
608
609
 
# File 'lib/kitchen/logger.rb', line 607

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

#fatal? ⇒ Boolean

Returns:

  • (Boolean) 


631
632
633
 
# File 'lib/kitchen/logger.rb', line 631

def fatal?
  level <= FATAL
end

#info(msg = nil, &block) ⇒ Object 



595
596
597
 
# File 'lib/kitchen/logger.rb', line 595

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

#info? ⇒ Boolean

Returns:

  • (Boolean) 


619
620
621
 
# File 'lib/kitchen/logger.rb', line 619

def info?
  level <= INFO
end

#stream(severity, msg) ⇒ Object 



586
587
588
589
 
# File 'lib/kitchen/logger.rb', line 586

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

#unknown(msg = nil, &block) ⇒ Object 



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

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

#warn(msg = nil, &block) ⇒ Object 



599
600
601
 
# File 'lib/kitchen/logger.rb', line 599

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

#warn? ⇒ Boolean

Returns:

  • (Boolean) 


623
624
625
 
# File 'lib/kitchen/logger.rb', line 623

def warn?
  level <= WARN
end