karafka-web 0.1.0

data/lib/karafka/web.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+%w[
+  karafka
+  roda
+  etc
+  open3
+].each { |lib| require lib }
+
+module Karafka
+  # Karafka Web UI + Karafka web monitoring
+  module Web
+    class << self
+      # @return [String] root path of this gem
+      def gem_root
+        Pathname.new(File.expand_path('../..', __dir__))
+      end
+
+      # Sets up the whole configuration
+      # @param [Block] block configuration block
+      def setup(&block)
+        Config.configure(&block)
+      end
+
+      # @return [Karafka::Web::Config] config instance
+      def config
+        Config.config
+      end
+
+      # Creates all the needed topics for the admin UI to work and populates initial (empty) set
+      # of data, so the UI will work even when no Karafka servers are started
+      def bootstrap!
+        Installer.new.bootstrap!
+      end
+
+      # Activates all the needed routing and sets up listener, etc
+      # This needs to run **after** the optional configuration of the web component
+      def enable!
+        Installer.new.enable!
+      end
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+# Make sure pro is not loaded unless Pro
+loader.ignore(Karafka::Web.gem_root.join('lib/karafka/web/ui/pro'))
+
+# If license is detected, we can use loader without limitations
+Karafka::Licenser.detect do
+  loader = Zeitwerk::Loader.new
+end
+
+root = File.expand_path('..', __dir__)
+loader.tag = 'karafka-web'
+loader.inflector = Zeitwerk::GemInflector.new("#{root}/karafka/web.rb")
+loader.push_dir(root)
+
+loader.setup
+loader.eager_load

metadata

