fluentd 0.12.40 → 1.6.2

data/lib/fluent/log.rb

@@ -15,6 +15,7 @@
 #
 
 require 'forwardable'
+require 'logger'
 
 module Fluent
   class Log
@@ -41,6 +42,14 @@ module Fluent
 
     LEVEL_TEXT = %w(trace debug info warn error fatal)
 
+    LOG_EVENT_TAG_PREFIX = 'fluent'
+    LOG_EVENT_LABEL = '@FLUENT_LOG'
+    LOG_TYPE_SUPERVISOR = :supervisor # only in supervisor, or a worker with --no-supervisor
+    LOG_TYPE_WORKER0 = :worker0 # only in a worker with worker_id=0 (without showing worker id)
+    LOG_TYPE_DEFAULT = :default # show logs in all supervisor/workers, with worker id in workers (default)
+
+    LOG_TYPES = [LOG_TYPE_SUPERVISOR, LOG_TYPE_WORKER0, LOG_TYPE_DEFAULT].freeze
+
     def self.str_to_level(log_level_str)
       case log_level_str.downcase
       when "trace" then LEVEL_TRACE
@@ -53,30 +62,146 @@ module Fluent
       end
     end
 
-    def initialize(out=STDERR, level=LEVEL_TRACE, opts={})
-      @out = out
-      @level = level
+    def self.event_tags
+      LEVEL_TEXT.map{|t| "#{LOG_EVENT_TAG_PREFIX}.#{t}" }
+    end
+
+    def initialize(logger, opts={})
+      # overwrites logger.level= so that config reloading resets level of Fluentd::Log
+      orig_logger_level_setter = logger.class.public_instance_method(:level=).bind(logger)
+      me = self
+      # The original ruby logger sets the number as each log level like below.
+      # DEBUG = 0
+      # INFO  = 1
+      # WARN  = 2
+      # ERROR = 3
+      # FATAL = 4
+      # Serverengine use this original log number. In addition to this, serverengine sets -1 as TRACE level.
+      # TRACE = -1
+      #
+      # On the other hand, in fluentd side, it sets the number like below.
+      # TRACE = 0
+      # DEBUG = 1
+      # INFO  = 2
+      # WARN  = 3
+      # ERROR = 4
+      # FATAL = 5
+      #
+      # Then fluentd's level is set as serverengine's level + 1.
+      # So if serverengine's logger level is changed, fluentd's log level will be changed to that + 1.
+      logger.define_singleton_method(:level=) {|level| orig_logger_level_setter.call(level); me.level = self.level + 1 }
+
+      @logger = logger
+      @out = logger.instance_variable_get(:@logdev)
+      @level = logger.level + 1
       @debug_mode = false
-      @self_event = false
-      @tag = 'fluent'
-      @time_format = '%Y-%m-%d %H:%M:%S %z '
+      @log_event_enabled = false
       @depth_offset = 1
+      @format = nil
+      @time_format = nil
+      @formatter = nil
+
+      self.format = :text
       enable_color out.tty?
       # TODO: This variable name is unclear so we should change to better name.
       @threads_exclude_events = []
 
       # Fluent::Engine requires Fluent::Log, so we must take that object lazily
       @engine = Fluent.const_get('Engine')
-
-      if opts.has_key?(:suppress_repeated_stacktrace)
-        @suppress_repeated_stacktrace = opts[:suppress_repeated_stacktrace]
+      @optional_header = nil
+      @optional_attrs = nil
+
+      @suppress_repeated_stacktrace = opts[:suppress_repeated_stacktrace]
+
+      @process_type = opts[:process_type] # :supervisor, :worker0, :workers Or :standalone
+      @process_type ||= :standalone # to keep behavior of existing code
+      case @process_type
+      when :supervisor
+        @show_supervisor_log = true
+        @show_worker0_log = false
+      when :worker0
+        @show_supervisor_log = false
+        @show_worker0_log = true
+      when :workers
+        @show_supervisor_log = false
+        @show_worker0_log = false
+      when :standalone
+        @show_supervisor_log = true
+        @show_worker0_log = true
+      else
+        raise "BUG: unknown process type for logger:#{@process_type}"
       end
+      @worker_id = opts[:worker_id]
+      @worker_id_part = "##{@worker_id} " # used only for :default log type in workers
     end
 
