Signaler les déploiements pour suivre les améliorations

Le fonctionnement de votre application peut évoluer à chaque nouveau déploiement. En suivant vos déploiements avec AppSignal, les incidents d’erreurs et les mesures de performance sont regroupés par déploiement, vous permettant de voir facilement quel impact vos déploiements ont eu sur les performances et le taux d’erreurs de votre application. AppSignal peut vous amener d’un backtrace d’erreur à la ligne de code d’où provient une erreur spécifique, et cela aide Ce guide vous montrera comment suivre les déploiements dans AppSignal à l’aide de marqueurs de déploiement.

Lisez des informations plus détaillées sur les marqueurs de déploiement et leur utilité.

Configurer AppSignal

Ce guide utilisera la méthode de l’option de configuration revision 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 :

git rev-parse --short HEAD
# Will output the current commit's short SHA

Nous continuerons à utiliser Git pour tous les exemples d’intégration dans cette documentation. Quelle que soit la source que vous utilisez, limitez la révision à une seule valeur sans espaces, comme un SHA de commit Git ou un numéro de version. AppSignal génère des liens vers votre code source à partir de la révision, si bien qu’une valeur que votre hébergeur Git ne peut pas résoudre produit des liens qui n’ouvrent pas le code qu’ils désignent. Pour en savoir plus, consultez le choix d’une valeur de révision.

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 configuration revision 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 :

Appsignal.configure do |config|
  config.revision = `git rev-parse --short HEAD`.strip
end

production:
  revision: "<%= `git rev-parse --short HEAD`.strip %>"
  # Other config options

Utilisation des gems de déploiement Ruby

Des outils de déploiement comme Capistrano et Hatchbox excluent le dossier .git de l’application déployée. La commande git rev-parse de l’exemple précédent ne trouve donc pas la révision. Ces outils écrivent à la place un fichier REVISION contenant le SHA du commit Git déployé dans le dossier de release. À partir de la version 4.6.0 de la gem Ruby, AppSignal lit ce fichier et définit l’option de configuration revision sur son contenu. Si votre outil de déploiement n’écrit pas de fichier REVISION, créez-en un à la racine de l’application pendant le déploiement :

git rev-parse --short HEAD > REVISION

Heroku, Render, Kamal et Scalingo définissent la révision dans une variable d’environnement, qu’AppSignal lit également automatiquement. La page de l’option revision indique quelle source AppSignal utilise lorsque plusieurs sont définies. Sur les versions de la gem Ruby antérieures à 4.6.0, lisez le fichier REVISION dans votre configuration. Voici un exemple pour Rails :

Appsignal.configure do |config|
  revision = Rails.root.join("REVISION") if defined?(Rails)
  config.revision = revision.read.strip[0, 7] if revision&.exist?
end

production:
  <% revision = if (defined?(Rails)); Rails.root.join('REVISION'); end %>
  <% if revision&.exist? %>
  revision: "<%= revision.read.strip[0, 7] %>"
  <% end %>

Lire plus sur les détails de l’option de configuration revision de Ruby

Elixir

Pour les applications Elixir, nous chargerons la révision Git dans le fichier de configuration config/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.

# Example: config/appsignal.exs
{revision, _exitcode} = System.cmd("git", ["log", "--pretty=format:%h", "-n 1"])
config :appsignal, :config,
  revision: revision
  # Other config options

Lire plus sur les détails de l’option de configuration 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.

// Example: appsignal.js
const childProcess = require("child_process");
const REVISION = childProcess.execSync("git rev-parse --short HEAD").toString();
const appsignal = new Appsignal({
  revision: REVISION,
  // Other config
});

module.exports = { appsignal };

Lire plus sur les détails de l’option de configuration 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.

# Example: __appsignal__.py
import subprocess
from appsignal import Appsignal

revision = subprocess.check_output(
    "git rev-parse --short HEAD", shell=True, text=True
).strip()

appsignal = Appsignal(
    # Other config
    revision=revision
)

