23s2s

✏️ Editing: colorize-logs

#!/opt/cpanel/ea-ruby27/root/usr/bin/ruby
require 'optparse'

RED = "\e[31m"
YELLOW = "\e[33m"
WHITE = "\e[37m"
BRIGHTWHITE = "\e[37;1m"
ORANGE = "\e[38;5;208m"
GREEN34 = "\e[38;5;34m"
GREEN48 = "\e[38;5;48m"
UNDERLINE = "\e[4m"
BOLD = "\e[1m"
RESET = "\e[0m"

TERMINATION_SIGNALS = [
  Signal.list['INT'],
  Signal.list['TERM'],
  Signal.list['HUP'],
]

def main
  STDOUT.sync = true
  STDERR.sync = true

options = parse_options(ARGV)

if should_use_pager?(options)
    # Pipe our output to 'less'. We *must* replace the current
    # process with 'less' (and move ourselves into the background),
    # instead of having 'less' run as a child process. This is
    # in order to properly handle signals sent to the entire
    # process group, such as when the user presses Ctrl-C.
    #
    # The problem with running 'less' as a child process is as follows:
    #
    # Imagine you're running the following pipeline in
    # bash:
    #
    #   tail -n 1000 -f nginx-error.log | ./dev/colorize-logs | less
    #
    # No problem here when we press Ctrl-C. Ctrl-C sends SIGINT to
    # the entire process group, so to all three processes. 'tail' and
    # 'colorize-logs' exit, while 'less' ignores the signal and keeps
    # running until you press 'q'.
    #
    # Now consider the following pipeline:
    #
    #  tail -n 1000 -f nginx-error.log | ./dev/colorize-logs
    #
    # Same thing, but colorize-logs spawns 'less'. Bash does not know
    # about it: it only waits for 'tail' and 'colorize-logs', not 'less'.
    # When you press Ctrl-C now, bash tries to take back control of the
    # terminal as soon as 'tail' and 'colorize-logs' exit. So although
    # 'less' ignores SIGINT, the fact that bash tries to take control
    # of the terminal breaks it.
    #
    # To avoid this scenario from happening, we inverse the process
    # hierarchy. We replace 'colorize-logs' with 'less' (through the use
    # of #exec) so that it's as if bash waits for 'tail' and 'less'.

a, b = IO.pipe

fork do
      begin
        a.close
        STDOUT.reopen(b)
        input = open_input(options)
        begin
          process_input(input)
        ensure
          kill_input_program(input)
        end
      rescue SignalException => e
        if TERMINATION_SIGNALS.include?(e.signo)
          # Stop upon receiving any of these signals.
          exit 1
        else
          raise e
        end
      rescue Errno::EPIPE
        # Stop when 'less' exits.
      rescue Exception => e
        STDERR.puts "#{e} (#{e.class})\n#{e.backtrace.join("\n")}"
      end
    end

STDIN.reopen(a)
    b.close
    exec('less', '-R')
  else
    input = open_input(options)
    begin
      process_input(input)
    rescue SignalException => e
      if TERMINATION_SIGNALS.include?(e.signo)
        # Stop upon receiving any of these signals.
        exit 1
      else
        raise e
      end
    rescue Errno::EPIPE
      # Ignore error when unable to write to piped program.
    ensure
      kill_input_program(input)
    end
  end
end

def parse_options(argv)
  options = {}

parser = OptionParser.new do |opts|
    opts.banner =
      "Usage 1: ./dev/colorize-logs [options] <filename>\n" \
      "Usage 2: some command | ./dev/colorize-logs [options]"

opts.separator ''
    opts.separator 'This is a tool for reading big Passenger log files,' \
      ' which can be hard to parse because they contain so much information.' \
      ' This tool colorizes the logs based on log level (error, warning,' \
      ' notice, debug, etc.) and type (LoggingKit vs app output), hopefully' \
      ' making it easier to read.'
    opts.separator ''
    opts.separator 'You can have it read a file (usage 1), or you can pipe' \
      ' data into it (usage 2).'
    opts.separator ''
    opts.separator "Output will automatically be displayed in 'less' if:" \
      " (1) running in a terminal, (2) a filename is given, and (3) -f is NOT given."
    opts.separator ''
    opts.separator 'Options:'

