Various tools to use with www.peakflow.io.

Add this line to your application's Gemfile:

gem "peak_flow_utils"

And then execute:

$ bundle

Or install it yourself as:

$ gem install peak_flow_utils

Add this to config/peakflow.rb:

PeakFlowUtils::Notifier.configure(auth_token: "your-token")

PeakFlowUtils::Notifier.notify(error: error)

Add this to config/peakflow.rb:

PeakFlowUtils::NotifierRails.configure

If you want the job name and its arguments logged in parameters you can execute this service:

PeakFlowUtils::ActiveJobParametersLogging.execute!

Add this to config/peakflow.rb:

PeakFlowUtils::NotifierSidekiq.configure

If you want the job name and its arguments logged in parameters you can execute this service:

PeakFlowUtils::SidekiqParametersLogging.execute!

Add this to routes.rb:

Rails.application.routes.draw do
  mount PeakFlowUtils::Engine => "/peakflow_utils"

Add these to .env variables:

PEAKFLOW_PINGS_USERNAME=username
PEAKFLOW_PINGS_PASSWORD=secret-password

You can now add a HTTP ping on this path: /peakflow_utils/pings/sidekiq

And this for Postgres: /pings/postgres_connections

Contribution directions go here.

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