Passer au contenu principal
Veuillez d’abord suivre le guide d’installation lors de l’ajout d’une nouvelle application à AppSignal.

​
Prérequis

Avant de pouvoir compiler le paquet AppSignal, assurez-vous que les outils de build/compilation sont installés sur votre système. Veuillez consulter la page Systèmes d’exploitation pris en charge pour toute dépendance système qui pourrait être requise.

​
Installation

L’installation du paquet AppSignal dans votre application Elixir nécessite quelques étapes manuelles. Actuellement, AppSignal prend en charge Phoenix, Plug et les applications Elixir pures. Si AppSignal ne prend pas en charge votre cas d’utilisation ou si vous trouvez un problème avec la documentation, n’hésitez pas à nous contacter. Vous pouvez également créer une pull-request sur notre dépôt public Elixir.

​
Installation du paquet

📖 Remarque : Si vous exécutez une application umbrella, consultez également notre guide d’installation umbrella.
Remarque : Si vous utilisez le framework Phoenix ou Plug, continuez avec les guides intégrer AppSignal dans Phoenix ou intégrer AppSignal dans Plug.
  1. Commencez par ajouter appsignal à votre liste de dépendances dans mix.exs.
# mix.exs
def deps do
  [
    {:appsignal, "~> 2.8"}
  ]
end
  1. Puis exécutez mix deps.get.
  2. Puis exécutez mix appsignal.install YOUR_PUSH_API_KEY ou suivez le guide de configuration manuelle.
Une fois l’installation terminée, démarrez votre application. Lorsque l’application OTP AppSignal démarre, elle recherche une configuration valide (par exemple une Push API key AppSignal) et démarre l’agent AppSignal. Si elle ne trouve pas de configuration valide, un avertissement sera journalisé. Consultez la section Configuration pour savoir comment configurer entièrement l’agent AppSignal.

​
Configuration

Avant que le paquet AppSignal ne fonctionne, vous devez le configurer. Pour pouvoir envoyer des données à AppSignal, vous devez d’abord créer un compte sur AppSignal.com. Ou, si vous avez déjà un compte, cliquez sur le bouton « add app » sur AppSignal.com/accounts. Pendant le processus d’installation, vous pouvez exécuter la commande mix appsignal.install avec la Push API key hexadécimale ou configurer AppSignal manuellement en suivant le guide ci-dessous. Pour plus d’informations sur la configuration du paquet AppSignal pour Elixir, veuillez lire notre documentation de configuration.

​
Configuration manuelle

Si vous voulez configurer AppSignal manuellement, vous devrez placer la Push API key AppSignal que vous recevez pendant le processus d’installation dans le fichier de configuration config/config.exs de votre application. Avec la configuration AppSignal, vous pouvez également configurer un nom d’application et un environnement, et bien plus encore. 
# config/config.exs
config :appsignal, :config,
  otp_app: :appsignal_phoenix_example,
  name: "AppsignalPhoenixExample",
  push_api_key: "your-push-api-key",
  env: Mix.env,
  active: true
Vous pouvez également configurer AppSignal en utilisant des variables d’environnement du système d’exploitation. 
export APPSIGNAL_OTP_APP="appsignal_phoenix_example"
export APPSIGNAL_PUSH_API_KEY="your-push-api-key"
export APPSIGNAL_APP_NAME="AppsignalPhoenixExample"
export APPSIGNAL_APP_ENV="prod"
Pour plus d’informations sur la configuration du paquet AppSignal pour Elixir, veuillez consulter notre page des options de configuration.

​
Lancez votre application !

Une fois ce guide terminé, votre application est prête à être surveillée par AppSignal ! Démarrez votre application et effectuez quelques requêtes. En déclenchant une erreur ou deux, vous pourrez également tester la remontée d’erreurs. Contactez-nous si vous avez des questions concernant l’installation ou si vous avez rencontré des problèmes pendant l’installation.

​
Optionnel : Ajouter l’instrumentation Phoenix

Découvrez comment intégrer davantage d’instrumentation dans votre application Phoenix dans notre guide d’intégration Phoenix.

​
Optionnel : Ajouter l’instrumentation Plug

Découvrez comment intégrer davantage d’instrumentation dans votre application Plug dans notre guide d’intégration Plug.

​
Optionnel : Ajouter de l’instrumentation personnalisée

Ajoutez de l’instrumentation personnalisée à votre application pour obtenir une vue plus approfondie de ce qui se passe dans votre application. En savoir plus sur l’instrumentation personnalisée dans notre documentation sur l’instrumentation.
📖 Poursuivez avec notre guide d’installation.

​
Désinstallation

Désinstallez AppSignal de votre application en suivant les étapes ci-dessous. Une fois ces étapes terminées, votre application n’enverra plus de données aux serveurs AppSignal.
  1. Dans le mix.exs de votre application, supprimez la ligne {:appsignal, "~> 2.0"}.
  2. Exécutez mix deps.get pour mettre à jour votre mix.lock avec l’état des paquets supprimés.
  3. Supprimez tous les fichiers de configuration AppSignal de votre application.
    • Emplacement du fichier de configuration : config/appsignal.exs
    • Et ses références dans tous les autres fichiers dans config/*.exs
  4. Supprimez toutes les variables d’environnement système de vos hôtes de développement, staging, production, etc.
    • Variables d’environnement préfixées par APPSIGNAL_
    • Variable d’environnement APP_REVISION
  5. Validez, déployez et redémarrez votre application.
    • Cela garantira que les serveurs AppSignal ne continueront pas à recevoir de données de votre application.
  6. Optionnel : Assurez-vous qu’aucun processus appsignal-agent ne s’exécute en arrière-plan.
    • Vérifiez la sortie de ps aux | grep appsignal-agent et tuez les processus encore en cours d’exécution.
  7. Enfin, supprimez l’application sur AppSignal.com.
📖 Poursuivez avec notre guide de désinstallation.