karafka 2.0.0.rc1 → 2.0.0.rc4

data/lib/karafka/contracts/config.rb

@@ -9,71 +9,90 @@ module Karafka
     #   validated per each route (topic + consumer_group) because they can be overwritten,
     #   so we validate all of that once all the routes are defined and ready.
     class Config < Base
-      params do
-        # License validity happens in the licenser. Here we do only the simple consistency checks
-        required(:license).schema do
-          required(:token) { bool? | str? }
-          required(:entity) { str? }
-          required(:expires_on) { date? }
+      configure do |config|
+        config.error_messages = YAML.safe_load(
+          File.read(
+            File.join(Karafka.gem_root, 'config', 'errors.yml')
+          )
+        ).fetch('en').fetch('validations').fetch('config')
+      end
+
+      # License validity happens in the licenser. Here we do only the simple consistency checks
+      nested(:license) do
+        required(:token) { |val| [true, false].include?(val) || val.is_a?(String) }
+        required(:entity) { |val| val.is_a?(String) }
+        required(:expires_on) { |val| val.is_a?(Date) }
+      end
+
+      required(:client_id) { |val| val.is_a?(String) && Contracts::TOPIC_REGEXP.match?(val) }
+      required(:concurrency) { |val| val.is_a?(Integer) && val.positive? }
+      required(:consumer_mapper) { |val| !val.nil? }
+      required(:consumer_persistence) { |val| [true, false].include?(val) }
+      required(:pause_timeout) { |val| val.is_a?(Integer) && val.positive? }
+      required(:pause_max_timeout) { |val| val.is_a?(Integer) && val.positive? }
+      required(:pause_with_exponential_backoff) { |val| [true, false].include?(val) }
+      required(:shutdown_timeout) { |val| val.is_a?(Integer) && val.positive? }
+      required(:max_wait_time) { |val| val.is_a?(Integer) && val.positive? }
+      required(:kafka) { |val| val.is_a?(Hash) && !val.empty? }
+
+      # We validate internals just to be sure, that they are present and working
+      nested(:internal) do
+        required(:status) { |val| !val.nil? }
+        required(:process) { |val| !val.nil? }
+
+        nested(:routing) do
+          required(:builder) { |val| !val.nil? }
+          required(:subscription_groups_builder) { |val| !val.nil? }
+        end
+
+        nested(:processing) do
+          required(:jobs_builder) { |val| !val.nil? }
+          required(:scheduler) { |val| !val.nil? }
+          required(:coordinator_class) { |val| !val.nil? }
+          required(:partitioner_class) { |val| !val.nil? }
         end
 
-        required(:client_id).filled(:str?, format?: Karafka::Contracts::TOPIC_REGEXP)
-        required(:concurrency) { int? & gt?(0) }
-        required(:consumer_mapper).filled
-        required(:consumer_persistence).filled(:bool?)
-        required(:pause_timeout) { int? & gt?(0) }
-        required(:pause_max_timeout) { int? & gt?(0) }
-        required(:pause_with_exponential_backoff).filled(:bool?)
-        required(:shutdown_timeout) { int? & gt?(0) }
-        required(:max_wait_time) { int? & gt?(0) }
-        required(:kafka).filled(:hash)
-
-        # We validate internals just to be sure, that they are present and working
-        required(:internal).schema do
-          required(:status)
-          required(:process)
-
-          required(:routing).schema do
-            required(:builder)
-            required(:subscription_groups_builder)
-          end
-
-          required(:processing).schema do
-            required(:jobs_builder)
-            required(:scheduler)
-            required(:coordinator_class)
-            required(:partitioner_class)
-          end
-
-          required(:active_job).schema do
-            required(:dispatcher)
-            required(:job_options_contract)
-            required(:consumer_class)
-          end
+        nested(:active_job) do
+          required(:dispatcher) { |val| !val.nil? }
+          required(:job_options_contract) { |val| !val.nil? }
+          required(:consumer_class) { |val| !val.nil? }
         end
       end
 
