Nuxt

Monitorización de la capa de servidor de Nuxt y Nitro

El módulo oficial de DockRay para Nuxt integra aplicaciones Nuxt 3 y 4 con la plataforma de monitorización DockRay. Reporta automáticamente errores del lado del servidor, monitoriza el tiempo de procesamiento de las solicitudes y, opcionalmente, puede recopilar errores de Vue y JavaScript del navegador.

Monitorización de errores del lado del servidor

DockRay se integra con el mecanismo de Nitro y reporta errores no controlados del servidor junto con información sobre la ruta correspondiente.

Los eventos reportados pueden incluir, entre otros datos:

el tipo y el contenido del error,
el lugar donde se produjo y el stack trace,
información sobre el entorno y la versión de la aplicación,
el contexto de la solicitud procesada.

De forma predeterminada, las respuestas 5xx se reportan como errores de la aplicación. Los errores 4xx esperados, como 404, no se consideran fallos de la aplicación.

Monitorización del rendimiento

El módulo mide el tiempo de procesamiento de las solicitudes y reporta las transacciones después de enviar la respuesta al usuario. Las transacciones se agrupan según el patrón de la ruta, de modo que los distintos identificadores no generan entradas independientes en el panel.

La frecuencia de recopilación de datos puede controlarse mediante una tasa de muestreo.

Monitorización de errores de Vue y JavaScript

Opcionalmente, se puede activar la recopilación de errores que se producen en el navegador. La integración es compatible tanto con errores estándar de JavaScript como con errores de componentes Vue capturados mediante los hooks de Nuxt.

Los eventos del navegador se envían primero a la propia aplicación Nuxt y, a continuación, se reenvían a DockRay, por lo que la clave privada del proyecto permanece exclusivamente en el servidor.

Nitro, Node y Edge

La integración funciona a través de Nitro y es compatible tanto con entornos Node.js como con despliegues basados en workers, incluidas las soluciones compatibles con Fetch API.

Privacidad y seguridad

Los encabezados sensibles, como Authorization, Cookie, Set-Cookie y X-Api-Key, se eliminan de los datos reportados.

El envío de la dirección IP y del user agent es opcional y puede controlarse desde la configuración del módulo.

Instalación

Instalación del módulo

Instala DockRay mediante npm:

bash

npm install @dockcodes/dock-ray-nuxt

Configuración

Añade el módulo al archivo nuxt.config.ts:

export default defineNuxtConfig({
    modules: ['@dockcodes/dock-ray-nuxt'],

    ray: {
        tracesSampleRate: 0.2,
        browser: {
            enabled: false
        }
    }
});

A continuación, añade las credenciales del proyecto de DockRay a las variables de entorno:

NUXT_RAY_TOKEN=project-token
NUXT_RAY_PRIVATE_KEY=project-private-key

Encontrarás el token del proyecto y la clave privada en el panel de DockRay.

Las credenciales se almacenan en la configuración runtime privada de Nuxt y no deben incluirse en runtimeConfig.public, ya que el contenido de esta sección se envía al código del cliente.

Sin el token y la clave privada configurados, el módulo permanecerá inactivo y no enviará ningún dato.

Errores de JavaScript opcionales

Para activar la monitorización de errores de Vue y JavaScript en el navegador, configura:

ray: {
    browser: {
        enabled: true
    }
}