Options de configuration du paquet Elixir

La liste suivante inclut toutes les options de configuration avec le nom de la variable d’environnement et le nom de la clé dans le fichier de configuration. Pour plus d’informations sur la façon de configurer AppSignal avec un fichier de configuration ou des variables d’environnement système, consultez notre rubrique Configuration.

Options disponibles

Options requises
- active
- env
- name
- otp_app
- push_api_key
Options

active

Champ	Valeur
Clé du fichier de configuration	`active`
Clé de variable d’environnement système	`APPSIGNAL_ACTIVE`
Requis	oui
Type	Booléen (`true` / `false`)
Valeur par défaut	`false` / détecté par le système
Disponible depuis la version	`0.1.0`

Description

Remarque : Lorsque la variable d’environnement APPSIGNAL_PUSH_API_KEY est définie, cette option vaut true par défaut. Cela peut être remplacé en définissant la variable d’environnement système APPSIGNAL_ACTIVE sur false : APPSIGNAL_ACTIVE=false.

Configurez AppSignal pour qu’il soit actif ou non pour un environnement donné. Le plus souvent utilisé dans la configuration par fichier par environnement.

env

Champ	Valeur
Clé du fichier de configuration	`env`
Clé de variable d’environnement système	`APPSIGNAL_APP_ENV`
Requis	oui
Type	`Atom`
Valeur par défaut	`dev`
Disponible depuis la version	`0.1.0`
	`0.9.2` : Le nom de la variable d’environnement pour cette option de configuration a été renommé de `APPSIGNAL_ENVIRONMENT` en `APPSIGNAL_APP_ENV`.

Description

L’environnement de l’application à signaler à AppSignal. Cette option est définie par défaut par notre installateur sur Mix.env. Pour la remplacer, modifiez la valeur dans config/appsignal.exs (ou votre fichier de configuration de votre choix).

Elixir

# config/appsignal.exs
# or config/config.exs
config :appsignal, :config,
  env: Mix.env # Installer default

# Set your own value
config :appsignal, :config,
  env: :staging

Pour remplacer l’option de configuration dans l’environnement système, utilisez la variable d’environnement APPSIGNAL_APP_ENV.

Shell

# The method of setting environment variables may differ on your system
export APPSIGNAL_APP_ENV=staging
mix run

L’option de variable d’environnement est couramment utilisée sur des plateformes telles que Heroku, où les applications s’exécutent par défaut dans l’environnement production. Ce paramètre permet de remplacer cela pour définir l’environnement sur staging, par exemple.

Shell

heroku config:set APPSIGNAL_APP_ENV=staging

Remarque : Modifier le nom ou l’environnement d’une application existante créera une nouvelle application sur AppSignal.com.

name

Champ	Valeur
Clé du fichier de configuration	`name`
Clé de variable d’environnement système	`APPSIGNAL_APP_NAME`
Obligatoire	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

Nom de votre application tel qu’il doit être affiché sur AppSignal.com.

Remarque : Modifier le nom ou l’environnement d’une application existante créera une nouvelle application sur AppSignal.com.

otp_app

Champ	Valeur
Clé du fichier de configuration	`otp_app`
Clé de variable d’environnement système	`APPSIGNAL_OTP_APP`
Obligatoire	oui
Type	`Atom`
Valeur par défaut	nil (non défini par défaut)
Disponible depuis la version	`2.0.0`

Description

Le nom de l’application OTP de votre application, à utiliser pour la configuration automatique de l’instrumentation pour des bibliothèques comme Ecto.

push_api_key

Champ	Valeur
Clé du fichier de configuration	`push_api_key`
Clé de variable d’environnement système	`APPSIGNAL_PUSH_API_KEY`
Obligatoire	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)
Disponible depuis la version	`0.1.0`

Description

La clé d’authentification au niveau de l’organisation pour s’authentifier auprès de notre Push API. En savoir plus sur la clé Push API AppSignal.

Remarque : Lorsque la variable d’environnement système APPSIGNAL_PUSH_API_KEY est définie, l’option active sera par défaut true au lieu de false. Cela signifie qu’AppSignal sera considéré comme actif pour l’environnement chargé même si active est défini sur false dans le fichier de configuration. Pour plus d’informations, voir l’option active.

