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, consultez notre rubrique Configuration.
key
Cette option de configuration est requise pour envoyer des données à AppSignal. Si cette
option de configuration n’est pas définie, AppSignal pour JavaScript fonctionnera en
mode développement et aucune donnée ne sera envoyée à AppSignal.
La clé API de surveillance des erreurs front-end pour votre application. Vous pouvez trouver cette clé API sous « Front-end error monitoring » dans la section « Push & Deploy » des paramètres de votre application.
Ce n’est pas la même que la clé API au niveau de l’organisation ou de l’application, qui est utilisée pour la surveillance dans nos intégrations back-end.
namespace
- Type :
string
- Valeur par défaut :
"frontend"
L’espace de noms par défaut à utiliser pour signaler les erreurs à AppSignal. En savoir plus dans notre guide des espaces de noms.
revision
Définit la révision de l’application pour la version actuellement en cours d’exécution de votre application. Ceci est utilisé pour créer des marqueurs de déploiement et étiqueter toutes les données entrantes comme appartenant à un déploiement spécifique. En savoir plus dans notre guide des marqueurs de déploiement.
ignoreErrors
Un tableau d’expressions régulières à vérifier par rapport à la propriété message de toute erreur signalée à AppSignal. Si l’une des expressions régulières correspond, l’erreur est ignorée. En savoir plus dans notre guide pour ignorer les erreurs.
matchBacktracePaths
Cette option de configuration est utile lors du développement d’applications pour des environnements
de bureau et mobiles, ou lors du déploiement du même environnement applicatif sur plusieurs domaines.
La plupart des applications n’auront pas besoin d’utiliser cette option de configuration.L’utilisation de cette option de configuration interrompt la détection automatique des
sourcemaps publics. Pour utiliser cette
option de configuration avec une base de code utilisant des sourcemaps, vous devez téléverser des sourcemaps
privés pour votre application.Cette option de configuration est expérimentale et peut changer dans les versions futures.
Un tableau d’expressions régulières avec un ou plusieurs groupes de capture. Ces expressions régulières seront vérifiées par rapport aux chemins des lignes de backtrace des erreurs signalées à AppSignal. Si l’une des expressions régulières correspond avec un ou plusieurs groupes de capture non vides, le chemin dans la ligne de backtrace est remplacé par le résultat de la concaténation des groupes de capture.
Ceci est utile lorsque le chemin auquel votre application est déployée n’est pas connu à l’avance. Par exemple, le chemin vers une
application Electron peut être différent sur la machine de chaque utilisateur. Vous pouvez faire correspondre la partie de ce chemin qui est connue pour représenter
votre application.
Par exemple, si le code source de votre application se trouve à un chemin comme celui-ci, où ${USERNAME} change pour chaque utilisateur :
/Users/${USERNAME}/Applications/MyApp.app/Contents/Resources/bundle/app.js`
Vous pouvez alors utiliser cette option de configuration comme suit :
const appsignal = new Appsignal({
// ... other configuration options ...
matchBacktracePaths: [new RegExp("MyApp.app/Contents/Resources/(.*)")],
});
Lorsqu’une erreur est signalée, les chemins des lignes de backtrace seront remplacés par le résultat du groupe de capture, qui dans cet exemple sera bundle/app.js.
Cela garantit que les erreurs signalées à AppSignal sont regroupées correctement lors de l’utilisation du regroupement par ligne de backtrace, et permet le téléversement de sourcemaps privés pour le chemin nettoyé.