-      # rdkafka requires all the keys to be strings, so we ensure that
-      rule(:kafka) do
-        next unless value.is_a?(Hash)
+      virtual do |data, errors|
+        next unless errors.empty?
+
+        detected_errors = []
 
-        value.each_key do |key|
+        data.fetch(:kafka).each_key do |key|
           next if key.is_a?(Symbol)
 
-          key(:"kafka.#{key}").failure(:kafka_key_must_be_a_symbol)
+          detected_errors << [[:kafka, key], :key_must_be_a_symbol]
         end
+
+        detected_errors
       end
 
-      rule(:pause_timeout, :pause_max_timeout) do
-        if values[:pause_timeout].to_i > values[:pause_max_timeout].to_i
-          key(:pause_timeout).failure(:max_timeout_vs_pause_max_timeout)
-        end
+      virtual do |data, errors|
+        next unless errors.empty?
+
+        pause_timeout = data.fetch(:pause_timeout)
+        pause_max_timeout = data.fetch(:pause_max_timeout)
+
+        next if pause_timeout <= pause_max_timeout
+
+        [[%i[pause_timeout], :max_timeout_vs_pause_max_timeout]]
       end
 
-      rule(:shutdown_timeout, :max_wait_time) do
-        if values[:max_wait_time].to_i >= values[:shutdown_timeout].to_i
-          key(:shutdown_timeout).failure(:shutdown_timeout_vs_max_wait_time)
-        end
+      virtual do |data, errors|
+        next unless errors.empty?
+
+        shutdown_timeout = data.fetch(:shutdown_timeout)
+        max_wait_time = data.fetch(:max_wait_time)
+
+        next if max_wait_time < shutdown_timeout
+
+        [[%i[shutdown_timeout], :shutdown_timeout_vs_max_wait_time]]
       end
     end
   end

data/lib/karafka/contracts/consumer_group.rb

@@ -4,32 +4,39 @@ module Karafka
   module Contracts
     # Contract for single full route (consumer group + topics) validation.
     class ConsumerGroup < Base
-      # Internal contract for sub-validating topics schema
-      TOPIC_CONTRACT = ConsumerGroupTopic.new.freeze
+      configure do |config|
+        config.error_messages = YAML.safe_load(
+          File.read(
+            File.join(Karafka.gem_root, 'config', 'errors.yml')
+          )
+        ).fetch('en').fetch('validations').fetch('consumer_group')
+      end
 
-      private_constant :TOPIC_CONTRACT
+      required(:id) { |id| id.is_a?(String) && Contracts::TOPIC_REGEXP.match?(id) }
+      required(:topics) { |topics| topics.is_a?(Array) && !topics.empty? }
 
-      params do
-        required(:id).filled(:str?, format?: Karafka::Contracts::TOPIC_REGEXP)
-        required(:topics).value(:array, :filled?)
-      end
+      virtual do |data, errors|
+        next unless errors.empty?
 
-      rule(:topics) do
-        if value.is_a?(Array)
-          names = value.map { |topic| topic[:name] }
+        names = data.fetch(:topics).map { |topic| topic[:name] }
 
-          key.failure(:topics_names_not_unique) if names.size != names.uniq.size
-        end
+        next if names.size == names.uniq.size
+
+        [[%i[topics], :names_not_unique]]
       end
 
-      rule(:topics) do
-        if value.is_a?(Array)
-          value.each_with_index do |topic, index|
-            TOPIC_CONTRACT.call(topic).errors.each do |error|
-              key([:topics, index, error.path[0]]).failure(error.text)
-            end
+      virtual do |data, errors|
+        next unless errors.empty?
+
+        fetched_errors = []
+
+        data.fetch(:topics).each do |topic|
+          ConsumerGroupTopic.new.call(topic).errors.each do |key, value|
+            fetched_errors << [[topic, key].flatten, value]
           end
         end
+
+        fetched_errors
       end
     end
   end

