Solid Cable Dashboard

A beautiful dashboard for solid_cable. Monitor your Rails application WebSocket performance with detailed stats and visualizations.

• Real-time monitoring of broadcasted messages and channel subscriptions
• Visual charts to track WebSocket activity over time
• Detailed views of all messages with size information
• Ability to inspect and delete individual messages
• Dark mode support
• Responsive design for all device sizes

Add this line to your application's Gemfile:

gem "solid_cable_dashboard"

And then execute:

$ bundle install

Run the installation generator:

$ rails generate solid_cable_dashboard:install
$ rails db:migrate

This will create a migration for the events table that tracks broadcasts, receives, subscribes, and unsubscribes.

Mount the dashboard in your config/routes.rb:

Rails.application.routes.draw do
  mount SolidCableDashboard::Engine => "/solid-cable"

  # The rest of your routes...
end

Now you can access the dashboard at /solid-cable.

You can configure the dashboard by creating an initializer:

# config/initializers/solid_cable_dashboard.rb
SolidCableDashboard.configure do |config|
  config.title = "My App WebSocket Dashboard"
end

For authentication, you can use routing constraints:

# config/routes.rb
Rails.application.routes.draw do
  authenticate :user, -> (user) { user.admin? } do
    mount SolidCableDashboard::Engine => "/solid-cable"
  end
end

Or you can create a controller concern:

# app/controllers/concerns/solid_cable_dashboard/authentication.rb
module SolidCableDashboard
  module Authentication
    extend ActiveSupport::Concern

    included do
      before_action :authenticate_solid_cable_dashboard
    end

    private

    def authenticate_solid_cable_dashboard
      if !user_signed_in? || !current_user.admin?
        redirect_to main_app.root_path, alert: "Not authorized"
      end
    end
  end
end

Then require it in an initializer:

# config/initializers/solid_cable_dashboard.rb
Rails.application.config.to_prepare do
  SolidCableDashboard::ApplicationController.include SolidCableDashboard::Authentication
end

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Bug reports and pull requests are welcome on GitHub at https://github.com/afomera/solid_cable_dashboard.

The gem is available as open source under the terms of the MIT License.