Class: WaterDrop::Instrumentation::LoggerListener
- Inherits:
-
Object
- Object
- WaterDrop::Instrumentation::LoggerListener
- Defined in:
- lib/waterdrop/instrumentation/logger_listener.rb
Overview
Note:
It is a module as we can use it then as a part of the Karafka framework listener as well as we can use it standalone
Default listener that hooks up to our instrumentation and uses its events for logging It can be removed/replaced or anything without any harm to the Waterdrop flow
Instance Method Summary collapse
-
#initialize(logger, log_messages: true) ⇒ LoggerListener
constructor
A new instance of LoggerListener.
- #on_buffer_flushed_async(event) ⇒ Object
- #on_buffer_flushed_sync(event) ⇒ Object
- #on_buffer_purged(event) ⇒ Object
- #on_error_occurred(event) ⇒ Object
- #on_message_buffered(event) ⇒ Object
- #on_message_produced_async(event) ⇒ Object
- #on_message_produced_sync(event) ⇒ Object
- #on_messages_buffered(event) ⇒ Object
- #on_messages_produced_async(event) ⇒ Object
- #on_messages_produced_sync(event) ⇒ Object
- #on_producer_closed(event) ⇒ Object
- #on_producer_closing(event) ⇒ Object
- #on_transaction_aborted(event) ⇒ Object
- #on_transaction_committed(event) ⇒ Object
- #on_transaction_finished(event) ⇒ Object
- #on_transaction_marked_as_consumed(event) ⇒ Object
- #on_transaction_started(event) ⇒ Object
Constructor Details
#initialize(logger, log_messages: true) ⇒ LoggerListener
Returns a new instance of LoggerListener.
20 21 22 23 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 20 def initialize(logger, log_messages: true) @logger = logger = end |
Instance Method Details
#on_buffer_flushed_async(event) ⇒ Object
94 95 96 97 98 99 100 101 102 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 94 def on_buffer_flushed_async(event) = event[:messages] info(event, "Async flushing of #{messages.size} messages from the buffer") return unless debug(event, ) end |
#on_buffer_flushed_sync(event) ⇒ Object
105 106 107 108 109 110 111 112 113 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 105 def on_buffer_flushed_sync(event) = event[:messages] info(event, "Sync flushing of #{messages.size} messages from the buffer") return unless debug(event, ) end |
#on_buffer_purged(event) ⇒ Object
116 117 118 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 116 def on_buffer_purged(event) info(event, 'Successfully purging buffer') end |
#on_error_occurred(event) ⇒ Object
133 134 135 136 137 138 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 133 def on_error_occurred(event) error = event[:error] type = event[:type] error(event, "Error occurred: #{error} - #{type}") end |
#on_message_buffered(event) ⇒ Object
72 73 74 75 76 77 78 79 80 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 72 def (event) = event[:message] info(event, "Buffering of a message to '#{message[:topic]}' topic") return unless debug(event, []) end |
#on_message_produced_async(event) ⇒ Object
26 27 28 29 30 31 32 33 34 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 26 def (event) = event[:message] info(event, "Async producing of a message to '#{message[:topic]}' topic") return unless debug(event, ) end |
#on_message_produced_sync(event) ⇒ Object
37 38 39 40 41 42 43 44 45 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 37 def (event) = event[:message] info(event, "Sync producing of a message to '#{message[:topic]}' topic") return unless debug(event, ) end |
#on_messages_buffered(event) ⇒ Object
83 84 85 86 87 88 89 90 91 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 83 def (event) = event[:messages] info(event, "Buffering of #{messages.size} messages") return unless debug(event, [, .size]) end |
#on_messages_produced_async(event) ⇒ Object
48 49 50 51 52 53 54 55 56 57 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 48 def (event) = event[:messages] topics_count = .map { || "'#{message[:topic]}'" }.uniq.count info(event, "Async producing of #{messages.size} messages to #{topics_count} topics") return unless debug(event, ) end |
#on_messages_produced_sync(event) ⇒ Object
60 61 62 63 64 65 66 67 68 69 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 60 def (event) = event[:messages] topics_count = .map { || "'#{message[:topic]}'" }.uniq.count info(event, "Sync producing of #{messages.size} messages to #{topics_count} topics") return unless debug(event, ) end |
#on_producer_closed(event) ⇒ Object
Note:
While this says “Closing producer”, it produces a nice message with time taken: “Closing producer took 12 ms” indicating it happened in the past.
128 129 130 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 128 def on_producer_closed(event) info(event, 'Closing producer') end |
#on_producer_closing(event) ⇒ Object
121 122 123 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 121 def on_producer_closing(event) info(event, 'Closing producer') end |
#on_transaction_aborted(event) ⇒ Object
146 147 148 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 146 def on_transaction_aborted(event) info(event, 'Aborting transaction') end |
#on_transaction_committed(event) ⇒ Object
151 152 153 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 151 def on_transaction_committed(event) info(event, 'Committing transaction') end |
#on_transaction_finished(event) ⇒ Object
170 171 172 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 170 def on_transaction_finished(event) info(event, 'Processing transaction') end |
#on_transaction_marked_as_consumed(event) ⇒ Object
156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 156 def on_transaction_marked_as_consumed(event) = event[:message] topic = .topic partition = .partition offset = .offset loc = "#{topic}/#{partition}" info( event, "Marking message with offset #{offset} for topic #{loc} as consumed in a transaction" ) end |
#on_transaction_started(event) ⇒ Object
141 142 143 |
# File 'lib/waterdrop/instrumentation/logger_listener.rb', line 141 def on_transaction_started(event) info(event, 'Starting transaction') end |