Lire plus sur les détails de l’option de configuration 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écutable git 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 par VITE_ via l’objet import.meta.env. Définissez la variable avant de construire :

export VITE_REVISION=$(git rev-parse --short HEAD)
npm run build

Lisez-la ensuite dans le fichier où vous configurez AppSignal :

// Example: appsignal.js
export const appsignal = new Appsignal({
  revision: import.meta.env.VITE_REVISION,
  // Other config
});

Importez l’instance appsignal configurée à l’endroit où vous initialisez votre application. Par exemple, dans le main.js d’une application Vue :

// Example: main.js
import { createApp } from "vue";
import App from "./App.vue";
import { appsignal } from "./appsignal";
import { errorHandler } from "@appsignal/vue";

const app = createApp(App);
app.config.errorHandler = errorHandler(appsignal, app);

app.mount("#app");

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 de revision dans le corps HTML en tant qu’attribut data :

<body data-app-revision="REVISION VALUE">
  <!-- Rest of the HTML -->
</body>

Récupérez ensuite cette valeur dans votre JavaScript :

// Example: appsignal.js
const body = document.body;
export const appsignal = new Appsignal({
  revision: body.dataset.appRevision,
  // Other config
});

Lire plus sur les détails de l’option de configuration 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 commande git 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.

import (
	"os/exec"

	// And other imports
)

var revision string
cmd := exec.Command("git", "rev-parse", "--short", "HEAD")
output, err := cmd.Output()
if err != nil {
	revision = "unknown"
} else {
	revision = strings.TrimSpace(string(output))
}

res := resource.NewWithAttributes(
	resource.WithAttributes(attribute.String("appsignal.config.revision", revision)),
	// And other resource attributes
)

Pour les applications Go, l’option de configuration 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’environnement OTEL_RESOURCE_ATTRIBUTES. Nous utiliserons la même commande Git que celle indiquée précédemment.

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.revision=$(git rev-parse --short HEAD),\
  ..."

Pour les applications Java, l’option de configuration 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.

$revision = trim(shell_exec('git rev-parse --short HEAD 2>/dev/null')) ?: 'unknown';

return [
    'revision' => $revision,
    // ... other options
];

Veuillez consulter l’option de configuration appsignal.config.revision pour plus d’informations.

Déployer

Une fois la configuration de l’option revision 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 !

Voir aussi

CI locale dans Rails 8.1 : exécuter les vérifications et valider sur GitHub : exécutez les vérifications localement avec bin/ci et publiez un résultat réussi sur une pull request GitHub. Utilisez les marqueurs de déploiement pour enregistrer le moment où chaque révision atteint la production.

Accueil

Guides

Signaler les déploiements pour suivre les améliorations

Configurer AppSignal

Mettre à jour automatiquement la révision

Configurations par langage

Ruby

Utilisation des gems de déploiement Ruby

Elixir

Node.js

Python

JavaScript front-end

Utiliser les variables d’environnement au moment du build (recommandé pour les front-ends découplés)

Utiliser un attribut HTML rendu côté back-end

Go

Java

PHP

Déployer

Voir aussi

​Configurer AppSignal

​Mettre à jour automatiquement la révision

​Configurations par langage

​Ruby

​Utilisation des gems de déploiement Ruby

​Elixir

​Node.js

​Python

​JavaScript front-end

​Utiliser les variables d’environnement au moment du build (recommandé pour les front-ends découplés)

​Utiliser un attribut HTML rendu côté back-end

​Go

​Java

​PHP

​Déployer

​Voir aussi

Configurer AppSignal

Mettre à jour automatiquement la révision

Configurations par langage

Ruby

Utilisation des gems de déploiement Ruby

Elixir

Node.js

Python

JavaScript front-end

Utiliser les variables d’environnement au moment du build (recommandé pour les front-ends découplés)

Utiliser un attribut HTML rendu côté back-end

Go

Java

PHP

Déployer

Voir aussi