Class: Kafka::CustomProducer

Inherits:
Object
  • Object
show all
Defined in:
lib/fluent/plugin/kafka_producer_ext.rb

Instance Method Summary collapse

Constructor Details

#initialize(cluster:, transaction_manager:, logger:, instrumenter:, compressor:, ack_timeout:, required_acks:, max_retries:, retry_backoff:, max_buffer_size:, max_buffer_bytesize:, partitioner:) ⇒ CustomProducer

Returns a new instance of CustomProducer.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 83

def initialize(cluster:, transaction_manager:, logger:, instrumenter:, compressor:, ack_timeout:, required_acks:, max_retries:, retry_backoff:, max_buffer_size:, max_buffer_bytesize:, partitioner:)
  @cluster = cluster
  @transaction_manager = transaction_manager
  @logger = logger
  @instrumenter = instrumenter
  @required_acks = required_acks == :all ? -1 : required_acks
  @ack_timeout = ack_timeout
  @max_retries = max_retries
  @retry_backoff = retry_backoff
  @max_buffer_size = max_buffer_size
  @max_buffer_bytesize = max_buffer_bytesize
  @compressor = compressor
  @partitioner = partitioner
  # A buffer organized by topic/partition.
  @buffer = MessageBuffer.new

  # Messages added by `#produce` but not yet assigned a partition.
  @pending_message_queue = PendingMessageQueue.new
end

Instance Method Details

#abort_transaction ⇒ Object 



171
172
173
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 171

def abort_transaction
  @transaction_manager.abort_transaction
end

#assign_partitions! ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 247

def assign_partitions!
  failed_messages = []

  @pending_message_queue.each do |message|
    partition = message.partition

    begin
      partition_count = @cluster.partitions_for(message.topic).count

      if partition.nil?
        partition = @partitioner.call(partition_count, message)
      end

      @buffer.write(
        value: message.value,
        key: message.key,
        headers: message.headers,
        topic: message.topic,
        partition: partition,
        create_time: message.create_time,
      )
    rescue Kafka::Error => e
      failed_messages << message
    end
  end

  if failed_messages.any?
    failed_messages.group_by(&:topic).each do |topic, messages|
      @logger.error "Failed to assign partitions to #{messages.count} messages in #{topic}"
    end

    @cluster.mark_as_stale!
  end

  @pending_message_queue.replace(failed_messages)
end

#begin_transaction ⇒ Object 



163
164
165
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 163

def begin_transaction
  @transaction_manager.begin_transaction
end

#buffer_bytesize ⇒ Object 



139
140
141
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 139

def buffer_bytesize
  @pending_message_queue.bytesize + @buffer.bytesize
end

#buffer_messages ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 284

def buffer_messages
  messages = []

  @pending_message_queue.each do |message|
    messages << message
  end

  @buffer.each do |topic, partition, messages_for_partition|
    messages_for_partition.each do |message|
      messages << PendingMessage.new(
        value: message.value,
        key: message.key,
        headers: message.headers,
        topic: topic,
        partition: partition,
        partition_key: nil,
        create_time: message.create_time
      )
    end
  end

  messages
end

#buffer_size ⇒ Integer

Returns the number of messages currently held in the buffer.

Returns:

  • (Integer) —

    buffer size.



135
136
137
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 135

def buffer_size
  @pending_message_queue.size + @buffer.size
end

#clear_buffer ⇒ nil

Deletes all buffered messages.

Returns:

  • (nil) 


146
147
148
149
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 146

def clear_buffer
  @buffer.clear
  @pending_message_queue.clear
end

#commit_transaction ⇒ Object 



167
168
169
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 167

def commit_transaction
  @transaction_manager.commit_transaction
end

#deliver_messages ⇒ Object 



125
126
127
128
129
130
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 125

def deliver_messages
  # There's no need to do anything if the buffer is empty.
  return if buffer_size == 0

  deliver_messages_with_retries
end

#deliver_messages_with_retries ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 187

def deliver_messages_with_retries
  attempt = 0

  #@cluster.add_target_topics(@target_topics)

  operation = ProduceOperation.new(
    cluster: @cluster,
    transaction_manager: @transaction_manager,
    buffer: @buffer,
    required_acks: @required_acks,
    ack_timeout: @ack_timeout,
    compressor: @compressor,
    logger: @logger,
    instrumenter: @instrumenter,
  )

  loop do
    attempt += 1

    begin
      @cluster.refresh_metadata_if_necessary!
    rescue ConnectionError => e
      raise DeliveryFailed.new(e, buffer_messages)
    end

    assign_partitions!
    operation.execute

    if @required_acks.zero?
      # No response is returned by the brokers, so we can't know which messages
      # have been successfully written. Our only option is to assume that they all
      # have.
      @buffer.clear
    end

    if buffer_size.zero?
      break
    elsif attempt <= @max_retries
      @logger.warn "Failed to send all messages; attempting retry #{attempt} of #{@max_retries} after #{@retry_backoff}s"

      sleep @retry_backoff
    else
      @logger.error "Failed to send all messages; keeping remaining messages in buffer"
      break
    end
  end

  unless @pending_message_queue.empty?
    # Mark the cluster as stale in order to force a cluster metadata refresh.
    @cluster.mark_as_stale!
    raise DeliveryFailed.new("Failed to assign partitions to #{@pending_message_queue.size} messages", buffer_messages)
  end

  unless @buffer.empty?
    partitions = @buffer.map {|topic, partition, _| "#{topic}/#{partition}" }.join(", ")

    raise DeliveryFailed.new("Failed to send messages to #{partitions}", buffer_messages)
  end
end

#init_transactions ⇒ Object 



159
160
161
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 159

def init_transactions
  @transaction_manager.init_transactions
end

#produce(value, key: nil, partition: nil, partition_key: nil, headers: EMPTY_HEADER, create_time: Time.now, topic: nil) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 103

def produce(value, key: nil, partition: nil, partition_key: nil, headers: EMPTY_HEADER, create_time: Time.now, topic: nil)
  message = PendingMessage.new(
    value: value,
    key: key,
    headers: headers,
    topic: topic,
    partition: partition,
    partition_key: partition_key,
    create_time: create_time
  )

  # If the producer is in transactional mode, all the message production
  # must be used when the producer is currently in transaction
  if @transaction_manager.transactional? && !@transaction_manager.in_transaction?
    raise 'You must trigger begin_transaction before producing messages'
  end

  @pending_message_queue.write(message)

  nil
end

#shutdown ⇒ nil

Closes all connections to the brokers.

Returns:

  • (nil) 


154
155
156
157
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 154

def shutdown
  @transaction_manager.close
  @cluster.disconnect
end

#transaction ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/fluent/plugin/kafka_producer_ext.rb', line 175

def transaction
  raise 'This method requires a block' unless block_given?
  begin_transaction
  yield
  commit_transaction
rescue Kafka::Producer::AbortTransaction
  abort_transaction
rescue
  abort_transaction
  raise
end