Mise à niveau de la gem AppSignal pour Ruby 3.x vers 4.x

​

Mise à niveau vers la dernière série 3.x

# Gemfile

gem "appsignal", "~> 3.0"

​

Mise à niveau vers la dernière série 4.x

# Gemfile

gem "appsignal"

​

Changements

​

Bibliothèque principale

• La méthode Appsignal.start_logger est supprimée. Le logger est désormais démarré automatiquement par Appsignal.start. Les applications doivent supprimer l’appel à Appsignal.start_logger.
• La configuration de la gem Ruby AppSignal est figée après l’appel à Appsignal.start. La configuration ne peut plus être modifiée après le démarrage de la gem Ruby.
• La méthode Appsignal.start ne peut être appelée qu’une seule fois. Les appels suivants sont ignorés par la gem Ruby.

​

Configuration

• AppSignal ne démarrera pas si le chargement du fichier config/appsignal.yml provoque une erreur. Vérifiez la sortie de l’application ou le fichier appsignal.log pour tout avertissement.
• Configurez AppSignal en Ruby avec le nouvel assistant Appsignal.configure. Les applications utilisant le pattern Appsignal.config = Appsignal::Config.new(...) doivent mettre à jour leurs applications pour utiliser cette méthode à la place.
• La méthode Appsignal.config = est supprimée. Utilisez plutôt l’assistant Appsignal.configure pour configurer AppSignal en Ruby.
• L’option skip_session_data est supprimée. Utilisez plutôt l’option send_session_data.
• L’option debug est supprimée. Utilisez plutôt l’option log_level: debug.
• L’option transaction_debug_mode est supprimée. Utilisez plutôt l’option log_level: trace.
• L’option working_dir_path est supprimée. Utilisez plutôt l’option working_directory_path.

​

Intégrations

• Le middleware Appsignal::Rack::EventHandler est ajouté. Il ajoutera le tag response_status aux échantillons et suivra une métrique response_status avec le code de statut de réponse de la requête. Consultez notre documentation sur l’intégration Rack pour plus d’informations.
• Le middleware Appsignal::Rack::InstrumentationMiddleware remplace le middleware Appsignal::Rack::GenericInstrumentation. Ce nouveau middleware ne définit pas l’action sur « unknown » par défaut. Il est nécessaire de définir le nom de l’action dans chaque endpoint de l’application avec Appsignal.set_action lorsque seul le middleware InstrumentationMiddleware est utilisé. Consultez notre documentation sur l’intégration Rack pour plus d’informations.
• Appsignal::Grape::Middleware est renommé en Appsignal::Rack::GrapeMiddleware.
• Appsignal::Rack::StreamingListener est remplacé par Appsignal::Rack::InstrumentationMiddleware.
• Appsignal::Hooks::SidekiqPlugin est supprimé sans remplacement.
• Les intégrations Grape, Hanami, Padrino et Sinatra utilisent désormais le mécanisme Appsignal.load pour s’intégrer à ces bibliothèques. Veuillez suivre les guides d’installation pour ces bibliothèques afin de passer au nouveau mécanisme de chargement.
  • Sinatra
  • Hanami
  • Grape
  • Padrino
  • Vous utilisez plusieurs de ces bibliothèques ou les montez sur une application Rails ? Suivez également ce guide.
• Les erreurs et problèmes de performance signalés par notre intégration Rake sont désormais signalés sous le namespace « rake ».

​

Instrumentation personnalisée

• L’assistant Appsignal.report_error facilite le signalement systématique des erreurs, sans connaître la différence entre les assistants Appsignal.set_error et Appsignal.send_error.

# 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

• Plusieurs erreurs peuvent être signalées sur une seule transaction avec l’assistant Appsignal.report_error.
• Les assistants Appsignal.monitor_transaction et Appsignal.monitor_single_transaction sont remplacés par les assistants Appsignal.monitor et Appsignal.monitor_and_stop.
  • Remarque : les versions plus récentes de la gem Ruby ont déprécié l’assistant Appsignal.monitor_and_stop.
• Nouveaux assistants pour ajouter des tags et des données d’échantillon (paramètres, en-têtes de requête, données de session et données personnalisées) aux transactions. Consultez la documentation des assistants de personnalisation pour plus d’informations.

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

• Les données d’échantillon sont modifiées par défaut. L’ajout de paramètres, d’en-têtes de requête, de données de session et de données personnalisées supplémentaires les fusionnera avec les valeurs précédemment définies. Consultez la documentation des assistants de personnalisation pour plus d’informations.
• L’assistant Appsignal::Transaction::GenericRequest est supprimé. Utilisez nos assistants de personnalisation pour ajouter des métadonnées à la transaction.
• Les clés d’environnement de requête appsignal.action et appsignal.route sont supprimées. Utilisez plutôt l’assistant Appsignal.set_action pour définir le nom de l’action.
• Les arguments tags et namespace ont été supprimés des assistants Appsignal.set_error et Appsignal.send_error. Utilisez plutôt la méthode block pour personnaliser la transaction avant qu’elle ne soit envoyée. Consultez notre guide de gestion des exceptions pour plus d’informations.
• La constante Appsignal::Minutely est renommée en Appsignal::Probes.
• La méthode Appsignal::Probes.probes.register est remplacée par Appsignal::Probes.register. Consultez notre documentation sur les minutely probes pour plus d’informations.
• Les assistants Appsignal.set_host_gauge et Appsignal.set_process_gauge sont supprimés sans remplacement. À la place, taguez la métrique avec le nom d’hôte ou l’ID du processus à l’aide de l’assistant Appsignal.set_gauge.
• L’assistant Appsignal.listen_for_error est supprimé sans remplacement. À la place, attrapez manuellement les erreurs à l’aide de rescue => error et signalez-les avec l’assistant Appsignal.report_error.

​

Internes de la bibliothèque

• Les méthodes Appsignal::Transaction.create et Appsignal::Transaction.new n’acceptent plus les arguments id, request et options. L’ID de transaction est désormais généré automatiquement.
  • Au lieu de créer manuellement un objet Transaction, utilisez plutôt l’assistant Appsignal.monitor.
  • Pour définir des métadonnées sur la transaction, utilisez nos assistants de personnalisation.
• La méthode Appsignal::Transaction#set_http_or_background_action est supprimée. Utilisez plutôt l’assistant Appsignal.set_action.
• La méthode Appsignal::Transaction#set_http_or_background_queue_start est supprimée. Utilisez plutôt l’assistant Appsignal::Transaction#set_queue_start.
• L’assistant AppSignal::Transaction#params= est supprimé. Utilisez plutôt l’assistant Appsignal.add_params.

​

Bienvenue dans la 4.x !