data/lib/karafka/contracts/consumer_group_topic.rb

@@ -4,24 +4,38 @@ module Karafka
   module Contracts
     # Consumer group topic validation rules.
     class ConsumerGroupTopic < Base
-      params do
-        required(:consumer).filled
-        required(:deserializer).filled
-        required(:id).filled(:str?, format?: Karafka::Contracts::TOPIC_REGEXP)
-        required(:kafka).filled
-        required(:max_messages) { int? & gteq?(1) }
-        required(:initial_offset).filled(included_in?: %w[earliest latest])
-        required(:max_wait_time).filled { int? & gteq?(10) }
-        required(:manual_offset_management).filled(:bool?)
-        required(:name).filled(:str?, format?: Karafka::Contracts::TOPIC_REGEXP)
+      configure do |config|
+        config.error_messages = YAML.safe_load(
+          File.read(
+            File.join(Karafka.gem_root, 'config', 'errors.yml')
+          )
+        ).fetch('en').fetch('validations').fetch('consumer_group_topic')
       end
 
-      rule(:kafka) do
-        # This will trigger rdkafka validations that we catch and re-map the info and use dry
-        # compatible format
-        Rdkafka::Config.new(value).send(:native_config)
-      rescue Rdkafka::Config::ConfigError => e
-        key(:kafka).failure(e.message)
+      required(:consumer) { |consumer_group| !consumer_group.nil? }
+      required(:deserializer) { |deserializer| !deserializer.nil? }
+      required(:id) { |id| id.is_a?(String) && Contracts::TOPIC_REGEXP.match?(id) }
+      required(:kafka) { |kafka| kafka.is_a?(Hash) && !kafka.empty? }
+      required(:max_messages) { |mm| mm.is_a?(Integer) && mm >= 1 }
+      required(:initial_offset) { |io| %w[earliest latest].include?(io) }
+      required(:max_wait_time) { |mwt| mwt.is_a?(Integer) && mwt >= 10 }
+      required(:manual_offset_management) { |mmm| [true, false].include?(mmm) }
+      required(:name) { |name| name.is_a?(String) && Contracts::TOPIC_REGEXP.match?(name) }
+
+      virtual do |data, errors|
+        next unless errors.empty?
+
+        value = data.fetch(:kafka)
+
+        begin
+          # This will trigger rdkafka validations that we catch and re-map the info and use dry
+          # compatible format
+          Rdkafka::Config.new(value).send(:native_config)
+
+          nil
+        rescue Rdkafka::Config::ConfigError => e
+          [[%w[kafka], e.message]]
+        end
       end
     end
   end

data/lib/karafka/contracts/server_cli_options.rb

@@ -4,17 +4,28 @@ module Karafka
   module Contracts
     # Contract for validating correctness of the server cli command options.
     class ServerCliOptions < Base
-      params do
-        optional(:consumer_groups).value(:array, :filled?)
+      configure do |config|
+        config.error_messages = YAML.safe_load(
+          File.read(
+            File.join(Karafka.gem_root, 'config', 'errors.yml')
+          )
+        ).fetch('en').fetch('validations').fetch('server_cli_options')
       end
 
-      rule(:consumer_groups) do
+      optional(:consumer_groups) { |cg| cg.is_a?(Array) && !cg.empty? }
+
+      virtual do |data, errors|
+        next unless errors.empty?
+        next unless data.key?(:consumer_groups)
+
+        value = data.fetch(:consumer_groups)
+
         # If there were no consumer_groups declared in the server cli, it means that we will
         # run all of them and no need to validate them here at all
-        if !value.nil? &&
-           !(value - Karafka::App.config.internal.routing.builder.map(&:name)).empty?
-          key(:consumer_groups).failure(:consumer_groups_inclusion)
-        end
+        next if value.nil?
+        next if (value - Karafka::App.config.internal.routing.builder.map(&:name)).empty?
+
+        [[%i[consumer_groups], :consumer_groups_inclusion]]
       end
     end
   end

