Sidekiq Cronitor

Cronitor provides dead simple monitoring for cron jobs, daemons, queue workers, websites, APIs, and anything else that can send or receive an HTTP request. The Cronitor Sidekiq library provides a drop in integration for monitoring any Sidekiq Job.

NOTE: Version 3.0.0 changes the integration method from 2.x.x. This is a breaking change. You now add the middleware in the Sidekiq initializer. You can opt of out telemetry for specific jobs with a sidekiq_options (see below)

Installation

Add sidekiq-cronitor your application's Gemfile, near sidekiq:

gem 'sidekiq'
gem 'sidekiq-cronitor'

And then bundle:

bundle

Usage

Configure sidekiq-cronitor with an API Key from your settings. You can use ENV variables to configure Cronitor:

export CRONITOR_API_KEY='api_key_123'
export CRONITOR_ENVIRONMENT='development' #default: 'production'

bundle exec sidekiq

Or declare the API key directly on the Cronitor module from within your application (e.g. the Sidekiq initializer).

require 'cronitor'
Cronitor.api_key = 'api_key_123'
Cronitor.environment = 'development' #default: 'production'

Monitor jobs by registering Sidekiq::Cronitor::ServerMiddleware server middleware (most people do this in the Sidekiq initializer).

Sidekiq.configure_server do |config|
  config.server_middleware do |chain|
    chain.add Sidekiq::Cronitor::ServerMiddleware
  end
end

Once the server middleware is registered, Cronitor will send telemetry events with a key matching the name of your job class (MyJob in the example below). If no monitor exists it will create one on the first event. You can configure rules at a later time via the Cronitor dashboard, API, or YAML config file.

Optional: You can specify the monitor key directly using sidekiq_options:

class MyJob
  include Sidekiq::Job
  sidekiq_options cronitor_key: 'abc123'

  def perform
  end
end

To disable Cronitor for a specific job you can set the following option:

class MyJob
  include Sidekiq::Job
  sidekiq_options cronitor_disabled: true

  def perform
  end
end

Periodic/Scheduled Jobs

If you are using Sidekiq Enterprise to run Periodic Jobs or are using the popular sidekiq-scheduler gem, you can sync the schedules of those jobs with a single command.

Sidekiq::Cronitor::PeriodicJobs.sync_schedule!
# or
Sidekiq::Cronitor::SidekiqScheduler.sync_schedule!

Development

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

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cronitorio/cronitor-sidekiq/pulls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

huguesbr/cronitor-sidekiq