opts.on('-f', '--follow', "Follow given file (like 'tail -f'). Only applicable when given a filename") do
      options[:follow] = true
    end
    opts.on('-h', '--help', 'Display this help message') do
      options[:help] = true
    end
  end

begin
    parser.parse!(argv)
  rescue OptionParser::ParseError => e
    STDERR.puts e
    STDERR.puts
    STDERR.puts "Please see '--help' for valid options."
    exit 1
  end

if options[:help]
    puts parser
    exit
  end

if argv.size > 1
    STDERR.puts 'ERROR: too many filenames given.'
    STDERR.puts
    STDERR.puts "Please see '--help' for usage."
    exit 1
  end

if argv.size == 1 && argv[0] != '-'
    options[:filename] = argv[0]
  end

if options[:follow] && !options[:filename]
    STDERR.puts 'ERROR: --follow can only be used when given a filename.'
    STDERR.puts
    STDERR.puts "Please see '--help' for usage."
    exit 1
  end

options
end

def open_input(options)
  if options[:filename]
    if options[:follow]
      IO.popen([ 'tail', '-n', '0', '-f', options[:filename] ], 'r:utf-8')
    else
      File.open(options[:filename], 'r:utf-8')
    end
  else
    STDIN
  end
end

def kill_input_program(input)
  if input.pid
    begin
      Process.kill('TERM', input.pid)
    rescue Errno::ESRCH
      # Ignore error
    rescue SystemCallError => e
      STDERR.puts "WARNING: unable to kill 'tail -f' (PID #{input.pid}): #{e}"
    end
  end
end

def should_use_pager?(options)
  STDOUT.tty? && options[:filename] && !options[:follow]
end

def process_input(input)
  last_message_color = nil
  while !input.eof?
    line, last_message_color = colorize(input.readline.chomp, last_message_color)
    puts line
  end
end

def colorize(line, last_message_color)
  if line=~ /^\[ .+? \]: /
    colorize_loggingkit_line(line)
  elsif line =~ /^App [0-9]+ output: /
    colorize_app_output_line(line)
  else
    [ "#{last_message_color}#{line}#{RESET}", last_message_color ]
  end
end

def colorize_loggingkit_line(line)
  case line
  when /^\[ [CE]/
    prefix_color  = "\e[38;5;88m"
    message_color = RED
  when /^\[ W/
    prefix_color  = "\e[38;5;136m"
    message_color = YELLOW
  when /^\[ N/
    prefix_color  = "\e[38;5;250m"
    message_color = BRIGHTWHITE
  when /^\[ I/
    prefix_color  = "\e[38;5;246m"
    message_color = "\e[38;5;255m"
  when /^\[ D /
    prefix_color  = "\e[38;5;169m"
    message_color = "\e[38;5;213m"
  when /^\[ D2/
    prefix_color  = "\e[38;5;96m"
    message_color = "\e[38;5;132m"
  when /^\[ D3/
    prefix_color  = "\e[38;5;74m"
    message_color = "\e[38;5;117m"
  else
    prefix_color  = "\e[38;5;245m"
    message_color = RESET
  end

message_start_index = line.index(' ]: ') + 3
  prefix = line[0 .. message_start_index - 1]
  message = line[message_start_index + 1 .. -1]

if message =~ /^\[.+?\]/
    offset = Regexp.last_match.offset(0)
    subprefix = message[0 .. offset.last - 1]
    submessage = message[offset.last + 1 .. -1]

[ "#{prefix_color}#{prefix}#{RESET} #{UNDERLINE}#{message_color}#{subprefix}#{RESET} #{message_color}#{submessage}#{RESET}", message_color ]
  else
    [ "#{prefix_color}#{prefix}#{RESET} #{message_color}#{message}#{RESET}", message_color ]
  end
end

def colorize_app_output_line(line)
  message_start_index  = line.index(' output: ') + 8
  prefix = line[0 .. message_start_index - 1]
  message = line[message_start_index .. -1]

[ "#{GREEN34}#{prefix}#{RESET}#{GREEN48}#{message}#{RESET}", WHITE ]
end

main

Sid Gifari From Gifari Industries - BD Cyber Security Team