+    def dup
+      dl_opts = {}
+      dl_opts[:log_level] = @level - 1
+      logger = ServerEngine::DaemonLogger.new(@out, dl_opts)
+      clone = self.class.new(logger, suppress_repeated_stacktrace: @suppress_repeated_stacktrace, process_type: @process_type, worker_id: @worker_id)
+      clone.format = @format
+      clone.time_format = @time_format
+      clone.log_event_enabled = @log_event_enabled
+      # optional headers/attrs are not copied, because new PluginLogger should have another one of it
+      clone
+    end
+
+    attr_reader :format
+    attr_reader :time_format
+    attr_accessor :log_event_enabled
     attr_accessor :out
     attr_accessor :level
-    attr_accessor :tag
-    attr_accessor :time_format
+    attr_accessor :optional_header, :optional_attrs
+
+    def logdev=(logdev)
+      @out = logdev
+      @logger.instance_variable_set(:@logdev, logdev)
+      nil
+    end
+
+    def format=(fmt)
+      return if @format == fmt
+
+      @time_format = '%Y-%m-%d %H:%M:%S %z'
+      @time_formatter = Strftime.new(@time_format) rescue nil
+
+      case fmt
+      when :text
+        @format = :text
+        @formatter = Proc.new { |type, time, level, msg|
+          r = caller_line(type, time, @depth_offset, level)
+          r << msg
+          r
+        }
+      when :json
+        @format = :json
+        @formatter = Proc.new { |type, time, level, msg|
+          r = {
+            'time' => format_time(time),
+            'level' => LEVEL_TEXT[level],
+            'message' => msg
+          }
+          if wid = get_worker_id(type)
+            r['worker_id'] = wid
+          end
+          Yajl.dump(r)
+        }
+      end
+
+      nil
+    end
+
+    def time_format=(time_fmt)
+      @time_format = time_fmt
+      @time_formatter = Strftime.new(@time_format) rescue nil
+    end
+
+    def reopen!
+      # do nothing in @logger.reopen! because it's already reopened in Supervisor.load_config
+      @logger.reopen! if @logger
+      nil
+    end
 
     def enable_debug(b=true)
       @debug_mode = b
@@ -84,10 +209,17 @@ module Fluent
     end
 
     def enable_event(b=true)
-      @self_event = b
+      @log_event_enabled = b
       self
     end
 
+    # If you want to suppress event emitting in specific thread, please use this method.
+    # Events in passed thread are never emitted.
+    def disable_events(thread)
+      # this method is not symmetric with #enable_event.
+      @threads_exclude_events.push(thread) unless @threads_exclude_events.include?(thread)
+    end
+
     def enable_color?
       !@color_reset.empty?
     end
@@ -113,123 +245,151 @@ module Fluent
       self
     end
 
-    # If you want to suppress event emitting in specific thread, please use this method.
-    # Events in passed thread are never emitted.
-    def disable_events(thread)
-      @threads_exclude_events.push(thread) unless @threads_exclude_events.include?(thread)
+    def log_type(args)
+      if LOG_TYPES.include?(args.first)
+        args.shift
+      else
+        LOG_TYPE_DEFAULT
+      end
     end
 
-    def on_trace(&block)
+    # TODO: skip :worker0 logs when Fluentd gracefully restarted
+    def skipped_type?(type)
+      case type
+      when LOG_TYPE_DEFAULT
+        false
+      when LOG_TYPE_WORKER0
+        !@show_worker0_log
+      when LOG_TYPE_SUPERVISOR
+        !@show_supervisor_log
+      else
+        raise "BUG: unknown log type:#{type}"
+      end
+    end
+
+    def on_trace
       return if @level > LEVEL_TRACE
-      block.call if block
+      yield
     end
 
     def trace(*args, &block)
       return if @level > LEVEL_TRACE
+      type = log_type(args)
+      return if skipped_type?(type)
       args << block.call if block
       time, msg = event(:trace, args)
-      puts [@color_trace, caller_line(time, @depth_offset, LEVEL_TRACE), msg, @color_reset].join
+      puts [@color_trace, @formatter.call(type, time, LEVEL_TRACE, msg), @color_reset].join
     rescue
       # logger should not raise an exception. This rescue prevents unexpected behaviour.
     end
     alias TRACE trace
 
-    def trace_backtrace(backtrace=$!.backtrace)
-      dump_stacktrace(backtrace, LEVEL_TRACE)
+    def trace_backtrace(backtrace=$!.backtrace, type: :default)
+      dump_stacktrace(type, backtrace, LEVEL_TRACE)
     end
 
