Modificación del fragmento de código para configurar el cliente web de CloudWatch RUM (opcional) - Amazon CloudWatch

Modificación del fragmento de código para configurar el cliente web de CloudWatch RUM (opcional)

Puede modificar el fragmento de código antes de insertarlo en la aplicación, si desea activar o desactivar varias opciones. Para obtener más información, consulte la documentación del cliente web de CloudWatch RUM.

Hay tres opciones de configuración que definitivamente debe tener en cuenta, como se detalla en estas secciones.

Impedir la recopilación de URL de recursos que podrían contener información personal

El cliente web de CloudWatch RUM está configurado de forma predeterminada para registrar las URL de los recursos que se descargan en la aplicación. Estos recursos incluyen archivos HTML, imágenes, archivos CSS, archivos JavaScript, entre otros. En algunas aplicaciones, las URL pueden contener información de identificación personal (PII, por sus siglas en inglés).

Si este es el caso de la aplicación, le recomendamos ampliamente que desactive la recopilación de URL de recursos mediante el uso de recordResourceUrl: false en la configuración de fragmentos de código, antes de insertarlo en la aplicación.

Registro manual de vistas de página

El cliente web registra las vistas de página de forma predeterminada cuando se carga la página por primera vez y cuando se llama a la API del historial del navegador. El ID de página predeterminado es window.location.pathname. Sin embargo, en algunos casos, es posible que desee anular este comportamiento e instrumentar la aplicación para registrar las visitas a las páginas mediante programación. Si lo hace, podrá controlar el ID de la página y cuándo se registrará. Por ejemplo, pensemos en una aplicación web que tenga un URI con un identificador variable, como /entity/123 o /entity/456. De forma predeterminada, CloudWatch RUM genera un evento de vista de página para cada URI con un ID de página distinto que coincida con el nombre de la ruta, pero es posible que desee agruparlos por el mismo ID de página. Para ello, desactive la automatización de las vistas de página del cliente web mediante la configuración de disableAutoPageView y utilice el comando recordPageView para establecer el ID de página deseado. Para obtener más información, consulte Configuraciones específicas de la aplicación en GitHub.

Ejemplo de script incrustado:

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

Ejemplo de módulo de JavaScript:

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

Habilitación del seguimiento integral de X-Ray

Al momento de crear el monitor de aplicaciones, seleccione Trace my service with AWS X-Ray; se habilitará el seguimiento de las solicitudes XMLHttpRequest y fetch hechas durante las sesiones de usuario que el monitor de aplicaciones ofrece como muestra. A continuación, podrá ver los seguimientos de estas solicitudes de HTTP en el panel de CloudWatch RUM y las páginas de detalles de seguimiento y del mapa de seguimiento de X-Ray.

Estos seguimientos del lado del cliente no están conectados a seguimientos posteriores del lado del servidor de forma predeterminada. Para conectar los seguimientos del lado del cliente a los seguimientos del lado del servidor y habilitar el seguimiento de extremo a extremo, establezca la opción addXRayTraceIdHeader como true (verdadero) en el cliente web. Esto ocasiona que el cliente web de CloudWatch RUM agregue un encabezado de seguimiento de X-Ray a las solicitudes HTTP.

En el siguiente bloque de código, observará un ejemplo de adición de seguimientos del lado del cliente. Algunas opciones de configuración se omiten en este ejemplo para su legibilidad.

<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>
aviso

La configuración del cliente web de CloudWatch RUM para agregar un encabezado de seguimiento de X-Ray a las solicitudes HTTP puede ocasionar que el uso compartido de recursos de origen cruzado (CORS) falle o invalide la firma de la solicitud si la solicitud está firmada con SigV4. Para obtener más información, consulte la documentación del cliente web de CloudWatch RUM. Le recomendamos ampliamente que pruebe la aplicación antes de agregar un encabezado de seguimiento de X-Ray del lado del cliente en un entorno de producción.

Para obtener más información, consulte la documentación del cliente web de CloudWatch RUM.