Configurer AppSignal
Ce guide utilisera la méthode de l’option de configurationrevision pour signaler les marqueurs de déploiement. Vous pouvez en savoir plus sur les approches alternatives dans notre documentation Marqueurs de déploiement.
L’option de configuration revision est configurée différemment selon le langage de l’intégration. Consultez la liste des intégrations ci-dessous pour celle que votre application utilise.
Notez qu’AppSignal signalera automatiquement un déploiement lors de l’utilisation de plateformes telles que Heroku ou Render, ou d’orchestrateurs de déploiement tels que Kamal.
Mettre à jour automatiquement la révision
Nous vous recommandons de récupérer dynamiquement la valeur de l’option de configuration revision depuis le système de gestion de code source utilisé pour votre projet (comme Git ou SVN) au démarrage ou au déploiement. De cette façon, la valeur n’a pas besoin d’être mise à jour manuellement à chaque déploiement. Si un hash de commit Git est utilisé, il sera également compatible avec les liens vers les backtraces d’erreurs. Voici un exemple de la façon de procéder avec Git :Configurations par langage
Ruby
Pour les applications Ruby, nous chargerons la révision Git depuis le fichier de configuration. La commande shell que nous exécutons dans l’option de configurationrevision est la même commande que nous avons utilisée précédemment pour récupérer le hash du commit actuel. Nous appelons la commande git rev-parse et définissons la sortie comme valeur de l’option de configuration revision, comme dans l’exemple ci-dessous :
Utilisation des gems de déploiement Ruby
Si vous utilisez un outil de déploiement comme Capistrano ou Hatchbox qui exclut le dossier.git du déploiement :
- Modifiez le processus de déploiement pour exécuter une commande qui crée un fichier
REVISIONdans le dossiercurrentcontenant le hash Git :git rev-parse --short HEAD > REVISION
REVISION lors de l’utilisation de Rails :
revision de Ruby
Elixir
Pour les applications Elixir, nous chargerons la révision Git dans le fichier de configurationconfig/appsignal.exs (l’emplacement de votre fichier peut différer).
Dans l’exemple de fichier config/appsignal.exs ci-dessous, nous appelons la commande git rev-parse avec Elixir et définissons la sortie comme valeur de l’option de configuration revision.
revision d’Elixir
Node.js
Pour les applications Node.js, la révision Git est chargée dans le fichier de configuration de l’application. Dans l’extrait.js ci-dessous, nous appelons la commande git rev-parse avec Node.js et définissons la sortie comme valeur de l’option de configuration revision.
revision de Node.js
Python
Pour les applications Python, la révision Git est chargée dans le fichier de configuration__appsignal__.py de l’application.
Dans l’exemple ci-dessous, nous appelons la commande git rev-parse avec Python et définissons la sortie comme valeur de l’option de configuration revision. La commande shell que nous exécutons est la même commande que nous avons utilisée précédemment pour récupérer le hash du commit actuel.
revision de Python
JavaScript front-end
Comme les applications JavaScript front-end s’exécutent dans le navigateur, il n’est pas possible d’appeler la commande exécutablegit depuis votre application front-end pour obtenir la revision actuelle. Il existe deux approches courantes pour transmettre la valeur de la révision à votre application front-end :
Utiliser les variables d’environnement au moment du build (recommandé pour les front-ends découplés)
Les outils de build front-end modernes intègrent les variables d’environnement dans votre bundle au moment du build. Vous pouvez transmettre la révision Git via l’une de ces variables et la référencer dans votre configuration AppSignal. Le préfixe de la variable et le modèle d’accès dépendent de votre outil de build. L’exemple ci-dessous utilise Vite, qui expose les variables d’environnement préfixées parVITE_ via l’objet import.meta.env. Définissez la variable avant de construire :
appsignal configurée à l’endroit où vous initialisez votre application. Par exemple, dans le main.js d’une application Vue :
Utiliser un attribut HTML rendu côté back-end
Si votre front-end est rendu par une application back-end (telle qu’une application Ruby ou Elixir), vous pouvez définir la valeur derevision dans le corps HTML en tant qu’attribut data :
revision de JavaScript
Go
Pour les applications Go, la révision est définie sur un attribut de ressource OpenTelemetry lors de l’initialisation d’OpenTelemetry. Dans l’exemple ci-dessous, nous appelons la commandegit rev-parse et définissons la sortie comme attribut de ressource appsignal.config.revision. La commande shell que nous exécutons est la même commande que nous avons utilisée précédemment pour récupérer le hash du commit actuel.
appsignal.config.revision est une configuration obligatoire, elle devrait donc déjà être définie. Veuillez consulter l’option de configuration appsignal.config.revision pour plus d’informations.
Java
Pour les applications Java, définissez la révision à l’aide de la variable d’environnementOTEL_RESOURCE_ATTRIBUTES. Nous utiliserons la même commande Git que celle indiquée précédemment.
appsignal.config.revision est une configuration obligatoire, elle devrait donc déjà être définie. Veuillez consulter l’option de configuration appsignal.config.revision pour plus d’informations.
PHP
Pour les applications PHP, définissez la révision dans votre configuration pour remplacer la valeur par défaut. Par défaut, AppSignal définit la révision en utilisant la même commande Git que celle présentée dans Mettre à jour automatiquement la révision.appsignal.config.revision pour plus d’informations.
Déployer
Une fois la configuration de l’optionrevision terminée, validez vos modifications et déployez votre application. Au démarrage/redémarrage de l’application, AppSignal créera un déploiement dans la section déploiements pour votre application.
C’est tout ! Vous avez configuré avec succès votre application pour notifier AppSignal des déploiements ! Les données de votre application seront suivies aux côtés du déploiement approprié, vous aidant à mieux analyser les performances de votre application.
Les déploiements ne sont pas signalés ou le sont de manière incorrecte ? Contactez-nous et nous vous aiderons !