-    def on_debug(&block)
+    def on_debug
       return if @level > LEVEL_DEBUG
-      block.call if block
+      yield
     end
 
     def debug(*args, &block)
       return if @level > LEVEL_DEBUG
+      type = log_type(args)
+      return if skipped_type?(type)
       args << block.call if block
       time, msg = event(:debug, args)
-      puts [@color_debug, caller_line(time, @depth_offset, LEVEL_DEBUG), msg, @color_reset].join
+      puts [@color_debug, @formatter.call(type, time, LEVEL_DEBUG, msg), @color_reset].join
     rescue
     end
     alias DEBUG debug
 
-    def debug_backtrace(backtrace=$!.backtrace)
-      dump_stacktrace(backtrace, LEVEL_DEBUG)
+    def debug_backtrace(backtrace=$!.backtrace, type: :default)
+      dump_stacktrace(type, backtrace, LEVEL_DEBUG)
     end
 
-    def on_info(&block)
+    def on_info
       return if @level > LEVEL_INFO
-      block.call if block
+      yield
     end
 
     def info(*args, &block)
       return if @level > LEVEL_INFO
+      type = log_type(args)
+      return if skipped_type?(type)
       args << block.call if block
       time, msg = event(:info, args)
-      puts [@color_info, caller_line(time, @depth_offset, LEVEL_INFO), msg, @color_reset].join
+      puts [@color_info, @formatter.call(type, time, LEVEL_INFO, msg), @color_reset].join
     rescue
     end
     alias INFO info
 
-    def info_backtrace(backtrace=$!.backtrace)
-      dump_stacktrace(backtrace, LEVEL_INFO)
+    def info_backtrace(backtrace=$!.backtrace, type: :default)
+      dump_stacktrace(type, backtrace, LEVEL_INFO)
     end
 
-    def on_warn(&block)
+    def on_warn
       return if @level > LEVEL_WARN
-      block.call if block
+      yield
     end
 
     def warn(*args, &block)
       return if @level > LEVEL_WARN
+      type = log_type(args)
+      return if skipped_type?(type)
       args << block.call if block
       time, msg = event(:warn, args)
-      puts [@color_warn, caller_line(time, @depth_offset, LEVEL_WARN), msg, @color_reset].join
+      puts [@color_warn, @formatter.call(type, time, LEVEL_WARN, msg), @color_reset].join
     rescue
     end
     alias WARN warn
 
-    def warn_backtrace(backtrace=$!.backtrace)
-      dump_stacktrace(backtrace, LEVEL_WARN)
+    def warn_backtrace(backtrace=$!.backtrace, type: :default)
+      dump_stacktrace(type, backtrace, LEVEL_WARN)
     end
 
-    def on_error(&block)
+    def on_error
       return if @level > LEVEL_ERROR
-      block.call if block
+      yield
     end
 
     def error(*args, &block)
       return if @level > LEVEL_ERROR
+      type = log_type(args)
+      return if skipped_type?(type)
       args << block.call if block
       time, msg = event(:error, args)
-      puts [@color_error, caller_line(time, @depth_offset, LEVEL_ERROR), msg, @color_reset].join
+      puts [@color_error, @formatter.call(type, time, LEVEL_ERROR, msg), @color_reset].join
     rescue
     end
     alias ERROR error
 
-    def error_backtrace(backtrace=$!.backtrace)
-      dump_stacktrace(backtrace, LEVEL_ERROR)
+    def error_backtrace(backtrace=$!.backtrace, type: :default)
+      dump_stacktrace(type, backtrace, LEVEL_ERROR)
     end
 
-    def on_fatal(&block)
+    def on_fatal
       return if @level > LEVEL_FATAL
-      block.call if block
+      yield
     end
 
     def fatal(*args, &block)
       return if @level > LEVEL_FATAL
+      type = log_type(args)
+      return if skipped_type?(type)
       args << block.call if block
       time, msg = event(:fatal, args)
-      puts [@color_fatal, caller_line(time, @depth_offset, LEVEL_FATAL), msg, @color_reset].join
+      puts [@color_fatal, @formatter.call(type, time, LEVEL_FATAL, msg), @color_reset].join
     rescue
     end
     alias FATAL fatal
 
