Ruby on Rails

​

Ce qu’AppSignal instrumente pour Rails

• Requêtes de contrôleur (Action Controller) : AppSignal signale les échantillons de performance et les exceptions, regroupés par action de contrôleur, par exemple UsersController#show. Les échantillons peuvent inclure les paramètres de requête filtrés, les données de session, les en-têtes, le chemin de la requête, la méthode de la requête, l’ID de la requête, le statut de la réponse et le queue time, lorsqu’il est disponible.
• Rendu des vues (Action View) : AppSignal signale des événements pour le rendu des templates (render_template.action_view) et le rendu des partials (render_partial.action_view) dans la chronologie de la requête.
• Requêtes de base de données et chargement des modèles (Active Record) : AppSignal signale des événements pour les requêtes SQL (sql.active_record) et l’instanciation des modèles (instantiation.active_record) dans la chronologie de la requête.
• Background jobs (Active Job) : AppSignal signale l’exécution des jobs, les événements de mise en file d’attente, le queue time, les arguments du job, la queue, la priorité, l’ID Active Job, l’ID du job du provider et les métriques de statut des jobs.
• Canaux WebSocket (Action Cable) : AppSignal signale les actions de canal, les callbacks de subscribe et les callbacks d’unsubscribe.
• Traitement des mailers (Action Mailer) : AppSignal signale un compteur action_mailer_process pour chaque événement process.action_mailer, avec des tags pour le mailer et l’action.
• Reporter d’erreurs Rails : AppSignal signale les erreurs envoyées via ActiveSupport::ErrorReporter, avec des tags de sévérité et de source.
• Runners Rails : AppSignal signale les erreurs des runners Rails. Les performances nécessitent une instrumentation manuelle.

​

Active Job

​

Action Cable

​

Configurer AppSignal dans un initialiseur

# config/application.rb

# ...

module MyApp
  class Application < Rails::Application
    # Add this line
    config.appsignal.start_at = :after_initialize

    # Other config
  end
end

# config/initializers/appsignal.rb

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

​

Signalement des erreurs depuis les initialiseurs

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

​

Nettoyeur de backtrace

# 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 }

​

Reporter d’erreurs

# In both scenarios, the error is reported by AppSignal
Rails.error.handle do
  raise "some error"
end

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

​

Namespace et action depuis la transaction actuelle

​

Namespace et action depuis le contexte

# The error reported here will have the "custom_namespace" namespace
# and "CustomizedActionName#index" action name
Rails.error.handle(:context => { :appsignal => { :namespace => "custom_namespace", :action => "CustomizedActionName#index" } }) do
  raise "some error"
end

​

Tags depuis la transaction active

# Rails controller example using a before_action callback
class ExamplesController < ApplicationController
  before_action do
    Appsignal.add_tags(:tag1 => "value1", :tag2 => "value2")
  end

  def index
    # The error reported here will have the same tags set
    # as in the `before_action` callback
    Rails.error.handle do
      raise "some error"
    end
  end
end

​

Tags depuis le contexte

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

​

Comportement hérité de la gem Ruby 3

• Les erreurs signalées avec la méthode Rails.error.handle sont signalées à AppSignal.
• Les erreurs signalées avec Rails.error.record ne sont pas signalées à AppSignal pour éviter de signaler l’erreur deux fois lorsqu’elle est signalée par notre middleware de signalement d’erreurs Rails.

# Reported by AppSignal
Rails.error.handle do
  raise "some error"
end

# NOT reported by AppSignal
Rails.error.record do
  raise "some error"
end

​

Limitations d’héritage du contexte

​

Runners

bin/rails runner path_to_file.rb

Appsignal.monitor(:namespace => :runner, :action => "Runner name") do
  # Some code
end

​

Attributs de span

• http.request.method — la méthode de la requête.
• url.scheme, url.path et url.query — l’adresse demandée.
• http.response.status_code — le statut avec lequel votre application a répondu.

• db.system.name — la base de données sur laquelle la requête s’est exécutée, comme postgresql ou mysql.
• db.query.text — la requête, avec ses valeurs supprimées.

​

Tracing distribué