Custom instrumentation

When installed and properly configured, ElasticAPM will automatically wrap your app’s request/responses in transactions and report its errors. It also wraps each background job if you use Sidekiq or DelayedJob.

But it is also possible to create your own transactions as well as provide spans for any automatic or custom transaction.

See ElasticAPM.start_transaction and ElasticAPM.start_span.

ElasticAPM includes some nifty helpers if you just want to instrument a regular method.

class Thing
  include ElasticAPM::SpanHelpers

  def do_the_work
    # ...
  end
  span_method :do_hard_work1

  def self.do_all_the_work
    # ...
  end
  span_class_method :do_hard_work, 'Custom name', 'custom.work_thing'
end

1. takes optional `name` and `type`

If you are already inside a Transaction (most likely) and you want to instrument some work inside it, add a custom span:

class ThingsController < ApplicationController
  def index
    @result_of_work = ElasticAPM.with_span "Heavy work" do
      do_the_heavy_work
    end
  end
end

If you are not inside a Transaction already (eg. outside of your common web application) start and manage your own transactions like so:

class Something
  def do_work
    transaction = ElasticAPM.start_transaction 'Something#do_work'

    begin
      Sequel[:users]1
    rescue Exception => e
      ElasticAPM.report(e)
      raise
    ensure
      ElasticAPM.end_transaction('result')
    end
  end
end

1. many third party libs will be automatically instrumented

Note: If the agent isn’t started beforehand this will do nothing. See ElasticAPM.start.