This gem provides various integrations with Cloud 66.
By default, this gem will expose a metrics endpoint in your application at /cloud66/metrics/queue
, which is only accessible through internal requests to 127.0.0.1
or ::1
.
This endpoint will detect which supported queue frameworks your application uses, and then expose some useful metrics:
- How many jobs are waiting in a given queue
- How many jobs are currently being processed in a given queue
The supported queue frameworks are:
- Sidekiq (7+)
- Resque
- Delayed Job (via the ActiveRecord backend)
If you are using the Rails ActionDispatch::HostAuthorization
middleware (through e.g. config.hosts
), we suggest excluding the metrics endpoint from host authorization using config.host_authorization.exclude
.
You can configure this gem by creating a file in your Rails initializers (e.g. config/initializers/cloud66.rb
) and adding the following (values shown are the defaults):
Cloud66.configure do |config|
config.engine_automount = true
config.engine_automount_endpoint = "/cloud66"
end
Add this line to your application's Gemfile:
gem "cloud66"
And then execute:
$ bundle
Or install it yourself as:
$ gem install cloud66
The gem is available as open source under the terms of the Apache License 2.0.