bind_address

Champ	Valeur
Clé du fichier de configuration	`bind_address`
Clé de variable d’environnement système	`APPSIGNAL_BIND_ADDRESS`
Requis	non
Type	`String`
Valeur par défaut	`127.0.0.1`
Disponible depuis la version	`2.7.7`

Description

Une adresse IPv4 valide que l’agent AppSignal utilise comme liaison pour ses serveurs TCP et UDP. Utilisez une adresse spécifique si vous souhaitez que l’agent n’écoute que les requêtes adressées à cette adresse. Définissez cette option sur 0.0.0.0 pour autoriser la réception des requêtes provenant d’hôtes utilisant n’importe quelle adresse IP. Par défaut, il n’écoute que les requêtes effectuées sur le même hôte. Cette option s’applique à tous les serveurs de l’agent (StatsD, OpenTelemetry et NGINX).

ca_file_path

Champ	Valeur
Clé du fichier de configuration	`ca_file_path`
Clé de variable d’environnement système	`APPSIGNAL_CA_FILE_PATH`
Requis	non
Type	`String`
Valeur par défaut	Chemin du fichier `cacert.pem` fourni.
Disponible depuis la version	`0.12.0`

Description

Configurez le chemin du fichier de certificat SSL. Par défaut, cela pointe vers le fichier cacert.pem fourni par AppSignal dans le package lui-même. Utilisez cette option pour pointer vers un autre fichier de certificat en cas de problème de connexion à notre API.

Remarque : Le chemin spécifié ne peut pas contenir d’abstractions de système de fichiers spécifiques au système d’exploitation, comme le symbole homedir ~ pour les systèmes *NIX. Cela serait considéré comme un chemin mal formé.

cpu_count

Champ	Valeur
Clé du fichier de configuration	`cpu_count`
Clé de variable d’environnement système	`APPSIGNAL_CPU_COUNT`
Requis	non
Type	`Float`
Valeur par défaut	`undefined`
Disponible depuis la version	`2.9.1`

Description

La capacité CPU disponible de l’hôte, en nombre de CPU. Cette valeur est utilisée pour calculer le pourcentage d’utilisation du CPU dans les métriques de l’hôte. Si elle n’est pas définie, l’agent tentera de la détecter automatiquement à partir des cgroups. Le nombre de CPU peut être une fraction, par exemple 0.5.

debug

Champ	Valeur
Clé du fichier de configuration	`debug`
Clé de variable d’environnement système	`APPSIGNAL_DEBUG`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`1.0.0`
	Déprécié depuis la version 2.2.8 au profit de l’option de configuration `log_level`.

Description

Avertissement : Cette option de configuration est dépréciée dans le package Elixir 2.2.8. Veuillez utiliser l’option log_level à la place pour le package Elixir 2.2.8 et versions ultérieures.

Activez la journalisation de débogage, ce qui n’est généralement nécessaire qu’à la demande du support. Avec cette option activée, AppSignal enregistrera beaucoup plus d’informations sur les décisions prises lors de la collecte des métriques et lors de l’envoi des données aux serveurs AppSignal.com. L’activation de la journalisation de débogage peut avoir un léger impact sur l’utilisation du disque et les E/S, en particulier sur les sites à fort trafic. La surcharge CPU est minime lorsque l’option de débogage est activée.

Cette option définit le niveau de gravité du logger interne d’AppSignal. Cette option de configuration n’affecte pas la fonctionnalité de logging.

dns_servers

Champ	Valeur
Clé du fichier de configuration	`dns_servers`
Clé de variable d’environnement système	`APPSIGNAL_DNS_SERVERS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.3.0.beta.2`

Description

Configurez les serveurs DNS que l’agent AppSignal doit utiliser.

# config/config.exs
config :appsignal, :config,
  dns_servers: ["8.8.8.8", "8.8.4.4"]

Si vous êtes affecté par nos délais d’expiration DNS, essayez de définir un serveur DNS manuellement à l’aide de cette option, en veillant à ce que le nom du serveur ne contienne pas plus de 4 points.

