Contents

begin
  require "honeybadger"
rescue LoadError
  raise LoadError, 'Gem honeybadger is required for logging purposes. Please add the gem "honeybadger" to your Gemfile.'
end

# Send log messages to honeybadger events/insights API
#
# Example:
#   SemanticLogger.add_appender(appender: :honeybadger_insights)
#
module SemanticLogger
  module Appender
    class HoneybadgerInsights < SemanticLogger::Subscriber
      # Honeybadger Appender
      #
      # Parameters
      #   level: [:trace | :debug | :info | :warn | :error | :fatal]
      #     Override the log level for this appender.
      #     Default: :error
      #
      #   formatter: [Object|Proc|Symbol|Hash]
      #     An instance of a class that implements #call, or a Proc to be used to format
      #     the output from this appender
      #     Default: Use the built-in formatter (See: #call)
      #
      #   filter: [Regexp|Proc]
      #     RegExp: Only include log messages where the class name matches the supplied.
      #     regular expression. All other messages will be ignored.
      #     Proc: Only include log messages where the supplied Proc returns true
      #           The Proc must return true or false.
      #
      #   host: [String]
      #     Name of this host to appear in log messages.
      #     Default: SemanticLogger.host
      #
      #   application: [String]
      #     Name of this application to appear in log messages.
      #     Default: SemanticLogger.application
      def initialize(level: :info, **args, &block)
        super(level: level, **args, &block)
      end

      # Send log to honeybadger events API
      def log(log)
        event = formatter.call(log, self)

        ::Honeybadger.event(event)

        true
      end

      private

      # Use Raw Formatter by default
      def default_formatter
        SemanticLogger::Formatters::Raw.new(time_key: :ts, time_format: :rfc_3339)
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
semantic_logger-4.16.1	lib/semantic_logger/appender/honeybadger_insights.rb
semantic_logger-4.16.0	lib/semantic_logger/appender/honeybadger_insights.rb