Project

rails_mind

0.0
The project is in a healthy, maintained state
rails_mindcmartyn/rails_mindHomepageDocumentationSource CodeBug TrackerWiki
The RailsMind client for Rails request, error, job, and business-event telemetry, with optional Ahoy, Flipper, OpenTelemetry, and browser integrations.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Popularity
Downloads
2,272
Stars
0
Forks
0
Watchers
0
 Releases
Current version
0.1.0
Total releases
1
First release
2026-09-25
Latest release
2026-09-25
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2026-09-21
Reverse Dependencies
0

 Dependencies

Runtime

net-http
>= 0.4, < 1
railties
>= 7.2, < 9
 Project Readme

RailsMind SDK

The MIT-licensed Ruby client for RailsMind. One bounded collector for Rails requests, errors, jobs, Ahoy events, Flipper observations, and selected OpenTelemetry spans. Version 0.1.0 is an early release; see compatibility and validation limits.

gem "rails_mind", "~> 0.1.0"

Install from RubyGems.org and commit your application's Gemfile.lock to pin the resolved version. This repository contains the open-source client library. The hosted RailsMind service is a separate, proprietary application; its source is not included or licensed by this repository. See development and release notes.

bundle install
bin/rails generate rails_mind:install --plan
bin/rails generate rails_mind:install
bin/rails rails_mind:doctor

Set RAILS_MIND_KEY for the destination application environment. It is the only required setting; collection stays off without it. The endpoint defaults to https://railsmind.com. Release IDs are detected from hosting metadata or the app's deployed REVISION file; telemetry still works when none is available. RAILS_MIND_ENDPOINT and RAILS_MIND_RELEASE are optional overrides. See configuration and release detection.

After setting the key, run bin/rails rails_mind:verify on the app's server. Match its check ID in RailsMind Setup and wait for Check processed. Then visit the app to confirm real traffic. This command sends one labeled diagnostic check, consumes one event of quota, and leaves business/performance metrics alone. It requires a hosted app with installation-check support; rails_mind:doctor remains read-only. See the verification guide for failure states and the limits of this check.

RailsMind.with_context(user_id: current_user.id.to_s, account_id: current_account.id.to_s) do
  RailsMind.track("Invoice paid", invoice_id: invoice.id, amount_cents: invoice.amount_cents)
end

See installation and privacy and compatibility.

Tests:

bundle install
bundle exec rake test
node --test javascript/rails_mind.test.js
bundle exec ruby script/package_smoke.rb
ruby script_benchmark.rb

Business/request/error events are unsampled, but delivery is best effort. Check RailsMind.stats for losses. The SDK does not guarantee durable business-event counts; use a transactional outbox when that is required.