Valeurs acceptables : 8.8.8.8, my.custom.local.server.
Valeurs non acceptables : foo, my.awesome.custom.local.dns.server.

Si le serveur DNS ne peut pas être joint, l’agent se rabattra sur la configuration DNS de l’hôte et affichera un message dans le fichier appsignal.log : A problem occurred while setting DNS servers.

ecto_repos

Champ	Valeur
Clé du fichier de configuration	`ecto_repos`
Clé de variable d’environnement système	`APPSIGNAL_ECTO_REPOS`
Requis	non
Type	`list(String)`
Valeur par défaut	`nil`
Disponible depuis la version	`2.0.0`

Description

Configurez les repos Ecto pour lesquels instrumenter les requêtes. Si elle n’est pas définie, AppSignal trouvera automatiquement vos repos via la configuration de votre application.

# config/config.exs
config :appsignal, :config,
  ecto_repos: [AppsignalPhoenixExample.Repo, AppsignalPhoenixExample.AnotherRepo]

enable_error_backend

Champ	Valeur
Clé du fichier de configuration	`enable_error_backend`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_ERROR_BACKEND`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.4.1`

Description

Active le backend d’erreurs dans l’intégration Elixir.

enable_host_metrics

Champ	Valeur
Clé du fichier de configuration	`enable_host_metrics`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_HOST_METRICS`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	“true `/ détecté par le système`

Description

Définissez cette option sur false pour désactiver la collecte des métriques de l’hôte. Sur Heroku et Dokku, les métriques de l’hôte sont désactivées par défaut. Cela s’explique par le fait que ces systèmes rapportent des métriques inexactes depuis l’intérieur des conteneurs. La collecte des métriques de l’hôte sur ces systèmes ne peut pas être activée. Pour Heroku, utilisez plutôt le log drain Heroku.

enable_minutely_probes

Champ	Valeur
Clé du fichier de configuration	`enable_minutely_probes`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.10.1`

Description

Active le système de sondes minutées.

enable_nginx_metrics

Champ	Valeur
Clé du fichier de configuration	`enable_nginx_metrics`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_NGINX_METRICS`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`2.5.2`

Description

Définissez sur true pour activer le serveur de métriques NGINX. Consultez la documentation des métriques NGINX pour plus de détails. Lorsqu’il est activé, l’agent AppSignal écoute un serveur lié à localhost sur le port 27649. Si vous exécutez plusieurs applications instrumentées par AppSignal sur le même serveur, cette option de configuration ne peut être activée que dans l’une d’entre elles.

enable_statsd

Champ	Valeur
Clé du fichier de configuration	`enable_statsd`
Clé de variable d’environnement système	`APPSIGNAL_ENABLE_STATSD`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`2.2.6`

Description

Active le serveur StatsD dans l’agent AppSignal. Lorsqu’il est activé, l’agent AppSignal écoute un serveur lié à localhost sur le port 8125. Si vous exécutez plusieurs applications instrumentées par AppSignal sur le même serveur, cette option de configuration ne peut être activée que dans l’une d’entre elles.

endpoint

Champ	Valeur
Clé du fichier de configuration	`endpoint`
Clé de variable d’environnement système	`APPSIGNAL_PUSH_API_ENDPOINT`
Requis	non
Type	`String`
Valeur par défaut	`https://push.appsignal.com`

Description

Configurez le point de terminaison pour envoyer les données à AppSignal. Ce paramètre n’aura pas besoin d’être modifié.

files_world_accessible

