L’intégration Capistrano garantit qu’un marqueur de déploiement AppSignal est créé à
chaque déploiement. En savoir plus sur les
marqueurs de déploiement. Une configuration manuelle
peut être nécessaire.
Installation
Assurez-vous de charger le fichier appsignal/capistrano dans le Capfile de Capistrano.
Cela devrait être fait automatiquement lorsque vous exécutez la commande appsignal install
pendant l’installation.
# Capfile
require 'capistrano'
# Other Capistrano requires.
require 'appsignal/capistrano'
Configuration
appsignal_config
# deploy.rb
set :appsignal_config, name: 'My app'
appsignal_config vous permet de remplacer toute configuration chargée depuis le fichier de configuration.
appsignal_env (depuis la version 1.3 de la gem)
# deploy.rb
set :stage, :alpha
set :appsignal_env, :staging
appsignal_env vous permet de charger un environnement AppSignal différent lorsqu’un
nom d’étape ne correspond pas à l’environnement AppSignal tel que nommé dans le fichier de configuration AppSignal
ou la variable d’environnement.
appsignal_revision (depuis la version 0.8.8 de la gem)
Cette méthode de signalement des marqueurs de déploiement est obsolète et peut être supprimée à tout moment à l’avenir.
Signaler des marqueurs de déploiement avec cette méthode n’est utile que pour les petites applications qui utilisent une seule instance d’application. Elle crée un nouveau marqueur de déploiement à un moment précis, indépendamment de la version réellement exécutée par l’application. Cela signifie également qu’elle est plus sujette aux erreurs en regroupant sous le déploiement des données qui ne devraient pas en faire partie. Nous détectons automatiquement le déploiement en lisant le fichier REVISION que Capistrano ajoute au répertoire de release depuis la gem Ruby 4.5.18.
Dans Capistrano 2, AppSignal peut récupérer la révision depuis la configuration
Capistrano.
Dans Capistrano 3, cependant, cela n’est plus disponible et il est recommandé de définir
la révision.
# deploy.rb
set :appsignal_revision, "my_revision"
La révision peut être définie manuellement ou récupérée localement depuis le repository git.
# Sets the current branch's git commit SHA as the revision
set :appsignal_revision, `git rev-parse --short HEAD`.strip
Si vous utilisez le paramètre de configuration branch de Capistrano, vous pouvez également définir
git pour récupérer le SHA du commit depuis la branche sélectionnée.
set :branch, "main"
# Sets the selected branch's git commit SHA as the revision
set :appsignal_revision, `git rev-parse --short #{fetch(:branch)}`.strip
appsignal_user (depuis la version 2.4.0 de la gem)
Utilisé en combinaison avec appsignal_revision (si nécessaire), il est possible de personnaliser un utilisateur de déploiement pour les déploiements Capistrano.
Par défaut, cela utilise le nom d’utilisateur local du système, lu depuis la variable d’environnement USER ou USERNAME, il n’est donc pas nécessaire de le configurer si le système dispose de ces variables.
Si vous souhaitez personnaliser l’utilisateur de déploiement, définissez l’option de configuration :appsignal_user dans votre configuration Capistrano.
# deploy.rb
set :appsignal_user, "Jane" # Custom deploy user name
Exemples d’applications
Nous avons deux exemples d’applications dans notre repository d’exemples sur GitHub. Les
exemples montrent comment configurer AppSignal dans de petites applications Capistrano tout en
chargeant les valeurs de configuration depuis l’environnement à l’aide de gems comme dotenv et
Figaro.