-    def fatal_backtrace(backtrace=$!.backtrace)
-      dump_stacktrace(backtrace, LEVEL_FATAL)
+    def fatal_backtrace(backtrace=$!.backtrace, type: :default)
+      dump_stacktrace(type, backtrace, LEVEL_FATAL)
     end
 
     def puts(msg)
-      @out.puts(msg)
+      @logger << msg + "\n"
       @out.flush
       msg
     rescue
@@ -248,10 +408,59 @@ module Fluent
       @out.flush
     end
 
+    def reset
+      @out.reset if @out.respond_to?(:reset)
+    end
+
+    def dump_stacktrace(type, backtrace, level)
+      return if @level > level
+
+      time = Time.now
+
+      if @format == :text
+        line = caller_line(type, time, 5, level)
+        if @suppress_repeated_stacktrace && (Thread.current[:last_repeated_stacktrace] == backtrace)
+          puts ["  ", line, 'suppressed same stacktrace'].join
+        else
+          backtrace.each { |msg|
+            puts ["  ", line, msg].join
+          }
+          Thread.current[:last_repeated_stacktrace] = backtrace if @suppress_repeated_stacktrace
+        end
+      else
+        r = {
+          'time' => format_time(time),
+          'level' => LEVEL_TEXT[level],
+        }
+        if wid = get_worker_id(type)
+          r['worker_id'] = wid
+        end
+
+        if @suppress_repeated_stacktrace && (Thread.current[:last_repeated_stacktrace] == backtrace)
+          r['message'] = 'suppressed same stacktrace'
+        else
+          r['message'] = backtrace.join("\n")
+          Thread.current[:last_repeated_stacktrace] = backtrace if @suppress_repeated_stacktrace
+        end
+
+        puts Yajl.dump(r)
+      end
+
+      nil
+    end
+
+    def get_worker_id(type)
+      if type == :default && (@process_type == :worker0 || @process_type == :workers)
+        @worker_id
+      else
+        nil
+      end
+    end
+
     def event(level, args)
       time = Time.now