Champ	Valeur
Clé du fichier de configuration	`files_world_accessible`
Clé de variable d’environnement système	`APPSIGNAL_FILES_WORLD_ACCESSIBLE`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.3.4`

Description

Si cette option est définie sur true, le répertoire de travail AppSignal créé est accessible à tous les utilisateurs (permissions Unix 0666). Cela est souvent nécessaire car les processus d’une même application s’exécutent sous des utilisateurs différents. Définissez sur false pour désactiver ce comportement (permissions Unix 0644).

filter_parameters

Champ	Valeur
Clé du fichier de configuration	`filter_parameters`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_PARAMETERS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Liste des clés de paramètres qui doivent être ignorées via le filtrage AppSignal. Leurs valeurs seront remplacées par [FILTERED] lors de la transmission à AppSignal. Vous pouvez configurer cela avec une liste de clés dans le fichier de configuration.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  filter_parameters: ["password", "secret"]

En savoir plus sur le filtrage des paramètres.

filter_session_data

Champ	Valeur
Clé du fichier de configuration	`filter_session_data`
Clé de variable d’environnement système	`APPSIGNAL_FILTER_SESSION_DATA`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.6.0`
	Une mise à jour vers la version `1.6.3` ou supérieure est recommandée.

Description

Liste des clés de données de session qui doivent être ignorées via le filtrage AppSignal. Leurs valeurs seront remplacées par [FILTERED] lors de la transmission à AppSignal. Vous pouvez configurer cela avec une liste de clés dans le fichier de configuration.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  filter_session_data: ["name", "email", "api_token", "token"]

En savoir plus sur le filtrage des données de session.

host_role

Champ	Valeur
Clé du fichier de configuration	`host_role`
Clé de variable d’environnement système	`APPSIGNAL_HOST_ROLE`
Requis	non
Type	`String`
Valeur par défaut	nil (non définie par défaut)
Disponible depuis la version	`2.7.7`

Description

Regroupez les hôtes par rôle et générez des métriques basées sur ce rôle. L’une de ces métriques est la métrique de compteur reporting_hosts. Un bon rôle indique quel est le rôle principal du serveur, comme “webserver”, “processor”, “api”, “database”, “loadbalancer”, etc.

hostname

Champ	Valeur
Clé du fichier de configuration	`hostname`
Clé de variable d’environnement système	`APPSIGNAL_HOSTNAME`
Requis	non
Type	`String`
Valeur par défaut	détecté à partir du système
Disponible depuis la version	`0.12.0`

Description

Cette option remplace le nom d’hôte du serveur. Utile lorsque vous ne pouvez pas définir un nom d’hôte personnalisé ou lorsqu’un identifiant non descriptif est généré pour vous sur les services d’hébergement.

http_proxy

Champ	Valeur
Clé du fichier de configuration	`http_proxy`
Clé de variable d’environnement système	`APPSIGNAL_HTTP_PROXY`
Requis	non
Type	`String`
Valeur par défaut	nil (non définie par défaut)

Description

Si vous avez besoin que l’agent se connecte à Internet via un proxy, définissez l’URL complète du proxy dans cette clé de configuration.

ignore_actions

Champ	Valeur
Clé du fichier de configuration	`ignore_actions`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_ACTIONS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Avec cette option de configuration, vous pouvez spécifier une liste d’actions qui seront ignorées par AppSignal. Tout ce qui se passe, y compris les exceptions, ne sera pas transmis à AppSignal. Cela peut être utile pour ignorer les endpoints de health check ou d’autres actions que vous ne souhaitez pas surveiller. En savoir plus sur l’ignorance des actions.

ignore_errors

Champ	Valeur
Clé du fichier de configuration	`ignore_errors`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_ERRORS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Liste des classes d’erreurs qui seront ignorées. Toute exception levée avec cette classe d’erreur ne sera pas transmise à AppSignal. En savoir plus sur l’ignorance des erreurs.

ignore_logs

Champ	Valeur
Clé du fichier de configuration	`ignore_logs`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_LOGS`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`2.10.0`

Description

Liste des messages de log qui seront ignorés. Tout message de log contenant l’un des éléments de la liste ne sera pas transmis à AppSignal. Un petit sous-ensemble de la syntaxe regex est pris en charge, lisez-en plus à ce sujet dans notre guide Ignorer les logs.

ignore_namespaces

Champ	Valeur
Clé du fichier de configuration	`ignore_namespaces`
Clé de variable d’environnement système	`APPSIGNAL_IGNORE_NAMESPACES`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`
Disponible depuis la version	`1.3.0`

Description