data/lib/karafka/errors.rb

@@ -24,9 +24,6 @@ module Karafka
     # Raised when we try to use Karafka CLI commands (except install) without a boot file
     MissingBootFileError = Class.new(BaseError)
 
-    # Raised when want to hook up to an event that is not registered and supported
-    UnregisteredMonitorEventError = Class.new(BaseError)
-
     # Raised when we've waited enough for shutting down a non-responsive process
     ForcefulShutdownError = Class.new(BaseError)
 

data/lib/karafka/helpers/colorize.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Helpers
+    # Simple wrapper for adding colors to strings
+    module Colorize
+      # @param string [String] string we want to have in green
+      # @return [String] green string
+      def green(string)
+        "\033[0;32m#{string}\033[0m"
+      end
+
+      # @param string [String] string we want to have in red
+      # @return [String] red string
+      def red(string)
+        "\033[0;31m#{string}\033[0m"
+      end
+    end
+  end
+end

data/lib/karafka/instrumentation/logger_listener.rb

@@ -18,7 +18,7 @@ module Karafka
       # @param event [Dry::Events::Event] event details including payload
       def on_connection_listener_fetch_loop(event)
         listener = event[:caller]
-        info "[#{listener.id}] Polling messages..."
+        debug "[#{listener.id}] Polling messages..."
       end
 
       # Logs about messages that we've received from Kafka
@@ -28,7 +28,13 @@ module Karafka
         listener = event[:caller]
         time = event[:time]
         messages_count = event[:messages_buffer].size
-        info "[#{listener.id}] Polled #{messages_count} messages in #{time}ms"
+
+        message = "[#{listener.id}] Polled #{messages_count} messages in #{time}ms"
+
+        # We don't want the "polled 0" in dev as it would spam the log
+        # Instead we publish only info when there was anything we could poll and fail over to the
+        # zero notifications when in debug mode
+        messages_count.zero? ? debug(message) : info(message)
       end
 
       # Prints info about the fact that a given job has started

data/lib/karafka/instrumentation/monitor.rb

@@ -1,66 +1,21 @@
 # frozen_string_literal: true
 
 module Karafka
-  # Namespace for all the things related with Karafka instrumentation process
   module Instrumentation
-    # Monitor is used to hookup external monitoring services to monitor how Karafka works
-    # It provides a standardized API for checking incoming messages/enqueueing etc
-    # Since it is a pub-sub based on dry-monitor, you can use as many subscribers/loggers at the
-    # same time, which means that you might have for example file logging and NewRelic at the same
-    # time
-    # @note This class acts as a singleton because we are only permitted to have single monitor
-    #   per running process (just as logger)
-    class Monitor < Dry::Monitor::Notifications
-      # List of events that we support in the system and to which a monitor client can hook up
-      # @note The non-error once support timestamp benchmarking
-      # @note Depending on Karafka extensions and additional engines, this might not be the
-      #   complete list of all the events. Please use the #available_events on fully loaded
-      #   Karafka system to determine all of the events you can use.
-      BASE_EVENTS = %w[
-        app.initialized
-        app.running
-        app.stopping
-        app.stopped
-
-        consumer.consumed
-        consumer.revoked
-        consumer.shutdown
-
-        process.notice_signal
-
-        connection.listener.before_fetch_loop
-        connection.listener.fetch_loop
-        connection.listener.fetch_loop.received
-
-        worker.process
-        worker.processed
-
-        statistics.emitted
-
-        error.occurred
-      ].freeze
-
-      private_constant :BASE_EVENTS
-
-      # @return [Karafka::Instrumentation::Monitor] monitor instance for system instrumentation
-      def initialize
-        super(:karafka)
-        BASE_EVENTS.each(&method(:register_event))
-      end
-
-      # Allows us to subscribe to events with a code that will be yielded upon events
-      # @param event_name_or_listener [String, Object] name of the event we want to subscribe to
-      #   or a listener if we decide to go with object listener
-      def subscribe(event_name_or_listener)
-        return super unless event_name_or_listener.is_a?(String)
-        return super if available_events.include?(event_name_or_listener)
-
-        raise Errors::UnregisteredMonitorEventError, event_name_or_listener
-      end
-
-      # @return [Array<String>] names of available events to which we can subscribe
-      def available_events
-        __bus__.events.keys
+    # Karafka instrumentation monitor that we use to publish events
+    # By default uses our internal notifications bus but can be used with
+    # `ActiveSupport::Notifications` as well
+    class Monitor < ::Karafka::Core::Monitoring::Monitor
+      attr_reader :notifications_bus
+
+      # @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 = ::Karafka::Instrumentation::Notifications.new,
+        namespace = nil
+      )
+        super(notifications_bus, namespace)
       end
     end
   end

