Options disponibles
- Options requises
- Options
additionalInstrumentationsbindAddresscaFilePathcpuCountdebugdisableDefaultInstrumentationsdnsServersenableHostMetricsenableMinutelyProbesenableNginxMetricsenableOpentelemetryHttpenableStatsdfilesWorldAccessiblefilterParametersfilterSessionDatahostnamehostRolehttpProxyignoreActionsignoreErrorsignoreLogsignoreNamespacesloglogLevellogPathnginxPortopentelemetry_portrequestHeadersrevisionrunningInContainersendEnvironmentMetadatasendParamssendSessionDatastatsdPortworkingDirectoryPath
active
Description
Configure AppSignal pour qu’il soit actif ou non dans un environnement donné. Utilisé le plus souvent dans la configuration par fichier pour chaque environnement.environment
Description
L’environnement de l’application qui sera signalé à AppSignal.Remarque : Modifier le nom ou l’environnement d’une
application existante créera une nouvelle application sur AppSignal.com.
name
Description
Nom de votre application tel qu’il doit être affiché sur AppSignal.com.Note : Modifier le nom ou l’environnement d’une application
existante créera une nouvelle application sur AppSignal.com.
pushApiKey
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.additionalInstrumentations
Description
Liste d’instrumentations OpenTelemetry supplémentaires à utiliser avec AppSignal, via des bibliothèques tierces ou vos propres intégrations.bindAddress
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 envoyées à cette adresse. Définissez cette option sur0.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 écoute uniquement 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).
caFilePath
Description
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 propres au système d’exploitation, comme le symbole de
répertoire personnel
~ pour les systèmes *NIX. Cela sera considéré comme un
chemin mal formé.cpuCount
Description
La capacité CPU disponible de l’hôte, exprimée en nombre de CPU. Cette valeur est utilisée pour calculer le pourcentage d’utilisation 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 CPU peut être fractionnaire, par exemple0.5.
debug
Description
Active la journalisation de débogage ; cela 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 pendant la collecte de métriques et lors de l’envoi des données aux serveurs d’AppSignal.com. Activer la journalisation de débogage peut avoir un léger impact sur l’utilisation du disque et les I/O, en particulier sur les sites à fort trafic. La surcharge CPU est minimale 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.
disableDefaultInstrumentations
Description
Vous permet de désactiver l’instrumentation automatique des intégrations par défaut :- @appsignal/opentelemetry-instrumentation-bullmq
- @opentelemetry/instrumentation-amqplib
- @opentelemetry/instrumentation-express
- @opentelemetry/instrumentation-fastify
- @opentelemetry/instrumentation-graphql
- @opentelemetry/instrumentation-http
- @opentelemetry/instrumentation-ioredis
- @opentelemetry/instrumentation-knex
- @opentelemetry/instrumentation-koa
- @opentelemetry/instrumentation-mongodb
- @opentelemetry/instrumentation-mongoose
- @opentelemetry/instrumentation-mysql2
- @opentelemetry/instrumentation-mysql
- @opentelemetry/instrumentation-nestjs-core
- @opentelemetry/instrumentation-pg
- @opentelemetry/instrumentation-redis
- @opentelemetry/instrumentation-redis-4
- @opentelemetry/instrumentation-restify
- @opentelemetry/instrumentation-undici
- @prisma/instrumentation
true.
dnsServers
Description
Configurez les serveurs DNS à utiliser par l’agent AppSignal.Shell
- Valeurs acceptables :
8.8.8.8,my.custom.local.server. - Valeurs non acceptables :
foo,my.awesome.custom.local.dns.server.
appsignal.log : A problem occurred while setting DNS servers.
enableHostMetrics
Description
Définissez cette option surfalse 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.
enableMinutelyProbes
Description
Active le système de sondes à la minute.enableNginxMetrics
Description
Définissez surtrue pour activer le serveur de métriques NGINX. Consultez la documentation sur les métriques NGINX pour plus de détails.
Lorsqu’il est activé, l’agent AppSignal écoutera sur 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.
enableOpentelemetryHttp
Description
Définissez cette option surtrue pour activer le serveur HTTP OpenTelemetry.
Lorsqu’il est activé, l’agent AppSignal écoutera sur 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’entre elles.
Cela est requis pour les applications utilisant l’exporteur OpenTelemetry HTTP pour signaler des données à AppSignal.
enableStatsd
Description
Active le serveur StatsD dans l’agent AppSignal. Lorsqu’il est activé, l’agent AppSignal écoutera sur 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.
filesWorldAccessible
Description
Si cette option est définie surtrue, 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).
filterParameters
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.
Pour en savoir plus sur le filtrage des paramètres.
filterSessionData
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.
Pour en savoir plus sur le filtrage des données de session.
hostname
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 non descriptif est généré pour vous sur des services d’hébergement.hostRole
Description
Regroupe les hôtes par rôle et génère des métriques basées sur ce rôle. L’une de ces métriques est le compteurreporting_hosts. Un bon rôle indique quel est le rôle principal du serveur, comme « webserver », « processor », « api », « database », « loadbalancer », etc.
httpProxy
Description
Si vous avez besoin que l’agent se connecte à Internet via un proxy, indiquez l’URL complète du proxy dans cette clé de configuration.ignoreActions
Description
Avec cette option de configuration, vous pouvez spécifier une liste d’actions qui seront ignorées par AppSignal. Tout ce qui s’y passe, y compris les exceptions, ne sera pas transmis à AppSignal. Cela peut être utile pour ignorer les endpoints de vérification d’état (health check) ou d’autres actions que vous ne souhaitez pas surveiller. Pour en savoir plus sur l’ignorance des actions.ignoreErrors
Description
Liste des classes d’erreurs qui seront ignorées. Toute exception levée avec cette classe d’erreur ne sera pas transmise à AppSignal. Pour en savoir plus sur l’ignorance des erreurs.ignoreLogs
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 ; pour en savoir plus, consultez notre guide Ignorer les logs.ignoreNamespaces
Description
Liste des espaces de noms qui seront ignorés. Toute erreur déclenchée ou requête lente survenant dans cet espace de noms ne sera pas envoyée à AppSignal. En savoir plus sur les espaces de noms.log
Description
Cette option configure le logger utilisé par la fonctionnalité de
journalisation interne d’AppSignal et n’affecte pas la fonctionnalité de journalisation.Note : L’agent AppSignal,
qui est utilisé par l’intégration, écrira toujours dans le fichier “appsignal.log”.
file et stdout. Voir également la configuration log_path.
file(par défaut)- Écrit tous les logs AppSignal sur le système de fichiers.
stdout(par défaut sur Heroku)- Affiche les logs AppSignal dans la STDOUT du processus parent plutôt que dans un fichier. Utile avec des solutions d’hébergement telles que les systèmes de conteneurs et Heroku.
logLevel
Description
Cette option définit le niveau de sévérité du logger interne d’AppSignal et
n’affecte pas la fonctionnalité de journalisation.
- error
- warning
- info
- debug
- trace
logPath
Description
Cette option configure l’emplacement du fichier de journalisation interne d’AppSignal
et n’affecte pas la fonctionnalité de journalisation.
Note : 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 de répertoire personnel
Note : 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 de répertoire personnel
~ pour les systèmes *NIX. Cela sera considéré comme
un chemin mal formé.appsignal.log peut
être écrit.
nginxPort
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 afin qu’elle écoute sur un port différent.
opentelemetry_port
Description
Définissez cette option pour configurer le port du serveur HTTP OpenTelemetry du processus de l’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.requestHeaders
Description
L’option de configurationrequestHeaders contient une liste d’en-têtes de requête HTTP qui sont lus et stockés par le package AppSignal Node.js.
Cette option de configuration requestHeaders 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.
Node.js
Node.js
revision
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 étiquettera 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 remplacer les révisions détectées automatiquement sur Heroku, Render ou Kamal en définissant manuellement l’option de configurationrevision sur une valeur personnalisée.
En savoir plus sur les marqueurs de déploiement dans la rubrique des marqueurs de déploiement.
runningInContainer
Description
AppSignal s’attend à fonctionner sur la même machine entre différents déploiements. Définissez cette clé surtrue 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 définie sur true automatiquement sur Heroku.
sendEnvironmentMetadata
Description
Envoie les métadonnées d’environnement concernant l’application. Pour plus d’informations, veuillez consulter les métadonnées d’environnement.sendParams
Description
Indique s’il faut ne pas envoyer les paramètres de requête à AppSignal. Pour plus d’informations, veuillez consulter send_params dans le filtrage des paramètres de requête.sendSessionData
Description
Définissez cette option surfalse pour ne pas envoyer de données de session avec les traces d’exceptions et les échantillons de problèmes de performances.
Pour plus d’informations, veuillez consulter le filtrage des données de session des requêtes.
statsdPort
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 est déjà en cours d’exécution sur la machine et utilise également ce port, afin d’éviter les conflits.workingDirectoryPath
Description
Remplacez l’emplacement où AppSignal pour Node.js 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 le rôle 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.Node.js
Note : 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 de
répertoire personnel
~ pour les systèmes *NIX. Cela sera considéré comme
un chemin mal formé.