Liste des namespaces qui seront ignorés. Toute erreur levée ou requête lente survenant dans ce namespace ne sera pas envoyée à AppSignal. En savoir plus sur les namespaces.

instrument_absinthe

Champ	Valeur
Clé du fichier de configuration	`instrument_absinthe`
Clé de variable d’environnement système	`APPSIGNAL_INSTRUMENT_ABSINTHE`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.7.0`

Description

Indique s’il faut instrumenter automatiquement les événements Telemetry pour l’intégration du package Absinthe, peut être true ou false.

instrument_ecto

Champ	Valeur
Clé du fichier de configuration	`instrument_ecto`
Clé de variable d’environnement système	`APPSIGNAL_INSTRUMENT_ECTO`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.5.1`

Description

Indique s’il faut instrumenter automatiquement les événements Telemetry pour l’intégration du package Ecto, peut être true ou false.

instrument_finch

Champ	Valeur
Clé du fichier de configuration	`instrument_finch`
Clé de variable d’environnement système	`APPSIGNAL_INSTRUMENT_FINCH`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.5.1`

Description

Indique s’il faut instrumenter automatiquement les événements Telemetry pour l’intégration du package Finch, peut être true ou false.

instrument_oban

Champ	Valeur
Clé du fichier de configuration	`instrument_oban`
Clé de variable d’environnement système	`APPSIGNAL_INSTRUMENT_OBAN`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.5.1`

Description

Indique s’il faut instrumenter automatiquement les événements Telemetry pour l’intégration du package Oban, peut être true ou false.

instrument_tesla

Champ	Valeur
Clé du fichier de configuration	`instrument_tesla`
Clé de variable d’environnement système	`APPSIGNAL_INSTRUMENT_TESLA`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.7.3`

Description

Indique s’il faut instrumenter automatiquement les événements Telemetry pour l’intégration du package Tesla, peut être true ou false.

log

Champ	Valeur
Clé du fichier de configuration	`log`
Clé de variable d’environnement système	`APPSIGNAL_LOG`
Obligatoire	non
Type	`Atom`
Valeur par défaut	`:file`

Description

Cette option configure le logger qu’utilisera la fonctionnalité de journalisation interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.Remarque : L’agent AppSignal, utilisé par l’intégration, écrira toujours dans le fichier “appsignal.log”.

Sélectionnez le logger qu’utilisera l’intégration AppSignal. Les valeurs acceptées sont file et stdout. Voir également la configuration log_path.

file (par défaut)
- Écrit tous les journaux AppSignal sur le système de fichiers.
stdout (par défaut sur Heroku)
- Affiche les journaux AppSignal dans le STDOUT du processus parent au lieu d’un fichier. Utile avec des solutions d’hébergement telles que les systèmes de conteneurs et Heroku.

log_level

Champ	Valeur
Clé du fichier de configuration	`log_level`
Clé de variable d’environnement système	`APPSIGNAL_LOG_LEVEL`
Obligatoire	non
Type	`String`
Valeur par défaut	`info`
Disponible depuis la version	`2.2.8`

Description

Cette option définit le niveau de sévérité du logger interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.

Définit le niveau de sévérité du logger interne d’AppSignal. S’il est configuré sur “info”, il enregistrera tous les messages d’erreur, d’avertissement et d’information, mais pas les messages de débogage. Définir le niveau sur “debug” ou “trace” n’est généralement nécessaire qu’à la demande du support. Définir le niveau sur “debug”/“trace” peut avoir un léger impact sur l’utilisation du disque et les E/S, en particulier sur les sites à fort trafic. La surcharge CPU est minimale avec l’option debug activée. Valeurs acceptées :

error
warning
info
debug
trace

log_path

Champ	Valeur
Clé du fichier de configuration	`log_path`
Clé de variable d’environnement système	`APPSIGNAL_LOG_PATH`
Obligatoire	non
Type	`String`
Valeur par défaut	`/tmp`
Disponible depuis la version	`1.0.0`
	`1.9.0` : Le chemin de journalisation par défaut est passé de `/tmp/appsignal/` à `/tmp/`.

Description

Cette option configure l’emplacement du fichier de journalisation interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.
Remarque : Le chemin spécifié ne peut pas contenir d’abstractions de système de fichiers spécifiques au système d’exploitation, telles que le symbole de répertoire personnel ~ pour les systèmes *NIX. Cela serait considéré comme un chemin mal formé.

Remplace l’emplacement du chemin (répertoire) où le fichier appsignal.log peut être écrit.

nginx_port

Champ	Valeur
Clé du fichier de configuration	`nginx_port`
Clé de variable d’environnement système	`APPSIGNAL_NGINX_PORT`
Obligatoire	non
Type	`Integer`
Valeur par défaut	`27649`
Disponible depuis la version	`2.15.8`

Description

Configure le port sur lequel le serveur de métriques NGINX est exposé. Lorsqu’AppSignal reçoit des métriques NGINX, il écoute sur un serveur lié à localhost, par défaut sur le port 27649. Si vous exécutez plusieurs applications instrumentées avec AppSignal sur le même serveur avec les métriques NGINX activées, utilisez cette option pour configurer chaque application afin qu’elle écoute sur un port différent.

report_oban_errors

Champ	Valeur
Clé du fichier de configuration	`report_oban_errors`
Clé de variable d’environnement système	`APPSIGNAL_REPORT_OBAN_ERRORS`
Obligatoire	non
Type	`String`
Valeur par défaut	`all`
Disponible depuis la version	`2.5.1`

Description

Quand signaler les erreurs reçues par le gestionnaire d’événements d’exception de l’intégration du package Oban lors du traitement d’une tâche. Les valeurs possibles sont :

all : Signaler toutes les erreurs pour chaque exécution de tâche, y compris les nouvelles tentatives.
discard : Signaler les erreurs lorsque la tâche est rejetée à cause de l’erreur. Utilisez cette option pour ne signaler les erreurs que lorsque toutes les nouvelles tentatives de la tâche ont été épuisées.
none : Ne signaler aucune erreur pour les tâches, y compris les nouvelles tentatives.

request_headers

Champ	Valeur
Clé du fichier de configuration	`request_headers`
Clé de variable d’environnement système	`APPSIGNAL_REQUEST_HEADERS`
Obligatoire	non
Type	`list(String)`
Valeur par défaut	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "path-info", "range", "request-method", "request-uri", "server-name", "server-port", "server-protocol"]`
Disponible depuis la version	`1.6.0`
	La mise à niveau vers `1.6.3` ou une version supérieure est recommandée.

