karafka-web 0.7.9 → 0.8.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24bc5fe488a1304886f3f7f697a8662463f4c21fae60daf52d317852f9f43669
-  data.tar.gz: eaa8e4b7d9b9d70200c8929e8fa65ed7906a1b4085465b15525bfee670ebbcc9
+  metadata.gz: d3e890ec145255109e1f29ea742e6e0ed2887b0b4ca1de6047973816307744c1
+  data.tar.gz: 55766edeb8f40c68c1200b577697728037882e2af3dd0dfb9723741be0343b7e
 SHA512:
-  metadata.gz: 0ba2c668103a3b25169d86f2c0624fae04d144694040694ff79c4932bf81fe648e5ba11223be5a5f9e8d8ba0bbbac9da84f2ec5312e81d07b35873707b7b754c
-  data.tar.gz: b0ec51820b50dfde4f88e942e3b0dcc2400170d0fbe256503294f366e2f4fe0057249bb525528b789bed254ba6ec035d5502e515042bd094999663155f8a221d
+  metadata.gz: 29dccc30c89888815b33a703317ca44bcf1b0a5f37228e9db7ba26eeba2d3b5ce5a66f5246121c4b9c1bb9d248e9027f3e8992f324109fd807d62a94c70c47ff
+  data.tar.gz: 32ed3012d866810f85db46c8c82f20888693e1c533edb9bcdc54cf098c2bece4478e8fe82f8a3c62c313f219d622f8b42e25bd4f38793d82951dec311f164c5c

data/.github/workflows/ci.yml

@@ -1,6 +1,8 @@
 name: ci
 
-concurrency: ci-${{ github.ref }}
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 on:
   pull_request:
@@ -20,13 +22,13 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '3.3.0-preview2'
+          - '3.3'
           - '3.2'
           - '3.1'
           - '3.0'
           - '2.7'
         include:
-          - ruby: '3.2'
+          - ruby: '3.3'
             coverage: 'true'
     steps:
       - uses: actions/checkout@v4
@@ -42,16 +44,29 @@ jobs:
         with:
           ruby-version: ${{matrix.ruby}}
           bundler-cache: true
+          bundler: 'latest'
 
       - name: Install latest bundler
         run: |
-          gem install bundler --no-document
+          if [[ "$(ruby -v | awk '{print $2}')" == 2.7.8* ]]; then
+            gem install bundler -v 2.4.22 --no-document
+            gem update --system 3.4.22 --no-document
+          else
+            gem install bundler --no-document
+            gem update --system --no-document
+          fi
+
           bundle config set without 'tools benchmarks docs'
 
       - name: Bundle install
         run: |
           bundle config set without development
-          bundle install --jobs 4 --retry 3
+
+          if [[ "$(ruby -v | awk '{print $2}')" == 2.7.8* ]]; then
+            BUNDLER_VERSION=2.4.22 bundle install --jobs 4 --retry 3
+          else
+            bundle install --jobs 4 --retry 3
+          fi
 
       - name: Wait for Kafka
         run: |
@@ -75,7 +90,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2
+          ruby-version: 3.3
           bundler-cache: true
 
       - name: Install Diffend plugin

data/.ruby-version

@@ -1 +1 @@
-3.2.2
+3.3.0

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Karafka Web changelog
 
