Passer au contenu principal
La configuration. Importante, car sans elle, le paquet AppSignal pour Elixir ne saura pas quelle application il instrumente ni dans quel environnement. Dans cette rubrique, nous expliquons comment configurer AppSignal, ce qui peut être configuré dans le paquet Elixir et quelle est la configuration minimale requise.

Configuration minimale requise

La configuration minimale requise par AppSignal pour Elixir est constituée des éléments suivants. S’ils ne sont pas présents, AppSignal n’enverra aucune donnée à AppSignal.com.
  • Une Push API Key valide
  • Le nom de l’application OTP
  • Un nom d’application
  • Un environnement d’application (dev / prod / test)
  • L’environnement d’application doit être défini avec active: true
# Example minimal config file
# 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 l’agent à l’aide de variables d’environnement système. AppSignal deviendra automatiquement actif si la variable d’environnement APPSIGNAL_PUSH_API_KEY est définie.
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"

Options de configuration

Découvrez toutes les options de configuration sur la page des options.

Environnements d’application

Une application peut avoir plusieurs environnements tels que « development »/« dev », « test », « staging » et « production ». Pour séparer les erreurs et les problèmes de performance qui surviennent dans l’environnement « development » de ceux en « production », il est possible de définir l’environnement dans lequel l’application s’exécute via l’option de configuration env. Un fichier de configuration d’environnement typique contiendrait ce qui suit.
# config/prod.exs
config :appsignal, :config,
  active: true,
  env: :prod
L’exemple de fichier de configuration ci-dessus est également celui qui est généré par l’installeur AppSignal pour chaque environnement. Si vous activez AppSignal par environnement, en utilisant active: true dans le fichier config/{env}.exs, l’option active n’est pas requise dans le fichier principal config/config.exs.

Désactiver AppSignal pour les tests

Si vous placez toute votre configuration AppSignal dans config/config.exs au lieu de config/prod.exs (par exemple pour avoir AppSignal activé en développement), veillez à mettre active: false dans votre configuration de test, sauf si vous voulez soumettre tous vos résultats de tests.
# config/test.exs
config :appsignal, :config,
  active: false

Exemple de configuration

# config/config.exs
config :appsignal, :config,
  otp_app: :appsignal_phoenix_example,
  name: "AppsignalPhoenixExample",
  push_api_key: "your-push-api-key",
  env: Mix.env,
# config/test.exs
config :appsignal, :config,
  active: false