Node.js

Paquete para Express y Fastify

El paquete oficial de DockRay para Node.js permite integrar aplicaciones Node.js del lado del servidor con la plataforma de monitorización DockRay. Permite reportar excepciones y mensajes, así como monitorizar el tiempo de procesamiento de las solicitudes HTTP.

Monitorización de errores y excepciones

DockRay permite reportar excepciones capturadas y mensajes personalizados directamente al panel de monitorización.

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.

El paquete también puede capturar errores no controlados del proceso de Node.js. Esta función es opcional, ya que afecta a la forma en que la aplicación gestiona los errores críticos.

Express y Fastify

DockRay proporciona integraciones listas para usar con Express y Fastify. Permiten monitorizar automáticamente las transacciones HTTP y reportar los errores que se producen durante el procesamiento de las solicitudes.

Las transacciones se agrupan según el patrón de la ruta, de modo que las solicitudes a la misma ruta se analizan conjuntamente independientemente de los identificadores proporcionados.

Monitorización del rendimiento

El paquete puede medir el tiempo de procesamiento de las solicitudes HTTP y enviar información sobre las transacciones a DockRay. La frecuencia de recopilación de datos puede controlarse mediante una tasa de muestreo.

Las integraciones listas para usar omiten de forma predeterminada rutas como /health y /metrics.

Monitorización de errores de JavaScript en el navegador

DockRay también permite enviar errores de JavaScript del navegador a través de tu propia aplicación Node.js. La clave privada del proyecto permanece en el servidor y no se expone en el código de la página.

Reporte seguro

Los problemas con el servicio de monitorización no provocan excepciones adicionales en la aplicación monitorizada. Los errores de red y los eventos rechazados son gestionados por el cliente de DockRay.

Los encabezados sensibles, como Authorization, Cookie y X-Api-Key, se eliminan de los datos reportados por las integraciones HTTP listas para usar.

Diseñado para aplicaciones del lado del servidor

DockRay está diseñado para aplicaciones que se ejecutan del lado del servidor y requiere Node.js 18 o una versión posterior. El paquete no tiene dependencias adicionales y utiliza la API fetch integrada.

Instalación

Instalación del paquete

Instala DockRay mediante npm:

bash

npm install @dockcodes/dock-ray

El paquete requiere Node.js 18 o una versión posterior.

Configuración

Crea un cliente de DockRay proporcionando el token del proyecto y la clave privada:

import { DockRayClient } from '@dockcodes/dock-ray';

const ray = new DockRayClient({
    token: process.env.RAY_TOKEN,
    privateKey: process.env.RAY_PRIVATE_KEY,
    environment: process.env.NODE_ENV,
    release: process.env.APP_VERSION,
});

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

Si el cliente se crea sin credenciales, permanecerá inactivo y no establecerá ninguna conexión con la plataforma de monitorización.

Al cerrar la aplicación, ejecuta await ray.close() para finalizar las operaciones pendientes y enviar los eventos que estén en cola.