+## 0.8.0 (Unreleased)
+- **[Feature]** Provide ability to sort table data for part of the views (note: not all attributes can be sorted due to technical limitations of sub-components fetching from Kafka).
+- **[Feature]** Track and report pause timeouts via "Changes" view in Health.
+- **[Feature]** Introduce pending jobs visibility alongside of running jobs both in total and per process.
+- **[Feature]** Introduce states migrations for seamless upgrades.
+- **[Feature]** Introduce "Data transfers" chart with data received and data sent to the cluster.
+- **[Feature]** Introduce ability to download raw payloads.
+- **[Feature]** Introduce ability to download deserialized message payload as JSON.
+- [Enhancement] Support reporting of standby and active listeners for connection multiplexed subscription groups.
+- [Enhancement] Support Periodic Jobs reporting.
+- [Enhancement] Support multiplexed subscription groups.
+- [Enhancement] Split cluster info into two tabs, one for brokers and one for topics with partitions.
+- [Enhancement] Track pending jobs. Pending jobs are jobs that are not yet scheduled for execution by advanced schedulers.
+- [Enhancement] Rename "Enqueued" to "Pending" to support jobs that are not yet enqueued but within a scheduler.
+- [Enhancement] Make sure only running jobs are displayed in running jobs
+- [Enhancement] Improve jobs related breadcrumbs
+- [Enhancement] Display errors backtraces in OSS.
+- [Enhancement] Display concurrency graph in OSS.
+- [Enhancement] Support time ranges for graphs in OSS.
+- [Enhancement] Report last poll time for each subscription group.
+- [Enhancement] Show last poll time per consumer instance.
+- [Enhancement] Display number of jobs in a particular process jobs view.
+- [Enhancement] Promote "Batches" chart to OSS.
+- [Enhancement] Promote "Utilization" chart to OSS.
+- [Enhancement] Allow for explicit disabling of the Web UI tracking.
+- [Fix] Web UI will keep reporting status even when not activated as long as required and in routes.
+- [Fix] Fix times precisions that could be incorrectly reported by 1 second in few places.
+- [Fix] Fix random order in Consumers groups Health view.
+- [Change] Rename "Busy" to "Running" to align with "Running Jobs".
+- [Change] Rename "Active subscriptions" to "Subscriptions" as process subscriptions are always active.
+- [Maintenance] Introduce granular subscription group contracts.
+
+### Upgrade Notes
+
+This is a **major** release that brings many things to the table.
+
+#### Configuration
+
+**No** configuration changes are needed.
+
+#### Deployment
+
+Because of the reporting schema update, it is recommended to:
+
+0. Make sure you have upgraded to `0.7.10` before and that it was fully deployed.
+1. Test the upgrade on a staging or dev environment.
+2. Starting from `0.7.0` Karafka Web UI supports rolling deploys, so there is no need to "stop the world".
+3. The Web UI interface may throw 500 errors during the upgrade because of schema incompatibility (until Puma is deployed). This will have no long-term effects and can be ignored.
+4. `Karafka::Web::Errors::Processing::IncompatibleSchemaError` **is expected**. It is part of the Karafka Web UI zero-downtime deployment strategy. This error allows the Web UI materialization consumer to back off and wait for it to be replaced with a new one.
+5. Perform a rolling deployment (or a regular one) and replace all consumer processes.
+6. Update the Web UI Puma.
+7. **No** CLI command execution is required. Starting from this release (`0.8.0`), the Karafka Web UI contains an automatic schema migrator that allows it to automatically adjust internal topic data formats.
+8. Enjoy.
+
+## 0.7.10 (2023-10-31)
+- [Fix] Max LSO chart does not work as expected (#201)
+
 ## 0.7.9 (2023-10-25)
 - [Enhancement] Allow for `Karafka::Web.producer` reconfiguration from the default (`Karafka.producer`).
 - [Change] Rely on `karafka-core` `>=` `2.2.4` to support lazy loaded custom web producer.
@@ -26,6 +83,15 @@
 - [Fix] Cache assets for 1 year instead of 7 days.
 - [Fix] Remove source maps pointing to non-existing locations.
 - [Maintenance] Include license and copyrights notice for `timeago.js` that was missing in the JS min file. 
+- [Refactor] Rename `ui.show_internal_topics` to `ui.visibility.internal_topics_display`
+
+### Upgrade Notes
+
+**NO** rolling upgrade needed. Just configuration update.
+
+1. If you are using `ui.visibility_filter` this option is now `ui.visibility.filter` (yes, only `.` difference).
+2. If you are using a custom visibility filter, it requires now two extra methods: `#download?` and `#export?`. The default visibility filter allows both actions unless message is encrypted.
+3. `ui.show_internal_topics` config option has been moved and renamed to `ui.visibility.internal_topics`.
 
 ## 0.7.4 (2023-09-19)
 - [Improvement] Skip aggregations on older schemas during upgrades. This only skips process-reports (that are going to be rolled) on the 5s window in case of an upgrade that should not be a rolling one anyhow. This simplifies the operations and minimizes the risk on breaking upgrades.

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.7.9)
+    karafka-web (0.8.0.rc1)
       erubi (~> 1.4)
