Ruby on Rails

​

O que o AppSignal instrumenta para o Rails

• Requisições de controller (Action Controller): o AppSignal reporta samples de performance e exceptions, agrupados por controller action, por exemplo UsersController#show. Os samples podem incluir parâmetros de requisição filtrados, dados de sessão, headers, caminho da requisição, método da requisição, ID da requisição, status da response e o queue time, quando disponível.
• Renderização de views (Action View): o AppSignal reporta eventos para renderização de templates (render_template.action_view) e de partials (render_partial.action_view) na timeline da requisição.
• Consultas ao banco de dados e carregamento de models (Active Record): o AppSignal reporta eventos para queries SQL (sql.active_record) e instanciação de models (instantiation.active_record) na timeline da requisição.
• Background jobs (Active Job): o AppSignal reporta a execução do job, eventos de enqueue, queue time, argumentos do job, queue, priority, Active Job ID, provider job ID e métricas de status do job.
• Canais WebSocket (Action Cable): o AppSignal reporta actions de channel, callbacks de subscribe e callbacks de unsubscribe.
• Processamento de mailers (Action Mailer): o AppSignal reporta um counter action_mailer_process para cada evento process.action_mailer, com tags de mailer e action.
• Rails error reporter: o AppSignal reporta erros enviados através do ActiveSupport::ErrorReporter, com tags de severity e source.
• Rails runners: o AppSignal reporta erros de Rails runners. A performance requer instrumentation manual.

​

Active Job

​

Action Cable

​

Configurar o AppSignal em um initializer

# config/application.rb

# ...

module MyApp
  class Application < Rails::Application
    # Adicione esta linha
    config.appsignal.start_at = :after_initialize

    # Outras configurações
  end
end

# config/initializers/appsignal.rb

Appsignal.configure do |config|
  config.ignore_actions = ["My action"]
end

​

Error reporting dos initializers

# config.ru
begin
  require ::File.expand_path("../config/environment",  __FILE__)
rescue Exception => error
  Appsignal.send_error(error)
  raise
end

​

Backtrace cleaner

# config/initializers/backtrace_cleaner.rb
bc = Rails.backtrace_cleaner
bc.add_filter { |line| line.gsub(Rails.root.to_s, '<root>') }
bc.add_silencer { |line| line.index('<root>').nil? and line.index('/') == 0 }
bc.add_silencer { |line| line.index('<root>/vendor/') == 0 }

​

Error reporter

# Em ambos os cenários, o erro é reportado pelo AppSignal
Rails.error.handle do
  raise "some error"
end

Rails.error.record do
  raise "some error"
end

​

Namespace e action a partir da transaction atual

​

Namespace e action a partir do contexto

# O erro reportado aqui terá o namespace "custom_namespace"
# e o nome de action "CustomizedActionName#index"
Rails.error.handle(:context => { :appsignal => { :namespace => "custom_namespace", :action => "CustomizedActionName#index" } }) do
  raise "some error"
end

​

Tags da transaction ativa

# Exemplo de controller Rails usando um callback before_action
class ExamplesController < ApplicationController
  before_action do
    Appsignal.add_tags(:tag1 => "value1", :tag2 => "value2")
  end

  def index
    # O erro reportado aqui terá as mesmas tags definidas
    # como no callback `before_action`
    Rails.error.handle do
      raise "some error"
    end
  end
end

​

Tags do contexto

Rails.error.handle(:context => { :tag1 => "value1", :tag2 => "value2" }) do
  raise "some error"
end

​

Comportamento legado da gem Ruby 3

• Erros reportados com o método Rails.error.handle são reportados ao AppSignal.
• Erros reportados com Rails.error.record não são reportados ao AppSignal para evitar reportar o erro duas vezes quando ele estiver sendo reportado pelo nosso middleware de error reporting do Rails.

# Reportado pelo AppSignal
Rails.error.handle do
  raise "some error"
end

# NÃO reportado pelo AppSignal
Rails.error.record do
  raise "some error"
end

​

Limitações de herança de contexto

​

Runners

bin/rails runner path_to_file.rb

Appsignal.monitor(:namespace => :runner, :action => "Runner name") do
  # Algum código
end

​

Atributos de span

• http.request.method — o método da requisição.
• url.scheme, url.path e url.query — o endereço requisitado.
• http.response.status_code — o status com o qual sua aplicação respondeu.

• db.system.name — o banco de dados no qual a query rodou, como postgresql ou mysql.
• db.query.text — a query, com seus valores removidos.

​

Rastreamento distribuído