Contents

module Karafka
  # Default logger for Event Delegator
  # @note It uses ::Logger features - providing basic logging
  class Logger < ::Logger
    # Map containing informations about log level for given environment
    ENV_MAP = {
      'production' => ::Logger::ERROR,
      'test' => ::Logger::ERROR,
      'development' => ::Logger::INFO,
      'debug' => ::Logger::DEBUG,
      default: ::Logger::INFO
    }.freeze

    class << self
      # Returns a logger instance with appropriate settings, log level and environment
      def instance
        ensure_dir_exists
        instance = new(target)
        instance.level = ENV_MAP[Karafka.env] || ENV_MAP[:default]
        instance
      end

      private

      # @return [Karafka::Helpers::MultiDelegator] multi delegator instance
      #   to which we will be writtng logs
      # We use this approach to log stuff to file and to the STDOUT at the same time
      def target
        Karafka::Helpers::MultiDelegator
          .delegate(:write, :close)
          .to(STDOUT, file)
      end

      # Makes sure the log directory exists
      def ensure_dir_exists
        dir = File.dirname(log_path)
        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
      end

      # @return [Pathname] Path to a file to which we should log
      def log_path
        Karafka::App.root.join("log/#{Karafka.env}.log")
      end

      # @return [File] file to which we want to write our logs
      # @note File is being opened in append mode ('a')
      def file
        File.open(log_path, 'a')
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
karafka-0.5.0.3	lib/karafka/logger.rb
karafka-0.5.0.2	lib/karafka/logger.rb
karafka-0.5.0.1	lib/karafka/logger.rb
karafka-0.5.0	lib/karafka/logger.rb