Upgrade von AppSignal für Ruby-Gem 3.x auf 4.x

​

Upgrade auf die neueste 3.x-Serie

# Gemfile

gem "appsignal", "~> 3.0"

​

Upgrade auf die neueste 4.x-Serie

# Gemfile

gem "appsignal"

​

Änderungen

​

Hauptbibliothek

• Die Methode Appsignal.start_logger wurde entfernt. Der Logger wird jetzt automatisch bei Appsignal.start gestartet. Anwendungen müssen den Aufruf von Appsignal.start_logger entfernen.
• Die Konfiguration des AppSignal Ruby-Gems wird eingefroren, nachdem Appsignal.start aufgerufen wurde. Die Konfiguration kann nach dem Start des Ruby-Gems nicht mehr geändert werden.
• Die Methode Appsignal.start kann nur einmal aufgerufen werden. Nachfolgende Aufrufe werden vom Ruby-Gem ignoriert.

​

Konfiguration

• AppSignal startet nicht, wenn das Laden der config/appsignal.yml-Datei einen Fehler verursacht. Prüfen Sie die Ausgabe der Anwendung oder die appsignal.log-Datei auf Warnungen.
• Konfigurieren Sie AppSignal in Ruby mit dem neuen Appsignal.configure-Helper. Apps, die das Muster Appsignal.config = Appsignal::Config.new(...) verwenden, müssen ihre Apps aktualisieren, um stattdessen diese Methode zu verwenden.
• Die Methode Appsignal.config = wurde entfernt. Verwenden Sie stattdessen den Appsignal.configure-Helper, um AppSignal in Ruby zu konfigurieren.
• Die Option skip_session_data wurde entfernt. Verwenden Sie stattdessen die send_session_data-Option.
• Die Option debug wurde entfernt. Verwenden Sie stattdessen die Option log_level: debug.
• Die Option transaction_debug_mode wurde entfernt. Verwenden Sie stattdessen die Option log_level: trace.
• Die Option working_dir_path wurde entfernt. Verwenden Sie stattdessen die working_directory_path-Option.

​

Integrationen

• Die Middleware Appsignal::Rack::EventHandler wurde hinzugefügt. Sie fügt das Tag response_status zu Samples hinzu und verfolgt eine response_status-Metrik mit dem HTTP-Statuscode der Antwort der Anfrage. Weitere Informationen finden Sie in unserer Rack-Integrationsdokumentation.
• Die Middleware Appsignal::Rack::InstrumentationMiddleware ersetzt die Middleware Appsignal::Rack::GenericInstrumentation. Diese neue Middleware setzt die Action standardmäßig nicht auf “unknown”. Es ist erforderlich, den Action-Namen in jedem App-Endpunkt mit Appsignal.set_action zu setzen, wenn nur die InstrumentationMiddleware verwendet wird. Weitere Informationen finden Sie in unserer Rack-Integrationsdokumentation.
• Appsignal::Grape::Middleware wurde in Appsignal::Rack::GrapeMiddleware umbenannt.
• Appsignal::Rack::StreamingListener wurde durch Appsignal::Rack::InstrumentationMiddleware ersetzt.
• Appsignal::Hooks::SidekiqPlugin wurde ersatzlos entfernt.
• Die Integrationen für Grape, Hanami, Padrino und Sinatra verwenden jetzt den Appsignal.load-Mechanismus, um sich in diese Bibliotheken zu integrieren. Bitte folgen Sie den Installationsanleitungen für diese Bibliotheken, um auf den neuen Lademechanismus umzustellen.
  • Sinatra
  • Hanami
  • Grape
  • Padrino
  • Verwenden Sie mehr als eine dieser Bibliotheken oder mounten Sie sie auf einer Rails-App? Folgen Sie auch diesem Leitfaden.
• Die von unserer Rake-Integration gemeldeten Fehler und Performance-Probleme werden jetzt unter dem Namespace “rake” gemeldet.

​

Benutzerdefinierte Instrumentierung

• Der Appsignal.report_error-Helper macht es einfacher, Fehler immer zu melden, ohne den Unterschied zwischen den Helpern Appsignal.set_error und Appsignal.send_error zu kennen.

