Class: Karafka::Pro::Processing::Coordinators::ErrorsTracker
- Inherits:
-
Object
- Object
- Karafka::Pro::Processing::Coordinators::ErrorsTracker
- Includes:
- Enumerable
- Defined in:
- lib/karafka/pro/processing/coordinators/errors_tracker.rb
Overview
Object used to track errors in between executions to be able to build error-type based recovery flows.
Instance Attribute Summary collapse
- #counts ⇒ Hash readonly
-
#partition ⇒ Integer
readonly
Partition of this error tracker.
-
#topic ⇒ Karafka::Routing::Topic
readonly
Topic of this error tracker.
- #trace_id ⇒ String readonly
Instance Method Summary collapse
- #<<(error) ⇒ Object
-
#all ⇒ Array<StandardError>
Array with all the errors that occurred.
-
#clear ⇒ Object
Clears all the errors.
-
#each(&block) ⇒ Object
Iterates over errors.
-
#empty? ⇒ Boolean
Is the error tracker empty.
-
#initialize(topic, partition, limit: STORAGE_LIMIT) ⇒ ErrorsTracker
constructor
A new instance of ErrorsTracker.
-
#last ⇒ StandardError?
Last error that occurred or nil if no errors.
-
#size ⇒ Integer
Number of elements.
Constructor Details
#initialize(topic, partition, limit: STORAGE_LIMIT) ⇒ ErrorsTracker
limit
does not apply to the counts. They will work beyond the number of errors occurring
Returns a new instance of ErrorsTracker.
41 42 43 44 45 46 47 48 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 41 def initialize(topic, partition, limit: STORAGE_LIMIT) @errors = [] @counts = Hash.new { |hash, key| hash[key] = 0 } @topic = topic @partition = partition @limit = limit @trace_id = SecureRandom.uuid end |
Instance Attribute Details
#counts ⇒ Hash (readonly)
23 24 25 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 23 def counts @counts end |
#partition ⇒ Integer (readonly)
Returns partition of this error tracker.
20 21 22 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 20 def partition @partition end |
#topic ⇒ Karafka::Routing::Topic (readonly)
Returns topic of this error tracker.
17 18 19 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 17 def topic @topic end |
#trace_id ⇒ String (readonly)
26 27 28 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 26 def trace_id @trace_id end |
Instance Method Details
#<<(error) ⇒ Object
57 58 59 60 61 62 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 57 def <<(error) @errors.shift if @errors.size >= @limit @errors << error @counts[error.class] += 1 @trace_id = SecureRandom.uuid end |
#all ⇒ Array<StandardError>
Returns array with all the errors that occurred.
88 89 90 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 88 def all @errors end |
#clear ⇒ Object
Clears all the errors
51 52 53 54 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 51 def clear @errors.clear @counts.clear end |
#each(&block) ⇒ Object
Iterates over errors
83 84 85 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 83 def each(&block) @errors.each(&block) end |
#empty? ⇒ Boolean
Returns is the error tracker empty.
65 66 67 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 65 def empty? @errors.empty? end |
#last ⇒ StandardError?
Returns last error that occurred or nil if no errors.
77 78 79 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 77 def last @errors.last end |
#size ⇒ Integer
Returns number of elements.
70 71 72 73 74 |
# File 'lib/karafka/pro/processing/coordinators/errors_tracker.rb', line 70 def size # We use counts reference of all errors and not the `@errors` array because it allows # us to go beyond the whole errors storage limit @counts.values.sum end |