karafka-web 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f1a21a4136ff16a20aabb6e3d39777d9dc93943ad335ab15381b8e9ccdc1a8a
+  data.tar.gz: 68b24c874186d4800e08f059cdc9bdb6ee6269b4b9374d52c3cf41d233873bca
+SHA512:
+  metadata.gz: 285a69c0999734181949672a51aa4f38e6cbe5c64c5cbc869a92a8647aac7a285fadfc08bd98e53d30d2526ad1fd8ebee6289f22f46ab2b8280aa23e036a9816
+  data.tar.gz: 7f5ee73bcbc904f1c4c6f7922cb631f9b55075c2a2b0912668489c89d63cd02106594e92520e1848b5ba2fe2e155b37aedcc04f601c2c5b6f571f1ec14230959

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+4zﳒ$)-_ͧwIGeo����`�F$b�ڰ�t9�
+����lg��3:S�dd)��Γ���Uylp��b'��o�Jv��?��;����'�߻�7 ~�Un:k���^ѹ��k�Y�ˑ	�O��<%����J��C�F�\�VSJ���m�v�,
+��j��ȕ��c�I$�5F!I�1#��F�<��B�����5����?\!�]�X��M������"��<b2�%��� ��s�E�cc��>n�ՑH�0��	�Q'����s����)�[�ߌ�k)�����5�{f��w�Y)�����T�'͜��7�$o��.���a�h��ɏX�3ډ
� �t#eW���^w0��ԙ&��Q�

data/.coditsu/ci.yml

@@ -0,0 +1,3 @@
+repository_id: '1f6176a1-ea6b-4927-96e5-a6bea52dbab9'
+api_key: <%= ENV['CODITSU_API_KEY'] %>
+api_secret: <%= ENV['CODITSU_API_SECRET'] %>

data/.diffend.yml

@@ -0,0 +1,3 @@
+project_id: 'b06f89cd-51df-4ccb-96b3-a48f010f64b5'
+shareable_id: 'b0e304f8-fc9c-4eac-bb1e-b076c8d05100'
+shareable_key: 'a695a444-1509-470e-9e62-96479c3efd8b'

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ['https://karafka.io/#become-pro']

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,50 @@
+---
+name: Bug Report
+about: Report an issue with Karafka you've discovered.
+---
+
+*Be clear, concise and precise in your description of the problem.
+Open an issue with a descriptive title and a summary in grammatically correct,
+complete sentences.*
+
+*Use the template below when reporting bugs. Please, make sure that
+you're running the latest stable Karafka and that the problem you're reporting
+hasn't been reported (and potentially fixed) already.*
+
+*Before filing the ticket you should replace all text above the horizontal
+rule with your own words.*
+
+--------
+
+## Expected behavior
+
+Describe here how you expected Karafka to behave in this particular situation.
+
+## Actual behavior
+
+Describe here what actually happened.
+
+## Steps to reproduce the problem
+
+This is extremely important! Providing us with a reliable way to reproduce
+a problem will expedite its solution.
+
+## Your setup details
+
+Please provide kafka version and the output of `karafka info` or `bundle exec karafka info` if using Bundler.
+
+Here's an example:
+
+```
+$ [bundle exec] karafka info
+Karafka version: 1.3.0
+Ruby version: 2.6.3
+Ruby-kafka version: 0.7.9
+Application client id: karafka-local
+Backend: inline
+Batch fetching: true
+Batch consuming: true
+Boot file: /app/karafka/karafka.rb
+Environment: development
+Kafka seed brokers: ["kafka://kafka:9092"]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest new Karafka features or improvements to existing features.
+---
+
+## Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: ci
+
+concurrency: ci-${{ github.ref }}
+
+on:
+  pull_request:
+  push:
+  schedule:
+    - cron:  '0 1 * * *'
+
+env:
+  BUNDLE_RETRY: 6
+  BUNDLE_JOBS: 4
+
+jobs:
+  diffend:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+
+      - name: Install Diffend plugin
+        run: bundle plugin install diffend
+
+      - name: Bundle Secure
+        run: bundle secure
+
+  coditsu:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Run Coditsu
+        env:
+          CODITSU_API_KEY: ${{ secrets.CODITSU_API_KEY }}
+          CODITSU_API_SECRET: ${{ secrets.CODITSU_API_SECRET }}
+        run: \curl -sSL https://api.coditsu.io/run/ci | bash

