Sha256: 18149543211b33a2dbf29d4eb277ff6be2bf52ed00484cd47012bb0725ec37c8

Contents?: true

Size: 1.69 KB

Versions: 14

Compression:

Stored size: 1.69 KB

Contents

# frozen_string_literal: true

module Karafka
  module Core
    module Monitoring
      # Karafka monitor that can be used to pass through instrumentation calls to selected
      # notifications bus.
      #
      # It provides abstraction layer that allows us to use both our internal notifications as well
      # as `ActiveSupport::Notifications`.
      class Monitor
        # Empty has to save on objects allocation
        EMPTY_HASH = {}.freeze

        private_constant :EMPTY_HASH

        # @param notifications_bus [Object] either our internal notifications bus or
        #   `ActiveSupport::Notifications`
        # @param namespace [String, nil] namespace for events or nil if no namespace
        def initialize(notifications_bus, namespace = nil)
          @notifications_bus = notifications_bus
          @namespace = namespace
          @mapped_events = {}
        end

        # Passes the instrumentation block (if any) into the notifications bus
        #
        # @param event_id [String, Symbol] event id
        # @param payload [Hash]
        # @param block [Proc] block we want to instrument (if any)
        def instrument(event_id, payload = EMPTY_HASH, &block)
          full_event_name = @mapped_events[event_id] ||= [event_id, @namespace].compact.join('.')

          @notifications_bus.instrument(full_event_name, payload, &block)
        end

        # Allows us to subscribe to the notification bus
        #
        # @param args [Array] any arguments that the notification bus subscription layer accepts
        # @param block [Proc] optional block for subscription
        def subscribe(*args, &block)
          @notifications_bus.subscribe(*args, &block)
        end
      end
    end
  end
end

Version data entries

14 entries across 14 versions & 1 rubygems

Version Path
karafka-core-2.4.4 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.3 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.2 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.1 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.1.rc1 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.0 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.0.rc2 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.0.rc1 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.0.beta2 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.0.beta1 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.4.0.alpha1 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.3.0 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.3.0.rc1 lib/karafka/core/monitoring/monitor.rb
karafka-core-2.3.0.alpha1 lib/karafka/core/monitoring/monitor.rb