-      karafka (>= 2.2.9, < 3.0.0)
-      karafka-core (>= 2.2.4, < 3.0.0)
+      karafka (>= 2.3.0.rc1, < 2.4.0)
+      karafka-core (>= 2.3.0.rc1, < 2.4.0)
       roda (~> 3.68, >= 3.69)
       tilt (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.1)
+    activesupport (7.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -21,43 +21,42 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     byebug (11.1.3)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    drb (2.1.1)
+    drb (2.2.0)
       ruby2_keywords
     erubi (1.12.0)
-    factory_bot (6.3.0)
+    factory_bot (6.4.5)
       activesupport (>= 5.0.0)
     ffi (1.16.3)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    karafka (2.2.9)
-      karafka-core (>= 2.2.2, < 2.3.0)
-      waterdrop (>= 2.6.10, < 3.0.0)
+    karafka (2.3.0.rc1)
+      karafka-core (>= 2.3.0.rc1, < 2.4.0)
+      waterdrop (>= 2.6.12, < 3.0.0)
       zeitwerk (~> 2.3)
-    karafka-core (2.2.4)
-      concurrent-ruby (>= 1.1)
-      karafka-rdkafka (>= 0.13.6, < 0.14.0)
-    karafka-rdkafka (0.13.6)
+    karafka-core (2.3.0.rc1)
+      karafka-rdkafka (>= 0.14.7, < 0.15.0)
+    karafka-rdkafka (0.14.7)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
     mini_portile2 (2.8.5)
-    minitest (5.20.0)
-    mutex_m (0.1.2)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
     rack (3.0.8)
     rack-test (2.1.0)
       rack (>= 1.3)
     rackup (0.2.3)
       rack (>= 3.0.0.beta1)
       webrick
-    rake (13.0.6)
-    roda (3.73.0)
+    rake (13.1.0)
+    roda (3.76.0)
       rack
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -82,13 +81,14 @@ GEM
     tilt (2.3.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    waterdrop (2.6.10)
+    waterdrop (2.6.12)
       karafka-core (>= 2.2.3, < 3.0.0)
       zeitwerk (~> 2.3)
     webrick (1.8.1)
     zeitwerk (2.6.12)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
@@ -101,4 +101,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.4.19
+   2.5.4

data/docker-compose.yml

@@ -3,7 +3,7 @@ version: '2'
 services:
   kafka:
     container_name: kafka
-    image: confluentinc/cp-kafka:7.5.1
+    image: confluentinc/cp-kafka:7.5.3
 
     ports:
       - 9092:9092
@@ -23,3 +23,5 @@ services:
       KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'true'
       KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1
       KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1
+      KAFKA_ALLOW_EVERYONE_IF_NO_ACL_FOUND: "true"
+      KAFKA_AUTHORIZER_CLASS_NAME: org.apache.kafka.metadata.authorizer.StandardAuthorizer

data/karafka-web.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.licenses    = %w[LGPL-3.0 Commercial]
 
   spec.add_dependency 'erubi', '~> 1.4'
-  spec.add_dependency 'karafka', '>= 2.2.9', '< 3.0.0'
-  spec.add_dependency 'karafka-core', '>= 2.2.4', '< 3.0.0'
+  spec.add_dependency 'karafka', '>= 2.3.0.rc1', '< 2.4.0'
+  spec.add_dependency 'karafka-core', '>= 2.3.0.rc1', '< 2.4.0'
   spec.add_dependency 'roda', '~> 3.68', '>= 3.69'
   spec.add_dependency 'tilt', '~> 2.0'
 

data/lib/karafka/web/config.rb

@@ -47,6 +47,11 @@ module Karafka
         # 5 seconds should be enough
         setting :interval, default: 5_000
 
+        # Should we be tracking anything at all. If this is set to false, no reporting will happen
+        # even if Web-UI is configured. When set to `nil` (default) it will be switched to true
+        # during the Web UI initialization.
+        setting :active, default: nil
+
         # Main Web UI reporting scheduler that runs a background thread and reports periodically
         # from the consumer reporter and producer reporter
         setting :scheduler, default: Tracking::Scheduler.new
@@ -62,6 +67,7 @@ module Karafka
           setting :listeners, default: [
             Tracking::Consumers::Listeners::Status.new,
             Tracking::Consumers::Listeners::Errors.new,
+            Tracking::Consumers::Listeners::Connections.new,
             Tracking::Consumers::Listeners::Statistics.new,
             Tracking::Consumers::Listeners::Pausing.new,
             Tracking::Consumers::Listeners::Processing.new,
@@ -117,9 +123,16 @@ module Karafka
           Karafka.env.production? ? 60_000 * 5 : 5_000
         )
 
-        # Should we display internal topics of Kafka. The once starting with `__`
-        # By default we do not display them as they are not usable from regular users perspective
-        setting :show_internal_topics, default: false
+        setting :visibility do
+          # Allows to manage visibility of payload, headers and message key in the UI
+          # In some cases you may want to limit what is being displayed due to the type of data you
+          # are dealing with
+          setting :filter, default: Ui::Models::VisibilityFilter.new
+
+          # Should we display internal topics of Kafka. The once starting with `__`
+          # By default we do not display them as they are not usable from regular users perspective
+          setting :internal_topics, default: false
+        end
 
         # How many elements should we display on pages that support pagination
         setting :per_page, default: 25

data/lib/karafka/web/contracts/config.rb

@@ -23,6 +23,8 @@ module Karafka
         end
 
         nested(:tracking) do
+          # If set to nil, it is up to us to initialize
+          required(:active) { |val| [true, false, nil].include?(val) }
           # Do not report more often then every second, this could overload the system
           required(:interval) { |val| val.is_a?(Integer) && val >= 1_000 }
 
@@ -52,10 +54,13 @@ module Karafka
             required(:secret) { |val| val.is_a?(String) && val.length >= 64 }
           end
 
-          required(:show_internal_topics) { |val| [true, false].include?(val) }
           required(:cache) { |val| !val.nil? }
           required(:per_page) { |val| val.is_a?(Integer) && val >= 1 && val <= 100 }
-          required(:visibility_filter) { |val| !val.nil? }
+
+          nested(:visibility) do
+            required(:filter) { |val| !val.nil? }
+            required(:internal_topics) { |val| [true, false].include?(val) }
+          end
         end
       end
     end

data/lib/karafka/web/errors.rb

@@ -11,6 +11,18 @@ module Karafka
       # This should never happen and if you see this, please open an issue.
       ContractError = Class.new(BaseError)
 
+      # Errors specific to management
+      module Management
+        # Similar to processing error with the same name, it is raised when a critical
+        # incompatibility is detected.
+        #
+        # This error is raised when there was an attempt to operate on aggregated Web UI states
+        # that are already in a newer version that the one in the current process. We prevent
+        # this from happening not to corrupt the data. Please upgrade all the Web UI consumers to
+        # the same version
+        IncompatibleSchemaError = Class.new(BaseError)
+      end
+
       # Processing related errors namespace
       module Processing
         # Raised when we try to process reports but we do not have the current state bootstrapped

data/lib/karafka/web/inflector.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    # Web UI Zeitwerk Inflector that allows us to have time prefixed files with migrations, similar
+    # to how Rails does that.
+    class Inflector < Zeitwerk::GemInflector
+      # Checks if given path is a migration one
+      MIGRATION_ABSPATH_REGEXP = /migrations\/[0-9]+_(.*)/
+
+      # Checks if it is a migration file
+      MIGRATION_BASENAME_REGEXP = /\A[0-9]+_(.*)/
+
+      private_constant :MIGRATION_ABSPATH_REGEXP, :MIGRATION_BASENAME_REGEXP
+
+      # @param [String] basename of the file to be loaded
+      # @param abspath [String] absolute path of the file to be loaded
+      # @return [String] Constant name to be used for given file
+      def camelize(basename, abspath)
+        # If not migration directory with proper migration files, use defaults
+        return super unless abspath.match?(MIGRATION_ABSPATH_REGEXP)
+        # If base name is not of a proper name in migrations, use defaults
+        return super unless basename.match?(MIGRATION_BASENAME_REGEXP)
+
+        super(
+          # Extract only the name without the timestamp
+          basename.match(MIGRATION_BASENAME_REGEXP).to_a.last,
+          abspath
+        )
+      end
+    end
+  end
+end

data/lib/karafka/web/installer.rb

@@ -17,11 +17,14 @@ module Karafka
         puts
         puts 'Creating necessary topics and populating state data...'
         puts
-        Management::CreateTopics.new.call(replication_factor)
+        Management::Actions::CreateTopics.new.call(replication_factor)
         wait_for_topics
-        Management::CreateInitialStates.new.call
+        Management::Actions::CreateInitialStates.new.call
         puts
-        Management::ExtendBootFile.new.call
+        puts 'Running data migrations...'
+        Management::Actions::MigrateStatesData.new.call
+        puts
+        Management::Actions::ExtendBootFile.new.call
         puts
         puts("Installation #{green('completed')}. Have fun!")
         puts
@@ -35,9 +38,12 @@ module Karafka
         puts
         puts 'Creating necessary topics and populating state data...'
         puts
-        Management::CreateTopics.new.call(replication_factor)
+        Management::Actions::CreateTopics.new.call(replication_factor)
         wait_for_topics
-        Management::CreateInitialStates.new.call
+        Management::Actions::CreateInitialStates.new.call
+        puts
+        puts 'Running data migrations...'
+        Management::Actions::MigrateStatesData.new.call
         puts
         puts("Migration #{green('completed')}. Have fun!")
         puts
@@ -49,11 +55,14 @@ module Karafka
         puts
         puts 'Resetting Karafka Web UI...'
         puts
-        Management::DeleteTopics.new.call
+        Management::Actions::DeleteTopics.new.call
         puts
-        Management::CreateTopics.new.call(replication_factor)
+        Management::Actions::CreateTopics.new.call(replication_factor)
         wait_for_topics
-        Management::CreateInitialStates.new.call
+        Management::Actions::CreateInitialStates.new.call
+        puts
+        puts 'Running data migrations...'
+        Management::Actions::MigrateStatesData.new.call
         puts
         puts("Resetting #{green('completed')}. Have fun!")
         puts
@@ -64,8 +73,8 @@ module Karafka
         puts
         puts 'Uninstalling Karafka Web UI...'
         puts
-        Management::DeleteTopics.new.call
-        Management::CleanBootFile.new.call
+        Management::Actions::DeleteTopics.new.call
+        Management::Actions::CleanBootFile.new.call
         puts
         puts("Uninstalling #{green('completed')}. Goodbye!")
         puts
@@ -73,7 +82,7 @@ module Karafka
 
       # Enables the Web-UI in the karafka app. Sets up needed routes and listeners.
       def enable!
-        Management::Enable.new.call
+        Management::Actions::Enable.new.call
       end
 
       private

data/lib/karafka/web/management/actions/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Management
+      # Namespace for all the commands related to management of the Web-UI in the context of
+      # Karafka. It includes things like installing, creating needed topics, etc.
+      module Actions
+        # Base class for all the commands that we use to manage
+        class Base
+          include ::Karafka::Helpers::Colorize
+
+          private
+
+          # @return [String] green colored word "successfully"
+          def successfully
+            green('successfully')
+          end
+
+          # @return [String] green colored word "already"
+          def already
+            green('already')
+          end
+
+          # @return [Array<String>] topics available in the cluster
+          def existing_topics_names
+            @existing_topics_names ||= ::Karafka::Admin
+                                       .cluster_info
+                                       .topics
+                                       .map { |topic| topic[:topic_name] }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/management/actions/clean_boot_file.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Management
+      module Actions
+        # Cleans the boot file from Karafka Web-UI details.
+        class CleanBootFile < Base
+          # Web-UI enabled code
+          ENABLER_CODE = ExtendBootFile::ENABLER_CODE
+
+          private_constant :ENABLER_CODE
+
+          # Removes the Web-UI boot file data
+          def call
+            karafka_rb = File.readlines(Karafka.boot_file)
+
+            if karafka_rb.any? { |line| line.include?(ENABLER_CODE) }
+              puts 'Updating the Karafka boot file...'
+              karafka_rb.delete_if { |line| line.include?(ENABLER_CODE) }
+
+              File.write(Karafka.boot_file, karafka_rb.join)
+              puts "Karafka boot file #{successfully} updated."
+              puts 'Make sure to remove configuration and other customizations as well.'
+            else
+              puts 'Karafka Web UI components not found in the boot file.'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/management/actions/create_initial_states.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Management
+      module Actions
+        # Creates the records needed for the Web-UI to operate.
+        # It creates "almost" empty states because the rest is handled via migrations
+        class CreateInitialStates < Base
+          # Whole default empty state
+          # This will be further migrated by the migrator
+          DEFAULT_STATE = {
+            schema_version: '0.0.0'
+          }.freeze
+
+          # Default metrics state
+          DEFAULT_METRICS = {
+            schema_version: '0.0.0'
+          }.freeze
+
+          # Creates the initial states for the Web-UI if needed (if they don't exist)
+          def call
+            if exists?(Karafka::Web.config.topics.consumers.states)
+              exists('consumers state')
+            else
+              creating('consumers state')
+              ::Karafka::Web.producer.produce_sync(
+                topic: Karafka::Web.config.topics.consumers.states,
+                key: Karafka::Web.config.topics.consumers.states,
+                payload: DEFAULT_STATE.to_json
+              )
+              created('consumers state')
+            end
+
+            if exists?(Karafka::Web.config.topics.consumers.metrics)
+              exists('consumers metrics')
+            else
+              creating('consumers metrics')
+              ::Karafka::Web.producer.produce_sync(
+                topic: Karafka::Web.config.topics.consumers.metrics,
+                key: Karafka::Web.config.topics.consumers.metrics,
+                payload: DEFAULT_METRICS.to_json
+              )
+              created('consumers metrics')
+            end
+          end
+
+          private
+
+          # @param topic [String] topic name
+          # @return [Boolean] true if there is already an initial record in a given topic
+          def exists?(topic)
+            !::Karafka::Admin.read_topic(topic, 0, 5).last.nil?
+          end
+
+          # @param type [String] type of state
+          # @return [String] exists message
+          def exists(type)
+            puts "Initial #{type} #{already} exists."
+          end
+
+          # @param type [String] type of state
+          # @return [String] message that the state is being created
+          def creating(type)
+            puts "Creating #{type} initial record..."
+          end
+
+          # @param type [String] type of state
+          # @return [String] message that the state was created
+          def created(type)
+            puts "Initial #{type} record #{successfully} created."
+          end
+        end
+      end
+    end
+  end
+end