data/.gitignore

@@ -0,0 +1,69 @@
+# bundler state
+/.bundle
+/vendor/bundle/
+/vendor/ruby/
+/ruby/
+app.god
+
+# minimal Rails specific artifacts
+/.coditsu/local.yml
+db/*.sqlite3
+/log/development.log
+/log/production.log
+/log/test.log
+/tmp/*
+*.gem
+*.~
+
+# various artifacts
+**.war
+*.rbc
+*.sassc
+.byebug_history
+.redcar/
+.capistrano/
+.sass-cache
+/config/god/sidekiq.rb
+/config/puma.rb
+/coverage.data
+/coverage/
+/doc/api/
+/doc/app/
+/doc/yard
+/doc/features.html
+/doc/specs.html
+/spec/tmp/*
+/cache
+/capybara*
+/capybara-*.html
+/gems
+/specifications
+rerun.txt
+pickle-email-*.html
+
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+#
+# Here are some files you may want to ignore globally:
+
+# scm revert files
+**.orig
+
+# Mac finder artifacts
+.DS_Store
+
+# Netbeans project directory
+/nbproject
+
+# RubyMine project files
+.idea
+
+# Textmate project files
+/*.tmproj
+
+# vim artifacts
+**.swp
+
+# documentation
+.yardoc

data/.ruby-gemset

@@ -0,0 +1 @@
+karafka-web

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Karafka Web changelog
+
+## 0.1.1 (Unreleased)
+- Rename `Karafka::Web.bootstrap_topics!` to `Karafka::Web.bootstrap!` and expand it with the zero state injection.
+- Require Karafka `2.0.28` due to some instrumentation fixes.
+- Provide an auto-installer under the `bundle exec karafka-web install` command.
+
+## 0.1.0
+- Initial code of the Web and Web Pro

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at maciej@mensfeld.pl. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+plugin 'diffend'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    karafka-web (0.1.0)
+      erubi (~> 1.4)
+      karafka (>= 2.0.29, < 3.0.0)
+      roda (~> 3.63)
+      tilt (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.2.0)
+    erubi (1.12.0)
+    ffi (1.15.5)
+    karafka (2.0.29)
+      karafka-core (>= 2.0.9, < 3.0.0)
+      thor (>= 0.20)
+      waterdrop (>= 2.4.10, < 3.0.0)
+      zeitwerk (~> 2.3)
+    karafka-core (2.0.9)
+      concurrent-ruby (>= 1.1)
+      karafka-rdkafka (>= 0.12)
+    karafka-rdkafka (0.12.0)
+      ffi (~> 1.15)
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    mini_portile2 (2.8.1)
+    rack (3.0.4.1)
+    rackup (0.2.3)
+      rack (>= 3.0.0.beta1)
+      webrick
+    rake (13.0.6)
+    roda (3.64.0)
+      rack
+    thor (1.2.1)
+    tilt (2.0.11)
+    waterdrop (2.4.10)
+      karafka-core (>= 2.0.9, < 3.0.0)
+      zeitwerk (~> 2.3)
+    webrick (1.8.1)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  karafka-web!
+  rackup (~> 0.2)
+
+BUNDLED WITH
+   2.4.5

data/LICENSE

@@ -0,0 +1,17 @@
+Copyright (c) Maciej Mensfeld
+
+Karafka Web is part of Karafka and it is an Open Source project licensed under the terms of
+the LGPLv3 license. Please see <https://github.com/karafka/karafka/blob/master/LGPL>
+for license text.
+
+Karafka has also commercial-friendly license, commercial support and commercial components.
+
+All of the commercial components are present in the lib/karafka/pro and lib/karafka/web/ui/pro
+directory of this repository and their usage requires commercial license agreement.
+
+By sending a pull request to the pro components, you are agreeing to transfer the copyright of your
+code to Maciej Mensfeld.
+
+You can find the commercial license in LICENSE-COMM.
+
+Please see https://karafka.io for purchasing options.

data/README.md

@@ -0,0 +1,29 @@
+# Karafka Web
+
+[![Build Status](https://github.com/karafka/karafka-web/workflows/ci/badge.svg)](https://github.com/karafka/karafka-web/actions?query=workflow%3Aci)
+[![Gem Version](https://badge.fury.io/rb/karafka-web.svg)](http://badge.fury.io/rb/karafka-web)
+[![Join the chat at https://slack.karafka.io](https://raw.githubusercontent.com/karafka/misc/master/slack.svg)](https://slack.karafka.io)
+
+Karafka Web UI is a user interface for the [Karafka framework](https://github.com/karafka/karafka). The Web UI provides a convenient way for developers to monitor and manage their Karafka-based applications, without the need to use the command line or third party software.
+
+It allows for easy access to various metrics, such as the number of messages consumed, the number of errors, and the number of consumers operating. It also provides a way to view the different Kafka topics, consumers, and groups that are being used by the application.
+
+## Getting started
+
+Karafka Web UI documentation is part of the Karafka framework documentation and can be found [here](https://karafka.io/docs).
+
+![karafka web ui dashboard](https://raw.githubusercontent.com/karafka/misc/master/printscreens/web-ui.png)
+
+## Karafka Pro Enhanced Web UI
+
+The Enhanced Web UI, aside from all the features from the OSS version, also offers additional features and capabilities not available in the free version, making it a better option for those looking for more robust monitoring and management capabilities for their Karafka applications. Some of the key benefits of the Enhanced Web UI version include the following:
+
+- Enhanced consumers utilization metrics providing much better insights into processes resources utilization.
+- Consumer process inspection to quickly analyze the state of a given consuming process.
+- Consumer jobs inspection to view currently running jobs on a per-process basis.
+- Health dashboard containing general consumption overview information
+- Data Explorer allowing for viewing and exploring the data produced to Kafka topics. It understands the routing table and can deserialize data before it is displayed.
+- Enhanced error reporting allowing for backtrace inspection and providing multi-partition support.
+- DLQ / Dead insights allowing to navigate through DLQ topics and messages that were dispatched to them.
+
+Help me provide high-quality open-source software. Please see the Karafka [homepage](https://karafka.io) for more details.

data/bin/karafka-web

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'karafka'
+require 'karafka/web'
+
+::Karafka::Cli::Base.load
+include ::Karafka::Helpers::Colorize
+
+case ARGV[0]
+when 'install'
+  puts
+  puts 'Installing Karafka Web UI...'
+  puts
+  puts 'Creating necessary topics and populating state data...'
+  Karafka::Web.bootstrap!
+  puts 'Updating the Karafka boot file...'
+
+  enabler = 'Karafka::Web.enable!'
+
+  if File.read(Karafka.boot_file).include?(enabler)
+    puts "Web UI #{green('already')} installed."
+  else
+    File.open(Karafka.boot_file, 'a') do |f|
+      f << "\n#{enabler}\n"
+    end
+  end
+
+  puts
+  puts("Installation #{green('completed')}. Have fun!")
+  puts
+else
+  raise NotImplementedError, "#{ARGV[0]} is not supported"
+end

data/certs/cert_chain.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MRAwDgYDVQQDDAdjb250
+YWN0MRcwFQYKCZImiZPyLGQBGRYHa2FyYWZrYTESMBAGCgmSJomT8ixkARkWAmlv
+MB4XDTIyMDgxOTE3MjEzN1oXDTIzMDgxOTE3MjEzN1owPzEQMA4GA1UEAwwHY29u
+dGFjdDEXMBUGCgmSJomT8ixkARkWB2thcmFma2ExEjAQBgoJkiaJk/IsZAEZFgJp
+bzCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAODzeO3L6lxdATzMHKNW
+jFA/GGunoPuylO/BMzy8RiQHh7VIvysAKs0tHhTx3g2D0STDpF+hcQcPELFikiT2
+F+1wOHj/SsrK7VKqfA8+gq04hKc5sQoX2Egf9k3V0YJ3eZ6R/koHkQ8A0TVt0w6F
+ZQckoV4MqnEAx0g/FZN3mnHTlJ3VFLSBqJEIe+S6FZMl92mSv+hTrlUG8VaYxSfN
+lTCvnKk284F6QZq5XIENLRmcDd/3aPBLnLwNnyMyhB+6gK8cUO+CFlDO5tjo/aBA
+rUnl++wGG0JooF1ed0v+evOn9KoMBG6rHewcf79qJbVOscbD8qSAmo+sCXtcFryr
+KRMTB8gNbowJkFRJDEe8tfRy11u1fYzFg/qNO82FJd62rKAw2wN0C29yCeQOPRb1
+Cw9Y4ZwK9VFNEcV9L+3pHTHn2XfuZHtDaG198VweiF6raFO4yiEYccodH/USP0L5
+cbcCFtmu/4HDSxL1ByQXO84A0ybJuk3/+aPUSXe9C9U8fwIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUSlcEakb7gfn/5E2WY6z73BF/
+iZkwHQYDVR0RBBYwFIESY29udGFjdEBrYXJhZmthLmlvMB0GA1UdEgQWMBSBEmNv
+bnRhY3RAa2FyYWZrYS5pbzANBgkqhkiG9w0BAQsFAAOCAYEA1aS+E7RXJ1w9g9mJ
+G0NzFxe64OEuENosNlvYQCbRKGCXAU1qqelYkBQHseRgRKxLICrnypRo9IEobyHa
+vDnJ4r7Tsb34dleqQW2zY/obG+cia3Ym2JsegXWF7dDOzCXJ4FN8MFoT2jHlqLLw
+yrap0YO5zx0GSQ0Dwy8h2n2v2vanMEeCx7iNm3ERgR5WuN5sjzWoz2A/JLEEcK0C
+EnAGKCWAd1fuG8IemDjT1edsd5FyYR4bIX0m+99oDuFZyPiiIbalmyYiSBBp59Yb
+Q0P8zeBi4OfwCZNcxqz0KONmw9JLNv6DgyEAH5xe/4JzhMEgvIRiPj0pHfA7oqQF
+KUNqvD1KlxbEC+bZfE5IZhnqYLdld/Ksqd22FI1RBhiS1Ejfsj99LVIm9cBuZEY2
+Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
+MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
+-----END CERTIFICATE-----

data/config/locales/errors.yml

@@ -0,0 +1,9 @@
+en:
+  validations:
+    config:
+      missing: needs to be present
+
+    web:
+      missing: needs to be present
+      id_format: needs to be a String
+      format: is invalid

data/karafka-web.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'karafka/web/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'karafka-web'
+  spec.version     = ::Karafka::Web::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Maciej Mensfeld']
+  spec.email       = %w[contact@karafka.io]
+  spec.homepage    = 'https://karafka.io'
+  spec.summary     = 'Karafka ecosystem Web UI interface'
+  spec.description = 'Karafka ecosystem plug-and-play Web UI'
+  spec.licenses    = %w[LGPL-3.0 Commercial]
+
+  spec.add_dependency 'erubi', '~> 1.4'
+  spec.add_dependency 'karafka', '>= 2.0.29', '< 3.0.0'
+  spec.add_dependency 'roda', '~> 3.63'
+  spec.add_dependency 'tilt', '~> 2.0'
+
+  spec.add_development_dependency 'rackup', '~> 0.2'
+
+  if $PROGRAM_NAME.end_with?('gem')
+    spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+  end
+
+  spec.cert_chain    = %w[certs/cert_chain.pem]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables   = %w[karafka-web]
+  spec.require_paths = %w[lib]
+
+  spec.metadata = {
+    'funding_uri' => 'https://karafka.io/#become-pro',
+    'homepage_uri' => 'https://karafka.io',
+    'changelog_uri' => 'https://github.com/karafka/karafka-web/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/karafka/karafka-web/issues',
+    'source_code_uri' => 'https://github.com/karafka/karafka-web',
+    'documentation_uri' => 'https://karafka.io/docs',
+    'rubygems_mfa_required' => 'true'
+  }
+end

data/lib/karafka/web/app.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    # Proxy App that selects either Pro or regular app to handle the requests
+    class App
+      class << self
+        # @param env [Hash] Rack env
+        # @param block [Proc] Rack block
+        def call(env, &block)
+          handler = Karafka.pro? ? Ui::Pro::App : Ui::App
+          handler.call(env, &block)
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/config.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    # Karafka::Web configuration
+    class Config
+      include ::Karafka::Core::Configurable
+
+      # How long do we consider the process alive without receiving status info about it
+      # For this long we also display dead processes (shutdown) in the UI
+      # This is used both in the processing for eviction and in the UI
+      setting :ttl, default: 30_000
+
+      # Topics naming - used for processing and UI
+      setting :topics do
+        # All the errors encountered will be dispatched to this topic for inspection
+        setting :errors, default: 'karafka_errors'
+
+        setting :consumers do
+          # Reports containing particular consumer processes. This topic contains the heartbeat
+          # information sent from each consumer process.
+          setting :reports, default: 'karafka_consumers_reports'
+
+          # Topic for storing states aggregated info
+          setting :states, default: 'karafka_consumers_states'
+        end
+      end
+
+      # Tracking and reporting related settings
+      setting :tracking do
+        # Collects the metrics we will be dispatching
+        # Tracks and reports the collected metrics
+        setting :reporter, default: Tracking::Reporter.new
+
+        # How often should we report data from a single process
+        # You may set it to a lower value in development but in production and scale, every
+        # 5 seconds should be enough
+        setting :interval, default: 5_000
+
+        setting :consumers do
+          setting :sampler, default: Tracking::Consumers::Sampler.new
+
+          setting :listeners, default: [
+            Tracking::Consumers::Listeners::Status.new,
+            Tracking::Consumers::Listeners::Errors.new,
+            Tracking::Consumers::Listeners::Statistics.new,
+            Tracking::Consumers::Listeners::Pausing.new,
+            Tracking::Consumers::Listeners::Processing.new
+          ]
+        end
+
+        setting :producers do
+          setting :listeners, default: []
+        end
+      end
+
+      # States processing related settings
+      setting :processing do
+        # What should be the consumer group name for web consumer
+        setting :consumer_group, default: 'karafka_web'
+
+        # How often should we report the aggregated state
+        setting :interval, default: 1_000
+
+        setting :consumers do
+          setting :aggregator, default: Processing::Consumers::Aggregator.new
+        end
+      end
+
+      setting :ui do
+        # Should the payload be decrypted for the Pro Web UI. Default to `false` due to security
+        # reasons
+        setting :decrypt, default: false
+
+        # How many elements should we display on pages that support pagination
+        setting :per_page, default: 25
+      end
+    end
+  end
+end

data/lib/karafka/web/deserializer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    # Web reporting deserializer
+    #
+    # @note We use `symbolize_names` because we want to use the same convention of hash building
+    #   for producing, consuming and displaying metrics related data
+    class Deserializer
+      # @param message [::Karafka::Messages::Message]
+      # @return [Object] deserialized data
+      def call(message)
+        ::JSON.parse(
+          message.raw_payload,
+          symbolize_names: true
+        )
+      end
+    end
+  end
+end

data/lib/karafka/web/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    # Karafka::Web related errors
+    module Errors
+      # Tracking related errors
+      module Tracking
+        # Raised when the a report is not valid for any reason
+        # This should never happen and if you see this, please open an issue.
+        ContractError = Class.new(::Karafka::Errors::BaseError)
+      end
+
+      # Ui related errors
+      module Ui
+        # Raised when we cannot display a given view.
+        # This may mean, that request topic was not present or partition or a message.
+        NotFoundError = Class.new(::Karafka::Errors::BaseError)
+
+        # Raised whe a given feature is available for Pro but not pro used
+        ProOnlyError = Class.new(::Karafka::Errors::BaseError)
+      end
+    end
+  end
+end