data/lib/karafka/instrumentation/notifications.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Karafka
+  # Namespace for all the things related with Karafka instrumentation process
+  module Instrumentation
+    # Monitor is used to hookup external monitoring services to monitor how Karafka works
+    # It provides a standardized API for checking incoming messages/enqueueing etc
+    # Since it is a pub-sub based on dry-monitor, you can use as many subscribers/loggers at the
+    # same time, which means that you might have for example file logging and NewRelic at the same
+    # time
+    # @note This class acts as a singleton because we are only permitted to have single monitor
+    #   per running process (just as logger)
+    class Notifications < Karafka::Core::Monitoring::Notifications
+      # List of events that we support in the system and to which a monitor client can hook up
+      # @note The non-error once support timestamp benchmarking
+      # @note Depending on Karafka extensions and additional engines, this might not be the
+      #   complete list of all the events. Please use the #available_events on fully loaded
+      #   Karafka system to determine all of the events you can use.
+      EVENTS = %w[
+        app.initialized
+        app.running
+        app.stopping
+        app.stopped
+
+        consumer.consumed
+        consumer.revoked
+        consumer.shutdown
+
+        process.notice_signal
+
+        connection.listener.before_fetch_loop
+        connection.listener.fetch_loop
+        connection.listener.fetch_loop.received
+
+        worker.process
+        worker.processed
+
+        statistics.emitted
+
+        error.occurred
+      ].freeze
+
+      private_constant :EVENTS
+
+      # @return [Karafka::Instrumentation::Monitor] monitor instance for system instrumentation
+      def initialize
+        super
+        EVENTS.each { |event| register_event(event) }
+      end
+    end
+  end
+end

data/lib/karafka/instrumentation/vendors/datadog/dashboard.json

