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 configuration de l’agent autonome AppSignal via un fichier de configuration ou des variables d’environnement, consultez notre section configuration.
Options disponibles
app_name
| Champ | Valeur |
|---|
| Clé du fichier de configuration | app_name |
| Clé de la variable d’environnement système | APPSIGNAL_APP_NAME |
| Obligatoire | oui |
| Type | String |
| Valeur par défaut | nil (non définie 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. environment
| Champ | Valeur |
|---|
| Clé du fichier de configuration | environment |
| Clé de la variable d’environnement système | APPSIGNAL_APP_ENV |
| Obligatoire | oui |
| Type | String |
| Valeur par défaut | nil (non définie par défaut) |
Description
L’environnement de l’application à signaler à AppSignal.
Remarque : Modifier le nom ou l’environnement d’une application existante
créera une nouvelle application sur AppSignal.com. push_api_key
| Champ | Valeur |
|---|
| Clé du fichier de configuration | push_api_key |
| Clé de la variable d’environnement système | APPSIGNAL_PUSH_API_KEY |
| Obligatoire | oui |
| Type | String |
| Valeur par défaut | nil (non définie par défaut) |
Description
La clé d’authentification au niveau de l’organisation pour s’authentifier auprès de notre Push API.
Pour en savoir plus sur la clé Push API d’AppSignal.
bind_address
| Champ | Valeur |
|---|
| Clé du fichier de configuration | bind_address |
| Clé de la variable d’environnement système | APPSIGNAL_BIND_ADDRESS |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | 127.0.0.1 |
| Disponible depuis la version | 0.0.24 |
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 faites à cette adresse. Définissez cette option sur 0.0.0.0 pour autoriser la réception de requêtes depuis des hôtes utilisant n’importe quelle adresse IP. Par défaut, il n’écoute que les requêtes faites 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 la variable d’environnement système | APPSIGNAL_CA_FILE_PATH |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | Par défaut, les CAs du système. |
Description
- Configurez le chemin du fichier de certificat SSL.
Utilisez cette option pour pointer vers un autre fichier de certificat s’il y a un problème de connexion à notre API.
Remarque : Le chemin spécifié ne peut pas contenir d’abstractions du système de fichiers
spécifiques au système d’exploitation, telles que le symbole du répertoire personnel ~ pour les systèmes *NIX. Cela sera
considéré comme un chemin mal formé.
cpu_count
| Champ | Valeur |
|---|
| Clé du fichier de configuration | cpu_count |
| Clé de la variable d’environnement système | APPSIGNAL_CPU_COUNT |
| Obligatoire | non |
| Type | Float |
| Valeur par défaut | undefined |
| Disponible depuis la version | 0.34.1 |
Description
La capacité CPU disponible de l’hôte, exprimée en nombre de CPUs. Elle est utilisée pour calculer le pourcentage d’utilisation du CPU dans les métriques d’hôte. Si elle n’est pas définie, l’agent tentera de la détecter automatiquement à partir des cgroups.
Le nombre de CPUs peut être une fraction, par exemple 0.5.
dns_servers
| Champ | Valeur |
|---|
| Clé du fichier de configuration | dns_servers |
| Clé de la variable d’environnement système | APPSIGNAL_DNS_SERVERS |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | nil (non définie par défaut) |
Description
Configurez les serveurs DNS à utiliser par l’agent AppSignal.
# /etc/appsignal-agent.conf
dns_servers = "8.8.8.8,8.8.4.4"
- 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.
enable_host_metrics
| Champ | Valeur |
|---|
| Clé du fichier de configuration | enable_host_metrics |
| Clé de la variable d’environnement système | APPSIGNAL_ENABLE_HOST_METRICS |
| Obligatoire | non |
| Type | Booléen (true / false) |
| Valeur par défaut | true / détectée par le système |
| Disponible depuis la version | 0.0.1 |
| 0.0.26 : Désactivée par défaut dans l’image Docker appsignal/agent.
|
Description
Définissez cette option sur false pour désactiver la collecte des métriques d’hôte.
Sur Heroku et Dokku, les métriques d’hôte sont désactivées par défaut. Cela est dû au fait que ces systèmes signalent des métriques inexactes depuis les conteneurs. La collecte des métriques d’hôte ne peut pas être activée sur ces systèmes. Pour Heroku, utilisez plutôt le drain de logs Heroku.
enable_http
| Champ | Valeur |
|---|
| Clé du fichier de configuration | enable_http |
| Obligatoire | non |
| Type | Booléen (true / false) |
| Valeur par défaut | false |
| Disponible depuis la version | 0.0.23 |
| |
Description
Définissez cette option sur true pour activer le serveur HTTP OpenTelemetry.
Lorsqu’elle est activée, l’agent AppSignal écoutera un serveur lié à localhost sur le port 8099. 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’elles.
Ceci est requis pour les applications utilisant l’exportateur HTTP OpenTelemetry pour signaler les données à AppSignal.
enable_nginx_metrics
| Champ | Valeur |
|---|
| Clé du fichier de configuration | enable_nginx_metrics |
| Clé de la variable d’environnement système | APPSIGNAL_ENABLE_NGINX_METRICS |
| Obligatoire | non |
| Type | Booléen (true / false) |
| Valeur par défaut | false |
| Disponible depuis la version | 0.0.24 |
| 0.0.26 : Activée par défaut dans l’image Docker appsignal/agent.
|
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’elle est activée, l’agent AppSignal écoutera 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’elles.
enable_opentelemetry_http
| Champ | Valeur |
|---|
| Clé du fichier de configuration | enable_opentelemetry_http |
| Clé de la variable d’environnement système | APPSIGNAL_ENABLE_OPENTELEMETRY_HTTP |
| Obligatoire | non |
| Type | Booléen (true / false) |
| Valeur par défaut | false / détectée par le système |
| Disponible depuis la version | 0.0.25 |
| 0.0.26 : Activée par défaut dans l’image Docker appsignal/agent.
|
Description
Définissez cette option sur true pour activer le serveur HTTP OpenTelemetry.
Lorsqu’elle est activée, l’agent AppSignal écoutera un serveur lié à localhost sur le port 8099. 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’elles.
Ceci est requis pour les applications utilisant l’exportateur HTTP OpenTelemetry pour signaler les données à AppSignal.
enable_statsd
| Champ | Valeur |
|---|
| Clé du fichier de configuration | enable_statsd |
| Clé de la variable d’environnement système | APPSIGNAL_ENABLE_STATSD |
| Obligatoire | non |
| Type | Booléen (true / false) |
| Valeur par défaut | true |
| Disponible depuis la version | 0.0.24 |
Description
Active le serveur StatsD dans l’agent AppSignal.
Lorsqu’elle est activée, l’agent AppSignal écoutera 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’elles.
filter_parameters
| Champ | Valeur |
|---|
| Clé du fichier de configuration | filter_parameters |
| Clé de la variable d’environnement système | APPSIGNAL_FILTER_PARAMETERS |
| Obligatoire | non |
| Type | Array<String> |
| Valeur par défaut | [] |
| Disponible depuis la version | 0.0.23 |
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.
# appsignal.conf
filter_parameters = ["password", "confirm_password", "secret"]
filter_session_data
| Champ | Valeur |
|---|
| Clé du fichier de configuration | filter_session_data |
| Clé de la variable d’environnement système | APPSIGNAL_FILTER_SESSION_DATA |
| Obligatoire | non |
| Type | Array<String> |
| Valeur par défaut | [] |
| Disponible depuis la version | 0.0.23 |
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.
# appsignal.conf
filter_session_data = ["secret_token_one", "secret_token_two"]
host_role
| Champ | Valeur |
|---|
| Clé du fichier de configuration | host_role |
| Clé de la variable d’environnement système | APPSIGNAL_HOST_ROLE |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | nil (non définie par défaut) |
| Disponible depuis la version | 0.0.28 |
Description
Groupez 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 le rôle principal du serveur, par exemple « webserver », « processor », « api », « database », « loadbalancer », etc.
hostname
| Champ | Valeur |
|---|
| Clé du fichier de configuration | hostname |
| Clé de la variable d’environnement système | APPSIGNAL_HOSTNAME |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | détectée depuis le système |
Description
Cela 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 peu 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 la variable d’environnement système | APPSIGNAL_HTTP_PROXY |
| Obligatoire | 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 la variable d’environnement système | APPSIGNAL_IGNORE_ACTIONS |
| Obligatoire | non |
| Type | Array<String> |
| Valeur par défaut | [] |
| Disponible depuis la version | 0.0.26 |
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 points de terminaison de contrôle de santé ou d’autres actions que vous ne souhaitez pas surveiller.
Pour en savoir plus sur l’ignorement des actions.
ignore_errors
| Champ | Valeur |
|---|
| Clé du fichier de configuration | ignore_errors |
| Clé de la variable d’environnement système | APPSIGNAL_IGNORE_ERRORS |
| Obligatoire | non |
| Type | Array<String> |
| Valeur par défaut | [] |
| Disponible depuis la version | 0.0.26 |
Description
Liste des classes d’erreur qui seront ignorées. Toute exception levée avec cette classe d’erreur ne sera pas transmise à AppSignal.
Pour en savoir plus sur l’ignorement des erreurs.
ignore_namespaces
| Champ | Valeur |
|---|
| Clé du fichier de configuration | ignore_namespaces |
| Clé de la variable d’environnement système | APPSIGNAL_IGNORE_NAMESPACES |
| Obligatoire | non |
| Type | Array<String> |
| Valeur par défaut | [] |
| Disponible depuis la version | 0.0.26 |
Description
Liste des espaces de noms qui seront ignorés. Toute erreur levée ou requête lente qui se produit dans cet espace de noms ne sera pas envoyée à AppSignal.
Pour en savoir plus sur les espaces de noms.
log_level
| Champ | Valeur |
|---|
| Clé du fichier de configuration | log_level |
| Clé de la variable d’environnement système | APPSIGNAL_LOG_LEVEL |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | info |
Description
Définit le niveau de gravité du journaliseur 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.
Le définir sur les niveaux « 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 des E/S, en particulier sur les sites à fort trafic. La surcharge CPU est minimale lorsque l’option de débogage est activée.
Valeurs acceptées :
- error
- warning
- info
- debug
- trace
nginx_port
| Champ | Valeur |
|---|
| Clé du fichier de configuration | nginx_port |
| Clé de la variable d’environnement système | APPSIGNAL_NGINX_PORT |
| Obligatoire | non |
| Type | Integer |
| Valeur par défaut | 27649 |
| Disponible depuis la version | 0.36.6 |
Description
Configurez le port sur lequel le serveur de métriques NGINX est exposé.
Lorsque 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 par AppSignal sur le même serveur avec les métriques NGINX activées, utilisez cette option pour configurer chaque application de manière à écouter sur un port différent.
opentelemetry_port
| Champ | Valeur |
|---|
| Clé du fichier de configuration | opentelemetry_port |
| Clé de la variable d’environnement système | APPSIGNAL_OPENTELEMETRY_PORT |
| Obligatoire | non |
| Type | Integer |
| Valeur par défaut | 8099 |
| Disponible depuis la version | 0.0.28 |
Description
Définissez cette option pour configurer le port du serveur HTTP OpenTelemetry du processus d’agent AppSignal. Configurez ce port si un autre processus est déjà en cours d’exécution sur la machine et utilise également ce port, afin d’éviter les conflits.
push_api_endpoint
| Champ | Valeur |
|---|
| Clé du fichier de configuration | push_api_endpoint |
| Clé de la variable d’environnement système | APPSIGNAL_PUSH_API_ENDPOINT |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | https://push.appsignal.com |
Description
Configurez le point de terminaison pour envoyer des données à AppSignal. Ce paramètre n’aura pas à être modifié.
running_in_container
| Champ | Valeur |
|---|
| Clé du fichier de configuration | running_in_container |
| Clé de la 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 |
| Disponible depuis la version | 0.0.27 |
Description
AppSignal s’attend à être exécuté sur la même machine entre les 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, aucune configuration manuelle n’est donc nécessaire. Si vous rencontrez des problèmes avec la détection automatique, veuillez contacter le support.
Cette option est automatiquement définie sur true sur Heroku.
| Champ | Valeur |
|---|
| Clé du fichier de configuration | send_environment_metadata |
| Clé de la variable d’environnement système | APPSIGNAL_SEND_ENVIRONMENT_METADATA |
| Obligatoire | non |
| Type | Booléen (true / false) |
| Valeur par défaut | true |
Description
Envoie des métadonnées d’environnement concernant l’application.
Pour plus d’informations, veuillez consulter la documentation sur les métadonnées d’environnement.
send_params
| Champ | Valeur |
|---|
| Clé du fichier de configuration | send_params |
| Clé de la variable d’environnement système | APPSIGNAL_SEND_PARAMS |
| Obligatoire | non |
| Type | Booléen (true / false) |
| Valeur par défaut | true |
| Disponible depuis la version | 0.0.24 |
Description
Indique s’il faut ignorer l’envoi des paramètres de requête à AppSignal.
Pour plus d’informations, veuillez consulter la documentation sur 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 la 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 | 0.0.24 |
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 la documentation sur le filtrage des données de session de requête.
statsd_port
| Champ | Valeur |
|---|
| Clé du fichier de configuration | statsd_port |
| Clé de la variable d’environnement système | APPSIGNAL_STATSD_PORT |
| Obligatoire | non |
| Type | Integer |
| Valeur par défaut | 8125 |
| Disponible depuis la version | 0.0.28 |
Description
Définissez cette option pour configurer le port du serveur HTTP StatsD du processus d’agent AppSignal. Configurez ce port si un autre processus est déjà en cours d’exécution sur la machine et utilise également ce port, afin d’éviter les conflits.
working_dir_path
| Champ | Valeur |
|---|
| Clé du fichier de configuration | working_dir_path |
| Clé de la variable d’environnement système | APPSIGNAL_WORKING_DIRECTORY_PATH |
| Obligatoire | non |
| Type | String |
| Valeur par défaut | /var/lib/appsignal-agent |
Description
Remplace l’emplacement où l’agent autonome AppSignal peut stocker des fichiers temporaires. Utilisez cette option si l’emplacement par défaut ne convient pas. Consultez notre page comment AppSignal fonctionne pour plus d’informations sur le rôle de ce répertoire de travail.
Remarque : Le chemin spécifié ne peut pas contenir d’abstractions du système de fichiers
spécifiques au système d’exploitation, telles que le symbole du répertoire personnel ~ pour les systèmes *NIX. Cela sera
considéré comme un chemin mal formé.
