Class: Karafka::Instrumentation::Callbacks::Error

Inherits:
Object
  • Object
show all
Defined in:
lib/karafka/instrumentation/callbacks/error.rb

Overview

Callback that kicks in when consumer error occurs and is published in a background thread

Instance Method Summary collapse

Constructor Details

#initialize(subscription_group_id, consumer_group_id, client_name) ⇒ Error

Returns a new instance of Error.

Parameters:

  • subscription_group_id (String) —

    id of the current subscription group instance

  • consumer_group_id (String) —

    id of the current consumer group

  • client_name (String) —

    rdkafka client name



12
13
14
15
16
 
# File 'lib/karafka/instrumentation/callbacks/error.rb', line 12

def initialize(subscription_group_id, consumer_group_id, client_name)
  @subscription_group_id = subscription_group_id
  @consumer_group_id = consumer_group_id
  @client_name = client_name
end

Instance Method Details

#call(client_name, error) ⇒ Object

Note:

It will only instrument on errors of the client of our consumer

Runs the instrumentation monitor with error

Parameters:

  • client_name (String) —

    rdkafka client name

  • error (Rdkafka::Error) —

    error that occurred



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/karafka/instrumentation/callbacks/error.rb', line 22

def call(client_name, error)
  # Emit only errors related to our client
  # Same as with statistics (mor explanation there)
  return unless @client_name == client_name

  ::Karafka.monitor.instrument(
    'error.occurred',
    caller: self,
    subscription_group_id: @subscription_group_id,
    consumer_group_id: @consumer_group_id,
    type: 'librdkafka.error',
    error: error
  )
end