Description

L’option de configuration request_headers contient une liste d’en-têtes de requête HTTP qui sont lus et stockés par le package AppSignal Elixir. Cette option de configuration request_headers est une liste d’autorisation, ce qui signifie qu’elle ne prendra que les en-têtes spécifiés par cette option de configuration. Si cette option de configuration n’est pas définie, elle utilisera la valeur par défaut d’AppSignal. La liste suivante est la valeur par défaut du package AppSignal.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  request_headers: ~w(
    accept accept-charset accept-encoding accept-language cache-control
    connection content-length path-info range request-method
    request-uri server-name server-port server-protocol
  )

Pour configurer AppSignal afin qu’il ne stocke aucun en-tête de requête HTTP sur les transactions AppSignal, configurez l’option avec une liste vide.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  request_headers: []

revision

Champ	Valeur
Clé du fichier de configuration	`revision`
Clé de variable d’environnement système	`APP_REVISION`
Obligatoire	non
Type	`String`
Valeur par défaut	nil (non défini par défaut)
Disponible depuis la version	`1.5.0`
	`1.10.12` : Détection automatique pour les déploiements Heroku avec la fonctionnalité Dyno Metadata labs activée. `2.7.6` : Détection automatique pour les déploiements Render. `3.4.7` : Détection automatique pour les déploiements Kamal.

Description