-      message = ''
-      map = {}
+      message = @optional_header ? @optional_header.dup : ''
+      map = @optional_attrs ? @optional_attrs.dup : {}
       args.each {|a|
         if a.is_a?(Hash)
           a.each_pair {|k,v|
@@ -263,23 +472,32 @@ module Fluent
       }
 
       map.each_pair {|k,v|
-        message << " #{k}=#{v.inspect}"
+        if k == "error".freeze && v.is_a?(Exception) && !map.has_key?("error_class")
+          message << " error_class=#{v.class.to_s} error=#{v.to_s.inspect}"
+        else
+          message << " #{k}=#{v.inspect}"
+        end
       }
 
-      unless @threads_exclude_events.include?(Thread.current)
+      if @log_event_enabled && !@threads_exclude_events.include?(Thread.current)
         record = map.dup
         record.keys.each {|key|
           record[key] = record[key].inspect unless record[key].respond_to?(:to_msgpack)
         }
         record['message'] = message.dup
-        @engine.push_log_event("#{@tag}.#{level}", time.to_i, record)
+        @engine.push_log_event("#{LOG_EVENT_TAG_PREFIX}.#{level}", Fluent::EventTime.from_time(time), record)
       end
 
       return time, message
     end
 
-    def caller_line(time, depth, level)
-      log_msg = "#{time.strftime(@time_format)}[#{LEVEL_TEXT[level]}]: "
+    def caller_line(type, time, depth, level)
+      worker_id_part = if type == :default && (@process_type == :worker0 || @process_type == :workers)
+                         @worker_id_part
+                       else
+                         "".freeze
+                       end
+      log_msg = "#{format_time(time)} [#{LEVEL_TEXT[level]}]: #{worker_id_part}"
       if @debug_mode
         line = caller(depth+1)[0]
         if match = /^(.+?):(\d+)(?::in `(.*)')?/.match(line)
@@ -292,23 +510,8 @@ module Fluent
       return log_msg
     end
 
-    private
-
-    def dump_stacktrace(backtrace, level)
-      return if @level > level
-
-      time = Time.now
-      line = caller_line(time, 5, level)
-      if @suppress_repeated_stacktrace && (Thread.current[:last_repeated_stacktrace] == backtrace)
-        puts ["  ", line, 'suppressed same stacktrace'].join
-      else
-        backtrace.each { |msg|
-          puts ["  ", line, msg].join
-        }
-        Thread.current[:last_repeated_stacktrace] = backtrace if @suppress_repeated_stacktrace
-      end
-
-      nil
+    def format_time(time)
+      @time_formatter ? @time_formatter.exec(time) : time.strftime(@time_format)
     end
   end
 
@@ -317,14 +520,19 @@ module Fluent
   # This class enables log_level option in each plugin.
   #
   # PluginLogger has same functionality as Log but some methods are forwarded to internal logger
-  # for keeping logging action consistency in the process, e.g. color, tag, event, etc.
+  # for keeping logging action consistency in the process, e.g. color, event, etc.
   class PluginLogger < Log
     def initialize(logger)
       @logger = logger
       @level = @logger.level
+      @format = nil
       @depth_offset = 2
-      @suppress_repeated_stacktrace = logger.instance_variable_get(:@suppress_repeated_stacktrace)
+      if logger.instance_variable_defined?(:@suppress_repeated_stacktrace)
+        @suppress_repeated_stacktrace = logger.instance_variable_get(:@suppress_repeated_stacktrace)
+      end
 
+      self.format = @logger.format
+      self.time_format = @logger.time_format
       enable_color @logger.enable_color?
     end
 
@@ -332,17 +540,30 @@ module Fluent
       @level = Log.str_to_level(log_level_str)
     end
 
+    alias orig_format= format=
+    alias orig_time_format= time_format=
     alias orig_enable_color enable_color
 
+    def format=(fmt)
+      self.orig_format = fmt
+      @logger.format = fmt
+    end
+
+    def time_format=(fmt)
+      self.orig_time_format = fmt
+      @logger.time_format = fmt
+    end
+
     def enable_color(b = true)
       orig_enable_color b
       @logger.enable_color b
     end
 
     extend Forwardable
-    def_delegators '@logger', :enable_color?, :enable_debug, :enable_event,
-      :disable_events, :tag, :tag=, :time_format, :time_format=,
-      :event, :caller_line, :puts, :write, :<<, :flush, :out, :out=
+    def_delegators '@logger', :get_worker_id, :enable_color?, :enable_debug, :enable_event,
+      :disable_events, :log_event_enabled, :log_event_enabled=, :event, :caller_line, :puts, :write,
+      :<<, :flush, :reset, :out, :out=, :optional_header, :optional_header=, :optional_attrs,
+      :optional_attrs=
   end
 
 
@@ -350,7 +571,7 @@ module Fluent
     def self.included(klass)
       klass.instance_eval {
         desc 'Allows the user to set different levels of logging for each plugin.'
-        config_param :log_level, :string, default: nil, alias: :@log_level
+        config_param :@log_level, :string, default: nil, alias: :log_level # 'log_level' will be warned as deprecated
       }
     end
 
@@ -365,12 +586,58 @@ module Fluent
     def configure(conf)
       super
 
-      if @log_level
-        unless @log.is_a?(PluginLogger)
-          @log = PluginLogger.new($log)
+      if plugin_id_configured? || conf['@log_level']
+        @log = PluginLogger.new($log.dup) unless @log.is_a?(PluginLogger)
+        @log.optional_attrs = {}
+
+        if level = conf['@log_level']
+          @log.level = level
         end
-        @log.level = @log_level
+
+        if plugin_id_configured?
+          @log.optional_header = "[#{@id}] "
+        end
+      end
+    end
+
+    def terminate
+      super
+      @log.reset
+    end
+  end
+
+  # This class delegetes some methods which are used in `Fluent::Logger` to a instance variable(`dev`) in `Logger::LogDevice` class
+  # https://github.com/ruby/ruby/blob/7b2d47132ff8ee950b0f978ab772dee868d9f1b0/lib/logger.rb#L661
+  class LogDeviceIO < ::Logger::LogDevice
+    def flush
+      if @dev.respond_to?(:flush)
+        @dev.flush
+      else
+        super
+      end
+    end
+
+    def tty?
+      if @dev.respond_to?(:tty?)
+        @dev.tty?
+      else
+        super
+      end
+    end
+
+    def sync=(v)
+      if @dev.respond_to?(:sync=)
+        @dev.sync = v
+      else
+        super
+      end
+    end
+
+    def reopen(path, mode)
+      if mode != 'a'
+        raise "Unsupported mode: #{mode}"
       end
+      super(path)
     end
   end
 end