DocumentaciónAide

Instrumenter le navigateur

Ajoutez OpenTelemetry à votre site web ou à votre application Angular pour que la trace commence au clic de l'utilisateur et se poursuive jusqu'à votre API et votre base de données.

Sur cette page

Avec le navigateur instrumenté, chaque trace commence au chargement de la page ou au clic de l'utilisateur et se poursuit dans votre API et dans la base de données. Vous voyez ainsi quelle part du temps total est passée dans le réseau, dans le back-end ou dans la requête. Les guides se trouvent dans Paramètres → APM → Clé API et SDK, section SDK par langage et autres façons d'envoyer, onglet Navigateur.

Avant de commencer

  • Un jeton navigateur avec le nom du service et les origines de votre site. Voir Créer un jeton d'ingestion.

  • Un accès au code du site et à la configuration de votre API.

Dans une page web, utilisez uniquement un jeton navigateur. Il est public par conception : il n'envoie que des traces, uniquement depuis les origines indiquées et toujours avec le nom de service fixe. N'y mettez jamais un jeton serveur.

Étapes pour tout site web

  1. Installez les paquets :

npm install @opentelemetry/sdk-trace-web @opentelemetry/exporter-trace-otlp-http @opentelemetry/instrumentation \
  @opentelemetry/instrumentation-document-load @opentelemetry/instrumentation-fetch \
  @opentelemetry/instrumentation-xml-http-request @opentelemetry/resources
  1. Au démarrage de l'application, avant de monter l'interface, enregistrez le fournisseur de traces. L'exportateur pointe vers l'URL d'ingestion terminée par /v1/traces, avec votre jeton navigateur :

const provider = new WebTracerProvider({
  resource: resourceFromAttributes({ 'service.name': 'mi-web', 'deployment.environment.name': 'produccion' }),
  spanProcessors: [new BatchSpanProcessor(new OTLPTraceExporter({
    url: 'https://URL_DE_INGESTA/v1/traces',
    headers: { Authorization: 'Bearer jtk_TU_TOKEN_DE_NAVEGADOR' },
  }))],
});
provider.register();
// Solo a TU API se le agrega el contexto de la traza (traceparent).
const api = [/^https:\/\/api\.midominio\.cl/];
registerInstrumentations({
  instrumentations: [
    new DocumentLoadInstrumentation(),
    new FetchInstrumentation({ propagateTraceHeaderCorsUrls: api }),
    new XMLHttpRequestInstrumentation({ propagateTraceHeaderCorsUrls: api }),
  ],
});

Le guide à l'écran contient le bloc complet, avec les import.

  1. Dans votre API, acceptez les en-têtes de contexte dans CORS :

Access-Control-Allow-Headers: traceparent, tracestate, content-type, authorization
  1. Si votre site a une Content-Security-Policy, autorisez l'URL d'ingestion :

connect-src 'self' https://URL_DE_INGESTA

Remplacez l'expression de api par le domaine de votre API. Seules ces adresses reçoivent le contexte de la trace ; les appels vers des tiers ne le reçoivent pas.

Angular

C'est la même chose que le cas précédent, dans un fichier src/app/telemetry.ts que vous importez dans main.ts avant bootstrapApplication. HttpClient utilise XHR ou fetch (avec withFetch()) et les deux sont instrumentés.

  • Si votre application utilise zone.js, installez aussi @opentelemetry/context-zone et enregistrez avec provider.register({ contextManager: new ZoneContextManager() }).

  • Si elle est zoneless (sans zone.js), provider.register() suffit.

Ce qui se passe ensuite

Le site apparaît dans APM → Services avec le type Navigateur et compte dans l'indicateur Navigateurs. En ouvrant une trace qui a commencé dans le navigateur, vous voyez ses spans et, en dessous, ceux de votre API et de la base de données dans la même cascade.

Voir aussi

Rechercher dans Argunis Monitoring

Saisissez au moins 2 caractères pour rechercher dans Argunis Monitoring.

↑↓ naviguer · Enter ouvrir · Esc fermer