Add the following to your Gemfile
:
gem 'opbeat', '~> 3.0'
The Opbeat gem adhere to Semantic Versioning and so you can safely trust all minor and patch versions (e.g. 3.x.x) to be backwards compatible.
Add the following to your config/environments/production.rb
:
Rails.application.config do |config|
# ...
config.opbeat.organization_id = 'XXX'
config.opbeat.app_id = 'XXX'
config.opbeat.secret_token = 'XXX'
end
require 'opbeat'
# set up an Opbeat configuration
config = Opbeat::Configuration.new do |conf|
conf.organization_id = 'XXX'
conf.app_id = 'XXX'
conf.secret_token = 'XXX'
end
# start the Opbeat client
Opbeat.start! config
# install the Opbeat middleware
use Opbeat::Middleware
Opbeat works with just the authentication configuration but of course there are other knobs to turn. For a complete list, see configuration.rb.
As a default Opbeat only runs in production. You can make it run in other environments by adding them to the enabled_environments
whitelist.
config.opbeat.enabled_environments += %w{development}
config.opbeat.excluded_exceptions += %w{
ActiveRecord::RecordNotFound
ActionController::RoutingError
}
Opbeat can strip certain data points from the reports it sends like passwords or other sensitive information. If you're on Rails the list will automatically include what you have in config.filter_parameters
.
Add or modify the list using the filter_parameters
configuration:
config.opbeat.filter_parameters += [/regex(p)?/, "string", :symbol]
Opbeat can automatically add user information to errors. By default it looks for at method called current_user
on the current controller. To change the method use current_user_method
.
config.opbeat.current_user_method = :current_employee
Opbeat automatically catches exceptions in delayed_job or sidekiq.
To enable Opbeat for resque, add the following (for example in config/initializers/opbeat_resque.rb
):
require "resque/failure/multiple"
require "opbeat/integration/resque"
Resque::Failure::Multiple.classes = [Resque::Failure::Opbeat]
Resque::Failure.backend = Resque::Failure::Multiple
It's easy to add performance tracking wherever you want using the Opbeat
module.
Basically you have to know about two concepts: Transaction
and Trace
.
Transactions are a bundles of transactions. In a typical webapp every request is wrapped in a transaction. If you're instrumenting worker jobs, a single job run would be a transaction.
Traces are spans of time that happen during a transaction. Like a call to the database, a render of a view or a HTTP request. Opbeat will automatically trace the libraries that it knows of and you can manually trace whatever else you'd like to.
The basic api looks like this:
Opbeat.transaction "Transaction identifier" do
data = Opbeat.trace "Preparation" do
prepare_data
end
Opbeat.trace "Description", "kind" do
perform_expensive_task data
end
end.done(200)
Here, for example is how you could profile a Sidekiq worker job:
class MyWorker
include Sidekiq::Worker
def perform
Opbeat.transaction "MyWorker#perform", "worker.sidekiq" do
User.find_each do |user|
Opbeat.trace 'run!' do
user.sync_with_payment_provider!
end
end
end.submit(true)
# `true` here is the result of the transaction
# eg 200, 404 and so on for web requests but
# anything that translates into JSON works
Opbeat.flush_transactions # send transactions right away
end
end
If you are inside a web request, you are already inside a transaction so you only need to use trace:
class UsersController < ApplicationController
def extend_profiles
users = User.all
Opbeat.trace "prepare users" do
users.each { |user| user.extend_profile! }
end
render text: 'ok'
end
end
$ bundle install
$ rspec spec
Be aware that 3.0 is a almost complete rewrite of the Opbeat ruby client. It is not api compliant with version 2 and below.