Sidekiq CloudWatch Metrics
Runs a thread inside your Sidekiq processes to report metrics to CloudWatch useful for autoscaling and keeping an eye on your queues.
Optimised for Sidekiq Enterprise with leader election, but works everywhere!
Add this gem to your application’s Gemfile near sidekiq and then run
gem "sidekiq" gem "sidekiq-cloudwatchmetrics"
Add near your Sidekiq configuration, like in
config/initializers/sidekiq.rb in Rails:
require "sidekiq" require "sidekiq/cloudwatchmetrics" Sidekiq::CloudWatchMetrics.enable!
By default this assumes you're running on an EC2 instance with an instance role that can publish CloudWatch metrics, or that you've supplied AWS credentials through environment variables that aws-sdk expects. You can also explicitly supply an aws-sdk CloudWatch Client instance:
The default namespace for metrics is "Sidekiq". You can configure this with the
Sidekiq::CloudWatchMetrics.enable!(client: Aws::CloudWatch::Client.new, namespace: "Sidekiq-Staging")
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/sj26/sidekiq-cloudwatchmetrics.
The gem is available as open source under the terms of the MIT License.