Définissez la révision de l’application pour signaler la version actuellement en cours d’exécution de votre application. AppSignal créera un marqueur de déploiement lorsque cette valeur change, et étiquetera toutes les données entrantes avec la révision actuelle. Lorsque votre application est déployée à l’aide de Kamal, ou lorsqu’elle est déployée sur Render, ou lorsqu’elle est déployée sur Heroku et que la fonctionnalité Heroku Labs: Dyno Metadata est activée, l’intégration AppSignal détectera automatiquement le commit Git du déploiement actuel et l’utilisera comme révision. Vous pouvez écraser les révisions automatiquement détectées dans Heroku, Render ou Kamal en définissant manuellement l’option de configuration revision sur une valeur personnalisée. En savoir plus sur les marqueurs de déploiement dans le sujet sur les marqueurs de déploiement.

running_in_container

Champ	Valeur
Clé du fichier de configuration	`running_in_container`
Clé de variable d’environnement système	`APPSIGNAL_RUNNING_IN_CONTAINER`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	détectée par l’agent

Description

AppSignal s’attend à s’exécuter sur la même machine entre différents déploiements. Définissez cette clé sur true si l’application s’exécute dans un conteneur, par exemple avec Docker. Les versions plus récentes de l’intégration AppSignal détectent automatiquement leur environnement de conteneur, donc aucune configuration manuelle n’est nécessaire. Si vous rencontrez des problèmes avec la détection automatique, veuillez contacter le support. Cette option est définie automatiquement sur true sur Heroku.

send_environment_metadata

Champ	Valeur
Clé du fichier de configuration	`send_environment_metadata`
Clé de variable d’environnement système	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.2.8`

Description

Envoie les métadonnées d’environnement concernant l’application. Pour plus d’informations, veuillez consulter les métadonnées d’environnement.

send_params

Champ	Valeur
Clé du fichier de configuration	`send_params`
Clé de variable d’environnement système	`APPSIGNAL_SEND_PARAMS`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`1.10.0`

Description

Indique s’il faut ignorer l’envoi des paramètres de requête à AppSignal. Pour plus d’informations, veuillez consulter send_params dans le filtrage des paramètres de requête.

send_session_data

Champ	Valeur
Clé du fichier de configuration	`send_session_data`
Clé de variable d’environnement système	`APPSIGNAL_SEND_SESSION_DATA`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`
Disponible depuis la version	`2.2.10`

Description

Définissez cette option sur false pour ne pas envoyer de données de session avec les traces d’exception et les échantillons de problèmes de performance. Pour plus d’informations, veuillez consulter le filtrage des données de session de requête.

skip_session_data

