Rack::DevInsight

Rack::DevInsight is an observability tool for Rack applications, analyzing SQL and HTTP with a Chrome extension as a dashboard.
It is intended for development use only.

• Record SQL queries and aggregate them by CRUD operation and Normalized statement
  • Supports MySQL, PostgreSQL, and SQLite3
• Record HTTP request / response
  • Supports requests using net-http gem

• Display recorded data in Devtools panel.
  • SQL queries
    • Queries grouped by CRUD operation, with total query count and duration
    • Queries grouped by normalized statement, with total query count and duration
    • All queries, with duration and backtrace
  • HTTP request / response
    • Request headers and body
    • Response headers and body
    • Duration
    • Backtrace

More screenshots are available at Chrome Web Store.

This gem depends on the sql-insight-rb which includes a Rust extension.
We recommend using the precompiled gems provided by sql-insight-rb. Available platforms are as follows:

arm-linux
aarch64-linux
arm64-darwin
x64-mingw-ucrt
x64-mingw32
x86_64-darwin
x86_64-linux
x86_64-linux-musl

If you face any difficulties, please refer to INSTALLATION_GUIDE.md for more details.

Add the following lines to your application's Gemfile:

group :development do
  gem 'rack-dev_insight'
end

That's it.

By railtie, middleware is automatically inserted, and SQL queries are recorded through ActiveSupport::Notifications.
The default subscriptions include sql.active_record, sql.rom, and sql.sequel. More event subscriptions can be added by:

Rack::DevInsight::SqlNotifications.subscribe('new_sql_event_name')

Only one SQL dialect is supported at a time, determined by the database client gems (i.e. mysql2, pg or sqlite3) listed in the Gemfile. If multiple clients are present, it defaults to mysql2, pg, then sqlite3 in order. To use multiple dialects simultaneously, SQL patch option can be used. When this option is enabled, railtie does not subscribe to SQL events in order to avoid duplicate recordings.

You have two options to record SQL queries.

Enabling this option will patch database client gems. Currently, mysql2 and pg gems are supported.

Add the following lines to your application's Gemfile:

group :development do
  gem 'rack-dev_insight', require: ['rack/dev_insight/enable_sql_patch', 'rack/dev_insight']
end

Make sure to list the mysql2 and pg gems before rack-dev_insight in the Gemfile, letting rack-dev_insight patch them when loaded.

First, add the following lines to your application's Gemfile:

group :development do
  gem 'rack-dev_insight'
end

If you can execute hooks following SQL executions, such as via the notification system of dry-monitor, you can use the following method to record SQL queries.

Rack::DevInsight::SqlRecorder.record(dialect: 'mysql', statement: 'SELECT * FROM users WHERE id = ?', binds: [1], duration: 5.0)

Keyword arguments are described below:

Need to insert the middleware into your application's middleware stack.

For example, when using Hanami:

# config.ru
require 'rack/dev_insight'

use Rack::DevInsight

If you want to disable net-http patch, you can change the Gemfile as follows:

group :development do
  gem 'rack-dev_insight', require: ['rack/dev_insight/disable_net_http_patch', 'rack/dev_insight']
end

Install the extension from Chrome Web Store.

1. After installing the gem and extension, open the devtools and navigate to the 'RackDevInsight' tab.
2. Initiate a request in your application from the browser.
3. The HTTP request / response details and SQL queries executed during the request will be displayed in the panel.

You can set configuration options by Rack::DevInsight.configure. For example:

Rack::DevInsight.configure do |config|
  config.storage_type = :file
  config.file_store_pool_size = 1000
  config.backtrace_depth = 10
end

Available options are described below:

Contributions are highly welcomed and appreciated! For more details, please refer to CONTRIBUTING.md

Special thanks to the rails_panel and rack-mini-profiler teams for their invaluable insights and innovations that have profoundly impacted this project. Additionally, we would like to thank sqlparser-rs teams for their exceptional SQL parser and visitor feature, which are essential for implementing the SQL CRUD and Normalized aggregation features across multiple SQL dialects in this project.

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

Everyone interacting in the rack-dev_insight project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.