@@ -0,0 +1,328 @@
+--- !ruby/object:Gem::Specification
+name: karafka-web
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----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-----
+date: 2023-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: karafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.29
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.29
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.63'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.63'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Karafka ecosystem plug-and-play Web UI
+email:
+- contact@karafka.io
+executables:
+- karafka-web
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coditsu/ci.yml"
+- ".diffend.yml"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/karafka-web
+- certs/cert_chain.pem
+- config/locales/errors.yml
+- karafka-web.gemspec
+- lib/karafka/web.rb
+- lib/karafka/web/app.rb
+- lib/karafka/web/config.rb
+- lib/karafka/web/deserializer.rb
+- lib/karafka/web/errors.rb
+- lib/karafka/web/installer.rb
+- lib/karafka/web/processing/consumer.rb
+- lib/karafka/web/processing/consumers/aggregator.rb
+- lib/karafka/web/processing/consumers/state.rb
+- lib/karafka/web/tracking/base_contract.rb
+- lib/karafka/web/tracking/consumers/contracts/consumer_group.rb
+- lib/karafka/web/tracking/consumers/contracts/job.rb
+- lib/karafka/web/tracking/consumers/contracts/partition.rb
+- lib/karafka/web/tracking/consumers/contracts/report.rb
+- lib/karafka/web/tracking/consumers/contracts/topic.rb
+- lib/karafka/web/tracking/consumers/listeners/base.rb
+- lib/karafka/web/tracking/consumers/listeners/errors.rb
+- lib/karafka/web/tracking/consumers/listeners/pausing.rb
+- lib/karafka/web/tracking/consumers/listeners/processing.rb
+- lib/karafka/web/tracking/consumers/listeners/statistics.rb
+- lib/karafka/web/tracking/consumers/listeners/status.rb
+- lib/karafka/web/tracking/consumers/sampler.rb
+- lib/karafka/web/tracking/memoized_shell.rb
+- lib/karafka/web/tracking/reporter.rb
+- lib/karafka/web/tracking/ttl_array.rb
+- lib/karafka/web/tracking/ttl_hash.rb
+- lib/karafka/web/ui/app.rb
+- lib/karafka/web/ui/base.rb
+- lib/karafka/web/ui/controllers/base.rb
+- lib/karafka/web/ui/controllers/become_pro.rb
+- lib/karafka/web/ui/controllers/cluster.rb
+- lib/karafka/web/ui/controllers/consumers.rb
+- lib/karafka/web/ui/controllers/errors.rb
+- lib/karafka/web/ui/controllers/jobs.rb
+- lib/karafka/web/ui/controllers/requests/params.rb
+- lib/karafka/web/ui/controllers/responses/data.rb
+- lib/karafka/web/ui/controllers/routing.rb
+- lib/karafka/web/ui/helpers/application_helper.rb
+- lib/karafka/web/ui/lib/hash_proxy.rb
+- lib/karafka/web/ui/lib/paginate_array.rb
+- lib/karafka/web/ui/models/consumer_group.rb
+- lib/karafka/web/ui/models/health.rb
+- lib/karafka/web/ui/models/job.rb
+- lib/karafka/web/ui/models/message.rb
+- lib/karafka/web/ui/models/partition.rb
+- lib/karafka/web/ui/models/process.rb
+- lib/karafka/web/ui/models/processes.rb
+- lib/karafka/web/ui/models/state.rb
+- lib/karafka/web/ui/models/topic.rb
+- lib/karafka/web/ui/pro/app.rb
+- lib/karafka/web/ui/pro/controllers/cluster.rb
+- lib/karafka/web/ui/pro/controllers/consumers.rb
+- lib/karafka/web/ui/pro/controllers/dlq.rb
+- lib/karafka/web/ui/pro/controllers/errors.rb
+- lib/karafka/web/ui/pro/controllers/explorer.rb
+- lib/karafka/web/ui/pro/controllers/health.rb
+- lib/karafka/web/ui/pro/controllers/jobs.rb
+- lib/karafka/web/ui/pro/controllers/routing.rb
+- lib/karafka/web/ui/pro/views/consumers/_breadcrumbs.erb
+- lib/karafka/web/ui/pro/views/consumers/_consumer.erb
+- lib/karafka/web/ui/pro/views/consumers/_counters.erb
+- lib/karafka/web/ui/pro/views/consumers/_summary.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_consumer_group.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_job.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_metrics.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_no_jobs.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_no_subscriptions.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_partition.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_stopped.erb
+- lib/karafka/web/ui/pro/views/consumers/consumer/_tabs.erb
+- lib/karafka/web/ui/pro/views/consumers/index.erb
+- lib/karafka/web/ui/pro/views/consumers/jobs.erb
+- lib/karafka/web/ui/pro/views/consumers/subscriptions.erb
+- lib/karafka/web/ui/pro/views/dlq/_breadcrumbs.erb
+- lib/karafka/web/ui/pro/views/dlq/_no_topics.erb
+- lib/karafka/web/ui/pro/views/dlq/_topic.erb
+- lib/karafka/web/ui/pro/views/dlq/index.erb
+- lib/karafka/web/ui/pro/views/errors/_breadcrumbs.erb
+- lib/karafka/web/ui/pro/views/errors/_detail.erb
+- lib/karafka/web/ui/pro/views/errors/_error.erb
+- lib/karafka/web/ui/pro/views/errors/_partition_option.erb
+- lib/karafka/web/ui/pro/views/errors/index.erb
+- lib/karafka/web/ui/pro/views/errors/show.erb
+- lib/karafka/web/ui/pro/views/explorer/_breadcrumbs.erb
+- lib/karafka/web/ui/pro/views/explorer/_detail.erb
+- lib/karafka/web/ui/pro/views/explorer/_encryption_enabled.erb
+- lib/karafka/web/ui/pro/views/explorer/_failed_deserialization.erb
+- lib/karafka/web/ui/pro/views/explorer/_message.erb
+- lib/karafka/web/ui/pro/views/explorer/_partition_option.erb
+- lib/karafka/web/ui/pro/views/explorer/_topic.erb
+- lib/karafka/web/ui/pro/views/explorer/index.erb
+- lib/karafka/web/ui/pro/views/explorer/partition.erb
+- lib/karafka/web/ui/pro/views/explorer/show.erb
+- lib/karafka/web/ui/pro/views/health/_breadcrumbs.erb
+- lib/karafka/web/ui/pro/views/health/_partition.erb
+- lib/karafka/web/ui/pro/views/health/index.erb
+- lib/karafka/web/ui/pro/views/jobs/_breadcrumbs.erb
+- lib/karafka/web/ui/pro/views/jobs/_job.erb
+- lib/karafka/web/ui/pro/views/jobs/_no_jobs.erb
+- lib/karafka/web/ui/pro/views/jobs/index.erb
+- lib/karafka/web/ui/pro/views/shared/_navigation.erb
+- lib/karafka/web/ui/public/images/favicon.ico
+- lib/karafka/web/ui/public/images/logo.svg
+- lib/karafka/web/ui/public/javascripts/application.js
+- lib/karafka/web/ui/public/javascripts/bootstrap.min.js
+- lib/karafka/web/ui/public/javascripts/highlight.min.js
+- lib/karafka/web/ui/public/javascripts/live_poll.js
+- lib/karafka/web/ui/public/javascripts/timeago.min.js
+- lib/karafka/web/ui/public/stylesheets/application.css
+- lib/karafka/web/ui/public/stylesheets/bootstrap.min.css
+- lib/karafka/web/ui/public/stylesheets/bootstrap.min.css.map
+- lib/karafka/web/ui/public/stylesheets/highlight.min.css
+- lib/karafka/web/ui/views/cluster/_breadcrumbs.erb
+- lib/karafka/web/ui/views/cluster/_broker.erb
+- lib/karafka/web/ui/views/cluster/_partition.erb
+- lib/karafka/web/ui/views/cluster/index.erb
+- lib/karafka/web/ui/views/consumers/_breadcrumbs.erb
+- lib/karafka/web/ui/views/consumers/_consumer.erb
+- lib/karafka/web/ui/views/consumers/_counters.erb
+- lib/karafka/web/ui/views/consumers/_summary.erb
+- lib/karafka/web/ui/views/consumers/consumer/_consumer_group.erb
+- lib/karafka/web/ui/views/consumers/consumer/_job.erb
+- lib/karafka/web/ui/views/consumers/consumer/_metrics.erb
+- lib/karafka/web/ui/views/consumers/consumer/_no_jobs.erb
+- lib/karafka/web/ui/views/consumers/consumer/_no_subscriptions.erb
+- lib/karafka/web/ui/views/consumers/consumer/_partition.erb
+- lib/karafka/web/ui/views/consumers/consumer/_stopped.erb
+- lib/karafka/web/ui/views/consumers/consumer/_tabs.erb
+- lib/karafka/web/ui/views/consumers/index.erb
+- lib/karafka/web/ui/views/errors/_breadcrumbs.erb
+- lib/karafka/web/ui/views/errors/_detail.erb
+- lib/karafka/web/ui/views/errors/_error.erb
+- lib/karafka/web/ui/views/errors/index.erb
+- lib/karafka/web/ui/views/errors/show.erb
+- lib/karafka/web/ui/views/jobs/_breadcrumbs.erb
+- lib/karafka/web/ui/views/jobs/_job.erb
+- lib/karafka/web/ui/views/jobs/_no_jobs.erb
+- lib/karafka/web/ui/views/jobs/index.erb
+- lib/karafka/web/ui/views/layout.erb
+- lib/karafka/web/ui/views/routing/_breadcrumbs.erb
+- lib/karafka/web/ui/views/routing/_consumer_group.erb
+- lib/karafka/web/ui/views/routing/_detail.erb
+- lib/karafka/web/ui/views/routing/_topic.erb
+- lib/karafka/web/ui/views/routing/index.erb
+- lib/karafka/web/ui/views/routing/show.erb
+- lib/karafka/web/ui/views/shared/_become_pro.erb
+- lib/karafka/web/ui/views/shared/_brand.erb
+- lib/karafka/web/ui/views/shared/_content.erb
+- lib/karafka/web/ui/views/shared/_header.erb
+- lib/karafka/web/ui/views/shared/_navigation.erb
+- lib/karafka/web/ui/views/shared/_pagination.erb
+- lib/karafka/web/ui/views/shared/exceptions/not_found.erb
+- lib/karafka/web/ui/views/shared/exceptions/pro_only.erb
+- lib/karafka/web/version.rb
+homepage: https://karafka.io
+licenses:
+- LGPL-3.0
+- Commercial
+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'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: Karafka ecosystem Web UI interface
+test_files: []