@@ -0,0 +1 @@
+{"title":"Karafka monitoring dashboard","description":"","widgets":[{"id":7444969424381053,"definition":{"title":"Stability & errors","type":"group","show_title":true,"layout_type":"ordered","widgets":[{"id":8304008422587936,"definition":{"title":"Client connects and disconnects","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Connects","formula":"query1"},{"alias":"Disconnects","formula":"query2"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.connection.connects{*} by {host}.as_count()","data_source":"metrics","name":"query1"},{"query":"sum:karafka.connection.disconnects{*} by {host}.as_count()","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"bars"}]},"layout":{"x":0,"y":0,"width":4,"height":2}},{"id":3722865443336921,"definition":{"title":"Errors encountered (any)","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"in-karafka errors","formula":"query1"},{"alias":"librdkafka consume errors","formula":"query2"},{"alias":"librdkafka receive errors","formula":"query3"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.error_occurred{*} by {type}.as_count()","data_source":"metrics","name":"query1"},{"query":"sum:karafka.consume.errors{*}.as_count()","data_source":"metrics","name":"query2"},{"query":"sum:karafka.receive.errors{*}.as_count()","data_source":"metrics","name":"query3"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":4,"y":0,"width":4,"height":2}},{"id":5477381252952760,"definition":{"title":"Processing errors","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"formula":"query1"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.error_occurred{type:consumer.consume.error} by {partition,topic}.as_count()","data_source":"metrics","name":"query1"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":8,"y":0,"width":4,"height":2}},{"id":2357301680769076,"definition":{"title":"Processing errors rate per topic","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"% error rate per topic","formula":"(query1 / (query1 + query2)) * 100"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.error_occurred{type:consumer.consume.error} by {topic,partition}.as_count()","data_source":"metrics","name":"query1"},{"query":"sum:karafka.consumer.batches{*} by {topic,partition}.as_count()","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"bars"}]},"layout":{"x":0,"y":2,"width":4,"height":2}},{"id":3902930069982135,"definition":{"title":"Batches successful vs failures","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Successfully processed batch","formula":"query1"},{"alias":"Batch processing with error","formula":"query2"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.consumer.batches{*} by {partition,topic}.as_count()","data_source":"metrics","name":"query1"},{"query":"avg:karafka.error_occurred{type:consumer.consume.error} by {partition,topic}.as_count()","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":4,"y":2,"width":4,"height":2}},{"id":718749162159145,"definition":{"title":"Consumer instances revocations and shutdowns","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Consumer instances revokations","formula":"query1"},{"alias":"Consumer instances shutdowns","formula":"query2"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.consumer.revoked{*}.as_count()","data_source":"metrics","name":"query1"},{"query":"sum:karafka.consumer.shutdown{*}.as_count()","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":8,"y":2,"width":4,"height":2}}]},"layout":{"x":0,"y":0,"width":12,"height":5}},{"id":5988438511387100,"definition":{"title":"Workers poll","type":"group","show_title":true,"layout_type":"ordered","widgets":[{"id":8769294644934352,"definition":{"title":"Enqueued jobs","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Enqueued jobs","formula":"query1"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.worker.enqueued_jobs.avg{*}","data_source":"metrics","name":"query1"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":0,"y":0,"width":4,"height":2}},{"id":2714502141463873,"definition":{"title":"Workers usage","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Busy workers (p95)","formula":"query1"},{"alias":"Total workers","formula":"query2"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.worker.processing.95percentile{*}","data_source":"metrics","name":"query1"},{"query":"sum:karafka.worker.total_threads{*}","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":4,"y":0,"width":4,"height":2}},{"id":5370086629441984,"definition":{"title":"Workers % utilization","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"% workers utilization","formula":"(query1 / query2) * 100"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.worker.processing.95percentile{*}","data_source":"metrics","name":"query1"},{"query":"sum:karafka.worker.total_threads{*}","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":8,"y":0,"width":4,"height":2}}]},"layout":{"x":0,"y":5,"width":12,"height":3}},{"id":8544040083223278,"definition":{"title":"Throughput ","type":"group","show_title":true,"layout_type":"ordered","widgets":[{"id":3740207481939733,"definition":{"title":"Offset lag changes","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"formula":"derivative(query1)"}],"response_format":"timeseries","queries":[{"query":"max:karafka.consumer.offset{*} by {topic,partition}","data_source":"metrics","name":"query1"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":0,"y":0,"width":4,"height":2}},{"id":6319110548544878,"definition":{"title":"Batches processed per topic","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"formula":"query1"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.consumer.batches{*} by {partition,topic}.as_count()","data_source":"metrics","name":"query1"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":4,"y":0,"width":4,"height":2}},{"id":6232784865331443,"definition":{"title":"Messages consumed per topic","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Messages consumed","formula":"query1"},{"alias":"Average batch size","formula":"query1 / query2"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.consumer.messages{*} by {partition,topic}.as_count()","data_source":"metrics","name":"query1"},{"query":"sum:karafka.consumer.batches{*} by {partition,topic}.as_count()","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":8,"y":0,"width":4,"height":2}},{"id":2321394598982770,"definition":{"title":"Consumption lag (in seconds)","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Consumption lag in s (max)","formula":"query2 / 1000"},{"alias":"Consumption lag in s (avg)","formula":"query3 / 1000"},{"alias":"Consumption lag in s (p95)","formula":"query1 / 1000"}],"response_format":"timeseries","queries":[{"query":"max:karafka.consumer.consumption_lag.max{*}","data_source":"metrics","name":"query2"},{"query":"max:karafka.consumer.consumption_lag.avg{*}","data_source":"metrics","name":"query3"},{"query":"max:karafka.consumer.consumption_lag.95percentile{*}","data_source":"metrics","name":"query1"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":0,"y":2,"width":4,"height":2}},{"id":1062074781483741,"definition":{"title":"Processing lag (in ms)","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Processing lag in ms (p95)","formula":"query1"},{"alias":"Processing lag in ms (max)","formula":"query2"},{"alias":"Processing lag in ms (avg)","formula":"query3"}],"response_format":"timeseries","queries":[{"query":"max:karafka.consumer.processing_lag.95percentile{*}","data_source":"metrics","name":"query1"},{"query":"max:karafka.consumer.processing_lag.max{*}","data_source":"metrics","name":"query2"},{"query":"max:karafka.consumer.processing_lag.avg{*}","data_source":"metrics","name":"query3"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":4,"y":2,"width":4,"height":2}},{"id":7497794728674267,"definition":{"title":"Batch processing time","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"formula":"query1"},{"formula":"query2"},{"formula":"query3"}],"response_format":"timeseries","queries":[{"query":"max:karafka.consumer.consumed.time_taken.95percentile{*} by {topic,partition}","data_source":"metrics","name":"query1"},{"query":"max:karafka.consumer.consumed.time_taken.max{*} by {topic,partition}","data_source":"metrics","name":"query2"},{"query":"max:karafka.consumer.consumed.time_taken.avg{*} by {topic,partition}","data_source":"metrics","name":"query3"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":8,"y":2,"width":4,"height":2}},{"id":4192833027984161,"definition":{"title":"Batch size per topic","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Batch size p95","formula":"query1"},{"alias":"Batch size avg","formula":"query2"},{"alias":"Batch size max","formula":"query3"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.consumer.batch_size.95percentile{*} by {partition,topic}","data_source":"metrics","name":"query1"},{"query":"sum:karafka.consumer.batch_size.avg{*} by {partition,topic}","data_source":"metrics","name":"query2"},{"query":"sum:karafka.consumer.batch_size.max{*} by {partition,topic}","data_source":"metrics","name":"query3"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":0,"y":4,"width":4,"height":2}},{"id":4741598444771147,"definition":{"title":"Messages consumed overall","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"type":"timeseries","requests":[{"formulas":[{"alias":"Messages consumed","formula":"query1"},{"alias":"Average batch size","formula":"query1 / query2"}],"response_format":"timeseries","queries":[{"query":"sum:karafka.consumer.messages{*}.as_count()","data_source":"metrics","name":"query1"},{"query":"sum:karafka.consumer.batches{*}.as_count()","data_source":"metrics","name":"query2"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":4,"y":4,"width":4,"height":2}},{"id":4502534794102513,"definition":{"title":"Polling times (ms)","title_size":"16","title_align":"left","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"time":{},"type":"timeseries","requests":[{"formulas":[{"alias":"p95 ms polling time","formula":"query1"},{"alias":"max ms polling time","formula":"query2"},{"alias":"average ms polling time","formula":"query3"}],"queries":[{"name":"query1","data_source":"metrics","query":"avg:karafka.listener.polling.time_taken.95percentile{*}"},{"name":"query2","data_source":"metrics","query":"avg:karafka.listener.polling.time_taken.max{*}"},{"name":"query3","data_source":"metrics","query":"avg:karafka.listener.polling.time_taken.avg{*}"}],"response_format":"timeseries","style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"layout":{"x":8,"y":4,"width":4,"height":2}}]},"layout":{"x":0,"y":0,"width":12,"height":7,"is_column_break":true}}],"template_variables":[],"layout_type":"ordered","is_read_only":false,"notify_list":[],"reflow_type":"fixed","id":"s3u-z47-i6u"}