Passer au contenu principal
Veuillez d’abord suivre le guide d’installation lorsque vous ajoutez une nouvelle application à AppSignal.

Création d’une clé API Push

Avant de commencer, vous devez trouver votre clé API Push dans la section « Push and deploy » de la page des paramètres de votre application. Vous trouverez votre clé API sous « Front-end error monitoring ». Une fois que vous avez votre clé, suivez les instructions de la section Installation pour l’utiliser dans votre application.

Installation

Avec npm ou yarn

Tout d’abord, ajoutez le package @appsignal/javascript à votre package.json. Ensuite, exécutez yarn install/npm install. Vous aurez également besoin d’une clé Front-end error monitoring depuis la section « Push and deploy » de la page des paramètres de votre application. Vous pouvez également ajouter ces packages à votre package.json en ligne de commande :
yarn add @appsignal/javascript
npm install @appsignal/javascript

Avec JSPM.dev

Il n’est pas recommandé d’utiliser le CDN JSPM.dev en production. Pour une configuration prête pour la production sans étape de build, nous recommandons d’utiliser les import maps JSPM.io.
Grâce au CDN JSPM, il est possible d’utiliser l’intégration AppSignal pour JavaScript sans étape de build des assets front-end. Votre application peut importer les packages directement depuis le CDN :
import Appsignal from "https://jspm.dev/@appsignal/javascript";

Avec les import maps JSPM.io

Avec le générateur d’import maps JSPM.io, vous pouvez générer une import map pour les dépendances de votre application. Ajoutez @appsignal/javascript à la liste des dépendances, puis ajoutez l’import map générée et les shims des modules ES au code de votre application.

Avec rails-importmap

Utilisez la commande suivante pour ajouter ces packages aux import maps de votre application Rails :
./bin/importmap pin @appsignal/javascript

Utilisation

Créez un fichier appsignal.js pour requérir et configurer AppSignal. Depuis ce fichier, nous exportons l’instance de l’objet Appsignal que nous utiliserons depuis notre application. Pour plus d’informations sur la configuration, consultez notre section configuration.
// For ES Module via npm/yarn, or with import maps
import Appsignal from "@appsignal/javascript";
// For CommonJS module via npm/yarn
const Appsignal = require("@appsignal/javascript").default;
// With the JSPM.dev CDN
import Appsignal from "https://jspm.dev/@appsignal/javascript";

export const appsignal = new Appsignal({
  key: "YOUR FRONTEND API KEY",
});
Vous pouvez alors importer et utiliser l’objet Appsignal dans votre application :
// Place this at the top
// Import the file created in the previous step
import { appsignal } from "./appsignal";

// Place your app code below this
REMARQUE : Si vous utilisez un CDN devant vos assets, vous devrez apporter deux modifications pour que le rapport d’erreurs puisse envoyer les erreurs à notre point d’accès API. Lisez-en plus sur les modifications requises.Si vous utilisez une Content Security Policy, assurez-vous d’ajouter les bons en-têtes comme décrit ici.

Ajouter des intégrations

Votre application utilise peut-être un framework ou une bibliothèque qu’AppSignal prend en charge. Veuillez consulter la section intégrations pour toute bibliothèque utilisée par votre application et suivez les instructions pour ajouter l’instrumentation pour ces bibliothèques. Ajouter des intégrations à votre application.

Ajouter des plugins

AppSignal propose également des plugins pour les fonctionnalités JavaScript dans le navigateur. Veuillez consulter la section plugins pour toute instrumentation supplémentaire que vous souhaiteriez ajouter à votre application. Ajouter des plugins à votre application.

Rapport d’erreurs personnalisé

Vous n’utilisez pas de framework ou de bibliothèque, mais souhaitez signaler les erreurs JavaScript manuellement ? Utilisez notre API Span pour créer des spans sur lesquels signaler les erreurs, ajouter des tags et davantage de métadonnées. Lisez ensuite notre guide de gestion des erreurs pour savoir comment signaler les erreurs à AppSignal.
📖 Poursuivez avec notre guide d’installation.

Désinstallation

Désinstallez AppSignal de votre application en suivant les étapes ci-dessous. Une fois ces étapes terminées, votre application n’enverra plus de données aux serveurs AppSignal.
  1. Dans le package.json de votre application, supprimez toutes les lignes faisant référence à un package appsignal : "*appsignal/*": "*".
  2. Exécutez npm install ou yarn install pour mettre à jour votre package.lock/yarn.lock avec l’état des packages supprimés.
    • Vous pouvez également exécuter npm uninstall @appsignal/<package name> ou yarn remove @appsignal/<package name> pour désinstaller un package AppSignal.
  3. Supprimez toute configuration AppSignal de votre application.
  4. Validez, déployez et redémarrez votre application.
    • Cela garantira que les serveurs AppSignal ne continueront pas à recevoir des données de votre application.
  5. Enfin, supprimez l’application sur AppSignal.com.
📖 Poursuivez avec notre guide de désinstallation.