Le collector peut être configuré au démarrage à l’aide de variables d’environnement ou d’un fichier de configuration.
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’AppSignal Collector via un fichier de configuration ou des variables d’environnement, consultez notre section configuration.
Options disponibles
push_api_key
| Champ | Valeur |
|---|
| Clé du fichier de configuration | push_api_key |
| Clé de variable d’environnement système | APPSIGNAL_PUSH_API_KEY |
| Requis | oui |
| Type | String |
| Valeur par défaut | nil (non définie 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 d’AppSignal.
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 | 0.3.0 |
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.
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 | false |
| Disponible depuis la version | 0.3.0 |
| 0.8.0 : Désactivé par défaut.0.3.0 : Désactivé par défaut dans l’image Docker appsignal/collector.
|
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.
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 | 0.1.0 |
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).
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.3.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_port
| Champ | Valeur |
|---|
| Clé du fichier de configuration | http_port |
| Clé de variable d’environnement système | APPSIGNAL_HTTP_PORT |
| Requis | non |
| Type | Integer |
| Valeur par défaut | 8099 |
| Disponible depuis la version | 0.3.0 |
Description
Le port utilisé par le serveur HTTP du collecteur pour recevoir les requêtes d’exportation OpenTelemetry.
log_level
| Champ | Valeur |
|---|
| Clé du fichier de configuration | log_level |
| Clé de variable d’environnement système | APPSIGNAL_LOG_LEVEL |
| Requis | non |
| Type | String |
| Valeur par défaut | info |
| Disponible depuis la version | 0.1.0 |
Description
Définissez le niveau de gravité 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.
Le définir aux 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 les E/S, en particulier sur les sites à fort trafic. La surcharge CPU est minime lorsque l’option de débogage est activée.
Valeurs acceptées :
- error
- warning
- info
- debug
- trace
push_api_endpoint
| Champ | Valeur |
|---|
| Clé du fichier de configuration | push_api_endpoint |
| Clé de variable d’environnement système | APPSIGNAL_PUSH_API_ENDPOINT |
| Requis | non |
| Type | String |
| Valeur par défaut | https://push.appsignal.com |
| Disponible depuis la version | 0.1.0 |
Description
Configurez le point de terminaison pour envoyer les données à AppSignal. Ce paramètre n’aura pas besoin d’être modifié.
running_in_container
| Champ | Valeur |
|---|
| Clé du fichier de configuration | running_in_container |
| Clé de variable d’environnement système | APPSIGNAL_RUNNING_IN_CONTAINER |
| Requis | non |
| Type | Booléen (true / false) |
| Valeur par défaut | détecté par le collecteur |
| Disponible depuis la version | 0.3.0 |
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 l’environnement conteneurisé, 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.
working_directory_path
| Champ | Valeur |
|---|
| Clé du fichier de configuration | working_directory_path |
| Clé de variable d’environnement système | APPSIGNAL_WORKING_DIRECTORY_PATH |
| Requis | non |
| Type | String |
| Valeur par défaut | détecté par le collecteur |
| Disponible depuis la version | 0.1.0 |
| - Cette option de configuration s’appelait
working_dir_path dans les versions 0.1.0 à 0.3.x.
|
Description
Remplacez l’emplacement où le collecteur AppSignal peut stocker les 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 le but 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 des répertoires de travail différents pour chaque instance AppSignal, sinon les deux instances pourraient entrer en conflit. Pour plus d’informations sur ce scénario, consultez notre documentation sur l’exécution de plusieurs applications sur un même hôte.
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é.