Modification de l'extrait de code pour configurer le client Web CloudWatch RUM (facultatif) - Amazon CloudWatch

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Modification de l'extrait de code pour configurer le client Web CloudWatch RUM (facultatif)

Vous pouvez modifier l'extrait de code avant de l'insérer dans votre application, pour activer ou désactiver plusieurs options. Pour plus d'informations, consultez la documentation du client Web CloudWatch RUM.

Il existe quatre options de configuration que vous devez absolument connaître, comme indiqué dans ces sections.

Empêcher la collecte de ressources URLs susceptibles de contenir des informations personnelles

Par défaut, le client Web CloudWatch RUM est configuré pour enregistrer URLs les ressources téléchargées par l'application. Ces ressources incluent des fichiers HTML, des images, des JavaScript fichiers CSS, des fichiers, etc. Certaines applications URLs peuvent contenir des informations personnelles identifiables (PII).

Si tel est le cas pour votre application, nous vous recommandons vivement de désactiver la collecte de ressources recordResourceUrl: false en URLs définissant la configuration de l'extrait de code, avant de l'insérer dans votre application.

Enregistrement manuel des consultations de page

Par défaut, le client web enregistre les consultations de page lorsque la page se charge pour la première fois et lorsque l'API d'historique du navigateur est appelée. L'ID de page par défaut est window.location.pathname. Toutefois, dans certains cas, vous devrez peut-être remplacer ce comportement et utiliser l'application pour qu'elle enregistre les consultations de page par programmation. Cela vous permet de contrôler l'ID de page et le moment où il est enregistré. Prenons l'exemple d'une application Web dotée d'un URI avec un identifiant variable, tel que /entity/123 ou /entity/456. Par défaut, CloudWatch RUM génère un événement d'affichage de page pour chaque URI avec un ID de page distinct correspondant au nom du chemin, mais vous pouvez plutôt les regrouper par le même identifiant de page. Pour ce faire, désactivez l'automatisation de la consultation de page du client Web à l'aide de la configuration disableAutoPageView, puis utilisez la commande recordPageView pour définir l'ID de page souhaité. Pour plus d'informations, consultez la section Configurations spécifiques à l'application sur. GitHub

Exemple de script intégré :

cwr('recordPageView', { pageId: 'entityPageId' });

JavaScript exemple de module :

awsRum.recordPageView({ pageId: 'entityPageId' });

Activation du end-to-end traçage par rayons X

Lorsque vous créez le moniteur d'application, sélectionnez Trace my service with AWS X-Ray (Suivre mon service avec ) pour activer le suivi des demandes XMLHttpRequest et fetch effectuées pendant les sessions utilisateur échantillonnées par le moniteur d'application. Vous pouvez ensuite voir les traces de ces requêtes HTTP dans le tableau de bord CloudWatch RUM, ainsi que sur les pages de détails de X-Ray Trace Map et Trace.

Par défaut, ces suivis côté client ne sont pas connectés à des suivis côté serveur en aval. Pour connecter les traces côté client aux traces côté serveur et activer le end-to-end suivi, définissez l'addXRayTraceIdHeaderoption sur true dans le client Web. Cela oblige le client Web CloudWatch RUM à ajouter un en-tête de trace X-Ray aux requêtes HTTP.

Le bloc de code suivant présente un exemple d'ajout de suivis côté client. Certaines options de configuration sont omises de cet exemple pour des raisons de lisibilité.

<script> (function(n,i,v,r,s,c,u,x,z){...})( 'cwr', '00000000-0000-0000-0000-000000000000', '1.0.0', 'us-west-2', 'https://client.rum.us-east-1.amazonaws.com/1.0.2/cwr.js', { enableXRay: true, telemetries: [ 'errors', 'performance', [ 'http', { addXRayTraceIdHeader: true } ] ] } ); </script>
Avertissement

La configuration du client Web CloudWatch RUM pour ajouter un en-tête de trace X-Ray aux requêtes HTTP peut entraîner l'échec du partage de ressources entre origines (CORS) ou l'invalidation de la signature de la demande si celle-ci est signée avec SigV4. Pour plus d'informations, consultez la documentation du client Web CloudWatch RUM. Nous vous recommandons fortement de tester votre application avant d'ajouter un en-tête de suivi X-Ray côté client dans un environnement de production.

Pour plus d'informations, consultez la documentation du client Web CloudWatch RUM

Envoi de demandes non signées à RUM CloudWatch

Par défaut, le client Web RUM signe toutes les demandes envoyées à RUM. Si vous définissez signing:false la configuration du client, les demandes ne seront pas signées lorsqu'elles seront envoyées à CloudWatch RUM. Les données ne seront ingérées dans RUM que si une politique basée sur les ressources publiques est attachée au moniteur de l'application. Pour de plus amples informations, veuillez consulter Utilisation de politiques basées sur les ressources avec RUM CloudWatch .