A Ruby gem providing a Render.com API client, mountable Rails metrics dashboard, and monitoring rake tasks.
- Ruby >= 3.0
- Rails >= 6.0 (for the engine and rake tasks)
- Tailwind CSS in the host app (the dashboard views use Tailwind utility classes)
Add to your Gemfile:
gem "render-dashboard", path: "/path/to/render-dashboard"
# or
gem "render-dashboard", github: "your-org/render-dashboard", branch: "main"Then run bundle install.
Create an initializer (e.g. config/initializers/render-dashboard.rb):
RenderDashboard.configure do |config|
config.api_key = ENV["RENDER_API_KEY"]
endIf omitted, the API key defaults to ENV["RENDER_API_KEY"].
In your config/routes.rb:
mount RenderDashboard::Engine, at: "/render"The metrics dashboard is then available at /render/metrics.
- CPU and memory charts for every Render service on your account
- Automatic percentage conversion when limit data is available
- Time range picker (1 h, 6 h, 24 h, 7 d) with adaptive resolution
- Dark mode support (follows the host app's
darkclass on<html>) - Charts rendered with ApexCharts (loaded via CDN)
Use the client directly for custom integrations:
client = RenderDashboard::Client.new
# List all services
client.services
# Get CPU metrics for a service
client.cpu(resource: "srv-xxxxx")
# Get memory metrics with a custom time range
client.memory(
resource: "srv-xxxxx",
start_time: 6.hours.ago,
end_time: Time.current,
resolution: 300
)You can also pass an explicit API key:
client = RenderDashboard::Client.new(api_key: "rnd_...")All metric methods accept: resource:, start_time:, end_time:, resolution:, instance:, aggregation:.
| Method | Render Endpoint |
|---|---|
cpu |
/metrics/cpu |
cpu_limit |
/metrics/cpu-limit |
cpu_target |
/metrics/cpu-target |
memory |
/metrics/memory |
memory_limit |
/metrics/memory-limit |
memory_target |
/metrics/memory-target |
disk_usage |
/metrics/disk-usage |
disk_capacity |
/metrics/disk-capacity |
bandwidth |
/metrics/bandwidth |
bandwidth_sources |
/metrics/bandwidth-sources |
http_requests |
/metrics/http-requests |
http_latency |
/metrics/http-latency |
active_connections |
/metrics/active-connections |
instance_count |
/metrics/instance-count |
replication_lag |
/metrics/replication-lag |
| Method | Description |
|---|---|
services(limit:) |
List all services |
service(id) |
Get a single service |
Available when the gem is loaded in a Rails app.
Prints service and disk info for all services:
rake render-dashboard:infoTo inspect a single service:
RENDER_SERVICE_ID=srv-xxxxx rake render-dashboard:infoChecks database disk usage against a threshold and alerts if exceeded. Queries information_schema (MySQL / MariaDB).
rake render-dashboard:disk_check| Environment Variable | Description | Default |
|---|---|---|
RENDER_API_KEY |
Render API key (used to look up disk size) | — |
RENDER_SERVICE_ID |
Service to check | — |
RENDER_DISK_SIZE_GB |
Fallback disk size when the API isn't available | — |
RENDER_SERVICE_NAME |
Label used in output and alerts | "database" |
DISK_ALERT_THRESHOLD |
Usage percentage that triggers an alert | 80 |
When the threshold is exceeded the task will call the following hooks if they exist in the host app:
SystemMailer.disk_alert(used_percent:, used_gb:, total_gb:, service_name:)WhatsappNotifier.send_system_alert(title, body)
After cloning, install git hooks:
rake setupThis enables pre-commit checks that run automatically on git commit:
- Ruby syntax —
ruby -con all staged.rbfiles - ERB syntax — validates staged
.erbtemplates - Frozen string literal — warns if the pragma is missing from
.rbfiles - Trailing whitespace — catches whitespace errors in staged files
- Gemspec validity — validates the gemspec when it's staged
- Debug statements — blocks
binding.pry,binding.irb,byebug,debugger
To bypass in an emergency: git commit --no-verify
This gem is available as open source under the terms of the MIT License.