Ruby
import { Aside } from ‘@astrojs/starlight/components’;
Quickstart
Historical package install steps below. Prefer check-in recipes for new setups.
Get from zero to your first data in under 3 minutes.
1. Prerequisites
- Ruby 3.0+
- A Crontinel account (sign up free)
- An app created in the dashboard
- Your app’s API key from app settings
2. Install
gem install crontinelOr add to your Gemfile:
gem "crontinel", "~> 0.1"3. Configure
Create a quickstart.rb file:
require "crontinel"
client = Crontinel.client(api_key: ENV["CRONTINEL_API_KEY"])
client.task_finished(name: "hello-from-ruby", duration_ms: 100)
puts "Data sent to Crontinel!"Set your API key and run it:
export CRONTINEL_API_KEY=your-app-keyruby quickstart.rb4. Dashboard verification
- Go to app.crontinel.com → Apps → your app
- Check the Cron section — you should see the
hello-from-rubyjob with100msduration - Your first data is on the dashboard!
Requirements
- Ruby 3.0+
Install
Add to your Gemfile:
gem "crontinel", "~> 0.1"Or install directly:
gem install crontinelQuick Start
require "crontinel"
client = Crontinel.client(api_key: ENV["CRONTINEL_API_KEY"])
result = send_daily_summaryclient.task_finished(name: "send-daily-summary", duration_ms: 520)With error handling
client = Crontinel.client(api_key: ENV["CRONTINEL_API_KEY"])
begin process_invoices client.task_finished(name: "process-invoices", duration_ms: 3200)rescue => e client.task_failed(name: "process-invoices", error: e.message, duration_ms: 150) raiseendSidekiq integration
require "crontinel"
# In your workerclass MyJob include Sidekiq::Worker
def perform(*args) start = Process.clock_gettime(Process::CLOCK_MONOTONIC) client = Crontinel.client(api_key: ENV["CRONTINEL_API_KEY"]) do_work(*args) client.task_finished( name: "MyJob", duration_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000).to_i ) rescue => e client.task_failed( name: "MyJob", error: e.message, duration_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000).to_i ) raise endendEnvironment variables
Crontinel.client reads CRONTINEL_API_KEY and CRONTINEL_API_URL (default https://app.crontinel.com) when you pass no api_key: or endpoint:. Arguments win over the environment. With no key anywhere it raises api_key is required. This needs 0.1.1 or later.
task_started sends nothing: Crontinel records a run when it ends. Call task_finished or task_failed. (In 0.1.0 task_started recorded a finished run, so upgrade or leave it out.)
What it sends
Each call is a JSON-RPC request to /api/mcp (notify/schedule_run), not the run receipt at POST /api/v1/ingest/cron, so it carries no outcome metrics.
Rails
For Ruby on Rails applications, send an HTTP check-in from your jobs. See the check-in recipes.