ParentSquare/faulty

View on GitHub
lib/faulty/events/log_listener.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
# frozen_string_literal: true

class Faulty
  module Events
    # A default listener that logs Faulty events
    class LogListener
      attr_reader :logger

      # @param logger A logger similar to stdlib `Logger`. Uses the Rails logger
      #   by default if available, otherwise it creates a new `Logger` to
      #   stderr.
      def initialize(logger = nil)
        logger ||= defined?(Rails) ? Rails.logger : ::Logger.new($stderr)
        @logger = logger
      end

      # (see ListenerInterface#handle)
      def handle(event, payload)
        return unless EVENT_SET.include?(event)

        send(event, payload)
      end

      private

      def circuit_cache_hit(payload)
        log(:debug, 'Circuit cache hit', payload[:circuit].name, key: payload[:key])
      end

      def circuit_cache_miss(payload)
        log(:debug, 'Circuit cache miss', payload[:circuit].name, key: payload[:key])
      end

      def circuit_cache_write(payload)
        log(:debug, 'Circuit cache write', payload[:circuit].name, key: payload[:key])
      end

      def circuit_success(payload)
        log(:debug, 'Circuit succeeded', payload[:circuit].name)
      end

      def circuit_failure(payload)
        log(
          :error, 'Circuit failed', payload[:circuit].name,
          state: payload[:status].state,
          error: payload[:error].message
        )
      end

      def circuit_skipped(payload)
        log(:warn, 'Circuit skipped', payload[:circuit].name)
      end

      def circuit_opened(payload)
        log(:error, 'Circuit opened', payload[:circuit].name, error: payload[:error].message)
      end

      def circuit_reopened(payload)
        log(:error, 'Circuit reopened', payload[:circuit].name, error: payload[:error].message)
      end

      def circuit_closed(payload)
        log(:info, 'Circuit closed', payload[:circuit].name)
      end

      def cache_failure(payload)
        log(
          :error, 'Cache failure', payload[:action],
          key: payload[:key],
          error: payload[:error].message
        )
      end

      def storage_failure(payload)
        extra = {}
        extra[:circuit] = payload[:circuit].name if payload.key?(:circuit)
        extra[:error] = payload[:error].message
        log(:error, 'Storage failure', payload[:action], extra)
      end

      def log(level, msg, action, extra = {})
        @logger.public_send(level) do
          extra_str = extra.map { |k, v| "#{k}=#{v}" }.join(' ')
          extra_str = " #{extra_str}" unless extra_str.empty?

          "#{msg}: #{action}#{extra_str}"
        end
      end
    end
  end
end