Champ	Valeur
Clé du fichier de configuration	`skip_session_data`
Clé de variable d’environnement système	`APPSIGNAL_SKIP_SESSION_DATA`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`

Description

Avertissement : Cette option de configuration est obsolète dans le package Elixir 2.2.10. Veuillez utiliser l’option send_session_data à la place pour les versions plus récentes du package Elixir.

statsd_port

Champ	Valeur
Clé du fichier de configuration	`statsd_port`
Clé de variable d’environnement système	`APPSIGNAL_STATSD_PORT`
Obligatoire	non
Type	`Integer`
Valeur par défaut	`8125`
Disponible depuis la version	`2.7.2`

Description

Définissez cette option pour configurer le port du serveur HTTP StatsD du processus de l’agent AppSignal. Configurez ce port si un autre processus s’exécute déjà sur la machine et utilise également ce port, afin d’éviter les conflits.

transaction_debug_mode

Champ	Valeur
Clé du fichier de configuration	`transaction_debug_mode`
Clé de variable d’environnement système	`APPSIGNAL_TRANSACTION_DEBUG_MODE`
Obligatoire	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`false`
Disponible depuis la version	`1.11.4`
	Obsolète depuis la version 2.2.9 au profit de l’option de configuration `log_level`.

Description

Avertissement : Cette option de configuration est obsolète dans le package Elixir 2.2.9. Veuillez utiliser l’option log_level à la place pour le package Elixir 2.2.9 et versions ultérieures.

Active le mode débogage des transactions. Cela permet une journalisation très détaillée des transactions et des événements, ce qui est utile lors du développement d’intégrations ou lorsque les événements ne sont pas suivis comme prévu. Le journal n’est écrit que si l’option debug générale est également activée.

Cette option définit le niveau de sévérité du logger interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.

working_dir_path

Champ	Valeur
Clé du fichier de configuration	`working_dir_path`
Clé de variable d’environnement système	`APPSIGNAL_WORKING_DIR_PATH`
Obligatoire	non
Type	`String`
Valeur par défaut	détectée par l’agent
Disponible depuis la version	`1.8.0`

Description

Avertissement : Cette option de configuration est obsolète dans le package Elixir 1.8.0. Veuillez utiliser l’option working_directory_path à la place pour le package Elixir 1.8.0 et versions ultérieures.

Remplace l’emplacement où AppSignal pour Elixir peut stocker des fichiers temporaires. Utilisez cette option si l’emplacement par défaut ne convient pas. Consultez notre page comment fonctionne AppSignal pour plus d’informations sur l’objectif de ce répertoire de travail. Si vous exécutez plusieurs applications utilisant AppSignal sur le même serveur, utilisez cette option de configuration pour sélectionner différents répertoires de travail pour chaque instance AppSignal, sinon les deux instances pourraient entrer en conflit l’une avec l’autre. Pour plus d’informations sur ce scénario, consultez notre documentation exécution de plusieurs applications sur un seul hôte.

Elixir

# config/config.exs
config :appsignal, :config,
  working_dir_path: "/tmp/project_1/"

Remarque : Le chemin spécifié ne peut pas contenir d’abstractions de système de fichiers spécifiques au système d’exploitation, telles que le symbole de répertoire personnel ~ pour les systèmes *NIX. Cela serait considéré comme un chemin mal formé.

working_directory_path

Champ	Valeur
Clé du fichier de configuration	`working_directory_path`
Clé de variable d’environnement système	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Obligatoire	non
Type	`String`
Valeur par défaut	détectée par l’agent
Disponible depuis la version	`1.8.0`
	Veuillez utiliser l’option `working_dir_path` sur les versions antérieures.

Description

Elixir

# config/appsignal.exs
config :appsignal, :config,
  working_directory_path: "/tmp/project_1/"

​Options disponibles

​active

​Description

​env

​Description

​name

​Description

​otp_app

​Description

​push_api_key

​Description

​bind_address

​Description

​ca_file_path

​Description

​cpu_count

​Description

​debug

​Description

​dns_servers

​Description

​ecto_repos

​Description

​enable_error_backend

​Description

​enable_host_metrics

​Description

​enable_minutely_probes

​Description

​enable_nginx_metrics

​Description

​enable_statsd

​Description

​endpoint

​Description

​files_world_accessible

​Description

​filter_parameters

​Description

​filter_session_data

​Description

​host_role

​Description

​hostname

​Description

​http_proxy

​Description

​ignore_actions

​Description

​ignore_errors

​Description

​ignore_logs

​Description

​ignore_namespaces

​Description

​instrument_absinthe

​Description

​instrument_ecto

​Description

​instrument_finch

​Description

​instrument_oban

​Description

​instrument_tesla

​Description

​log

​Description

​log_level

​Description

​log_path

​Description

​nginx_port

​Description

​report_oban_errors

​Description

​request_headers

​Description

​revision

​Description

​running_in_container

Options disponibles

active

Description

env

Description

name

Description

otp_app

Description

push_api_key

Description

bind_address

Description

ca_file_path

Description

cpu_count

Description

debug

Description

dns_servers

Description

ecto_repos

Description

enable_error_backend

Description

enable_host_metrics

Description

enable_minutely_probes

Description

enable_nginx_metrics

Description

enable_statsd

Description

endpoint

Description

files_world_accessible

Description

filter_parameters

Description

filter_session_data

Description

host_role

Description

hostname

Description

http_proxy

Description

ignore_actions

Description

ignore_errors

Description

ignore_logs

Description

ignore_namespaces

Description

instrument_absinthe

Description

instrument_ecto

Description

instrument_finch

Description

instrument_oban

Description

instrument_tesla

Description

log

Description

log_level

Description

log_path

Description

nginx_port

Description

report_oban_errors

Description

request_headers

Description

revision

Description

running_in_container