# Before
Appsignal.set_error(error)
Appsignal.send_error(error, :tag => "value", "custom namespace")

# After
Appsignal.report_error(error)
Appsignal.report_error(error) do
  Appsignal.set_namespace("custom namespace")
  Appsignal.add_tags(:tag => "value")
end

• Mehrere Fehler können in einer Transaktion mit dem Appsignal.report_error-Helper gemeldet werden.
• Die Helper Appsignal.monitor_transaction und Appsignal.monitor_single_transaction wurden durch die Helper Appsignal.monitor und Appsignal.monitor_and_stop ersetzt.
  • Hinweis: In neueren Versionen des Ruby-Gems wurde der Helper Appsignal.monitor_and_stop als veraltet markiert.
• Neue Helper zum Hinzufügen von Tags und Sample-Daten (Parameter, Request-Header, Session-Daten und benutzerdefinierte Daten) zu Transaktionen. Weitere Informationen finden Sie in der Dokumentation zu den Anpassungs-Helpern.

# Before
Appsignal.tag_request(:tag => "value")
Appsignal::Transaction.current.set_sample_data(
  "custom_data",
  :i18n => {
    :locale => "en_GB",
    :default_locale => "en_US"
  }
)

# After
Appsignal.add_tags(:tag => "value")
Appsignal.add_custom_data(
  :i18n => {
    :locale => "en_GB",
    :default_locale => "en_US"
  }
)

• Sample-Daten werden standardmäßig ergänzt. Das Hinzufügen weiterer Parameter, Request-Header, Session-Daten und benutzerdefinierter Daten wird mit den zuvor gesetzten Werten zusammengeführt. Weitere Informationen finden Sie in der Dokumentation zu den Anpassungs-Helpern.
• Der Helper Appsignal::Transaction::GenericRequest wurde entfernt. Verwenden Sie unsere Anpassungs-Helper, um der Transaktion Metadaten hinzuzufügen.
• Die Request-Environment-Schlüssel appsignal.action und appsignal.route wurden entfernt. Verwenden Sie stattdessen den Helper Appsignal.set_action, um den Action-Namen zu setzen.
• Die Argumente tags und namespace wurden aus den Helpern Appsignal.set_error und Appsignal.send_error entfernt. Verwenden Sie stattdessen die Block-Methode, um die Transaktion vor dem Senden anzupassen. Weitere Informationen finden Sie in unserem Leitfaden zur Exception-Handhabung.
• Die Konstante Appsignal::Minutely wurde in Appsignal::Probes umbenannt.
• Die Methode Appsignal::Probes.probes.register wurde durch Appsignal::Probes.register ersetzt. Weitere Informationen finden Sie in unserer Dokumentation zu Minutely-Probes.
• Die Helper Appsignal.set_host_gauge und Appsignal.set_process_gauge wurden ersatzlos entfernt. Taggen Sie die Metrik stattdessen mit dem Hostnamen oder der Prozess-ID mit dem Appsignal.set_gauge-Helper.
• Der Helper Appsignal.listen_for_error wurde ersatzlos entfernt. Fangen Sie Fehler stattdessen manuell mit rescue => error ab und melden Sie sie mit dem Appsignal.report_error-Helper.

​

Bibliotheks-Interna

• Die Methoden Appsignal::Transaction.create und Appsignal::Transaction.new akzeptieren die Argumente id, request und options nicht mehr. Die Transaktions-ID wird jetzt automatisch generiert.
  • Anstatt ein Transaction-Objekt manuell zu erstellen, verwenden Sie stattdessen den Appsignal.monitor-Helper.
  • Um Metadaten auf der Transaktion zu setzen, verwenden Sie unsere Anpassungs-Helper.
• Die Methode Appsignal::Transaction#set_http_or_background_action wurde entfernt. Verwenden Sie stattdessen den Helper Appsignal.set_action.
• Die Methode Appsignal::Transaction#set_http_or_background_queue_start wurde entfernt. Verwenden Sie stattdessen den Helper Appsignal::Transaction#set_queue_start.
• Der Helper AppSignal::Transaction#params= wurde entfernt. Verwenden Sie stattdessen den Appsignal.add_params-Helper.

​

Willkommen bei 4.x!