Project

cloud66

0.0
The project is in a healthy, maintained state
Cloud 66 Ruby plugin
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 2.3
 Project Readme

Cloud66

This gem provides various integrations with Cloud 66.

Usage

Queue Metrics Endpoint

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:

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.

Configuration

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

Installation

Add this line to your application's Gemfile:

gem "cloud66"

And then execute:

$ bundle

Or install it yourself as:

$ gem install cloud66

License

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