Saltar al contenido
Telemetry
guía de integración

Redis y nodo-redis Telemetry

Mida los resultados de los comandos de Redis, la latencia, el comportamiento de la caché, las reconexiones y las categorías de errores delimitadas junto con node-redis.

Revisado por el equipo de producto Telemetry en . Contrato de instrumentación, límites de privacidad y guía de implementación. Revisar los estándares y la propiedad

Obtén una clave APIVer fragmento
Útil para
  • Fiabilidad de la caché de Redis
  • Monitoreo de latencia de comandos
  • Análisis de reconexión y tiempo de espera
Evidencia de implementación

Redis and node-redis Telemetry: del límite a la fila verificada

Utilice Redis and node-redis Telemetry en un límite de aplicación controlado, mantenga el contrato de evento pequeño y verifique un resultado conocido antes de crear vistas agregadas.

  1. 1

    Elige el resultado

    Fiabilidad de la caché de Redis

  2. 2

    Definir el contrato

    operación, cache_name, estado, acierto y fallback_used

  3. 3

    Instrumentar el límite

    Envuelva la operación de la aplicación que necesita medir; no aplique parches al cliente Redis ni emita todos los comandos de forma predeterminada.

  4. 4

    Verificar la evidencia

    Exercise a known fixture, then inspect cache_operation_completed for one correctly typed terminal row.

Antes de empezar

Requisitos previos y límites

  • node-redis y telemetry-sh se inicializan una vez en un proceso Node.js confiable
  • Una taxonomía de operaciones limitada que excluye claves sin formato y argumentos de comando.
  • Políticas separadas para errores de comando, eventos de conexión y errores de entrega de telemetría

Configuración de entrega

Instalar e inicializar el lado del servidor

Importe telemetry-sh en código solo de servidor e inicialícelo una vez con Process.env.TELEMETRY_API_KEY. Mantenga las credenciales de ingesta fuera de los paquetes de navegador, las variables de entorno visibles para el cliente, el control de fuente, los registros y los mensajes de excepción.

Instalación de redis-node

Instalación npm

bash
npm install telemetry-sh
  1. 1Prepare un cliente de entrega del lado del servidor reutilizable con comportamiento de red limitado.
  2. 2Agregue el evento de resultado en el límite de éxito, error, reintento o tiempo de espera.
  3. 3Envíe accesorios controlados e inspeccione las filas almacenadas antes de habilitar una alerta.

Fragmento

Comience con un evento estructurado

Agregue esta forma donde el flujo de trabajo se completa, falla o se vuelve a intentar. Luego cree el panel a partir de campos reales.

redis-node

Evento Redis and node-redis Telemetry

javascript
async function readCachedProject(projectId) {
  const startedAt = performance.now();
  let status = "success";
  let errorType;

  try {
    const value = await redis.get(`project:${projectId}`);
    await telemetry.log("cache_operation_completed", {
      operation: "get_project",
      key_namespace: "project",
      status,
      hit: value !== null,
      latency_ms: Math.round(performance.now() - startedAt),
      release: process.env.APP_RELEASE,
    });
    return value;
  } catch (error) {
    status = "failed";
    errorType = classifyRedisError(error);
    await telemetry.log("cache_operation_completed", {
      operation: "get_project",
      key_namespace: "project",
      status,
      hit: false,
      latency_ms: Math.round(performance.now() - startedAt),
      error_type: errorType,
      release: process.env.APP_RELEASE,
    });
    throw error;
  }
}

Contrato de evento

operación, cache_name, estado, acierto y fallback_used

latency_ms, error_type, reconexión, liberación y entorno

key_namespace solo cuando se trata de una categoría fija en lugar de una clave derivada del cliente

Puntos de control de implementación

Punto de control 1

Envuelva la operación de la aplicación que necesita medir; no aplique parches al cliente Redis ni emita todos los comandos de forma predeterminada.

Punto de control 2

Nunca envíe URL de Redis, credenciales, claves sin formato, valores, argumentos de comando, mensajes de canal o fuentes de Lua.

Punto de control 3

Mantenga el detector de errores de Redis requerido por node-redis, pero limite la velocidad de la telemetría de conexión para que una tormenta de reconexión no pueda crear una segunda sobrecarga.

Verificación

Demuestra que el evento llegó

Ejecute esto después de ejercitar casos conocidos de éxito y fracaso. Reemplace el nombre de la tabla alternativa si su contrato de evento final difiere del fragmento.

Verificación redis-node

Consulta de verificación Redis and node-redis Telemetry

sql
SELECT *
FROM cache_operation_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirme una fila terminal por resultado lógico, con el estado esperado, identificadores, unidades y hora UTC.
Inspeccione el esquema inferido y verifique que los reintentos no cambien los tipos de campos ni generen un nuevo ID de evento lógico.
Busque en los campos almacenados credenciales, cargas útiles sin procesar, mensajes, contenido privado y mensajes de error ilimitados.
Realice un tiempo de espera del proveedor, un rechazo de la ingesta y un cierre del proceso antes de considerar el panel como completo.

Referencias de implementación

Revise el contrato del evento, la guía de seguridad de los datos y la documentación primaria previa antes de habilitar una nueva ruta de producción.

SDK JavaScriptTasa de aciertos de caché SQLEstrategias de muestreoguía del cliente node-redismanejo de errores de nodo-redis

Límite de producción

Mantenga el evento de resultado pequeño y recuperable

Este patrón proporciona

  • Un resultado limitado y listo para SQL junto al flujo de trabajo ascendente.
  • Campos estables para paneles, alertas y correlación entre eventos.
  • Una ruta basada en dispositivos para validar el comportamiento de éxito, fracaso, reintento y tiempo de espera.

Este patrón no proporciona

  • Un exportador de OTLP, un canal de recopilación automática o un reemplazo para seguimientos detallados y registros de diagnóstico.
  • Entrega exactamente una vez simplemente porque la carga útil contiene un ID de evento.
  • Permiso para recopilar cargas útiles sin procesar del proveedor, contenido de usuario, credenciales o datos regulados.
Entrega e idempotenciaProcesamiento por lotes y apagadoSolucionar problemas de ingestión

Puntos de partida del esquema de eventos

Contratos de eventos para este flujo de trabajo

Revise el detalle de la fila, el límite de emisión, los tipos requeridos, las clases de privacidad, la carga útil de ejemplo y la lista de verificación de validación antes de adaptar una consulta o fragmento a producción.

Fiabilidad asíncrona11 campos

background_job_completed

Un resultado terminal por trabajo lógico.

inspeccionar contrato

Función relacionada del producto

Continúe este flujo de trabajo en Alertas

Promueva la consulta de confiabilidad revisada a un umbral propio y un flujo de trabajo de respuesta.

Explorar AlertasRevisar la evidencia del cliente

Recetas SQL relacionadas

Responde la siguiente pregunta con SQL

Ejecute la consulta en los campos estructurados de este flujo de trabajo, inspeccione el resultado del ejemplo y convierta una respuesta útil en un panel o alerta.

Explorar todas las recetas
InfraestructuraIntermedio

Encuentre errores de caché y riesgo de estampida

¿Qué patrones de claves de caché combinan una baja tasa de aciertos con trabajo backend simultáneo?

Receta abierta
Fiabilidad de la APIIntermedio

Comparar dependencia p95 Latencia

¿Qué dependencias posteriores tienen la peor latencia de cola y tasa de fallas?

Receta abierta
Eventos estructuradosAvanzado

Detecte picos en la tasa de errores con una línea de base móvil

¿Qué segmentos de tasa de error por hora están muy por encima de su línea de base reciente?

Receta abierta
InfraestructuraAvanzado

Calcular el tiempo de detección y recuperación de incidentes

¿Cuánto tiempo tarda cada servicio en detectar y recuperarse de incidentes?

Receta abierta
Calidad de datosPrincipiante

Medir el volumen Telemetry por nombre de evento

¿Qué contratos de eventos generan el mayor volumen de ingesta?

Receta abierta
colecciones completasFiabilidad de la API SQLCalidad de datos SQLEventos estructurados SQLInfraestructura SQL

Explorar por familia de implementación

Comparar patrones de integración relacionados

Integraciones Node.js y TypeScript TelemetryIntegraciones de trabajos en segundo plano y colas TelemetryIntegraciones de bases de datos y sistemas de datos Telemetry

Plantillas para combinar con esta integración

Monitor de latencia y errores de API

Observe el volumen de solicitudes, los códigos de estado, la latencia de ruta, los puntos finales fallidos y los incidentes de API que afectan al cliente.

Abrir plantilla

Plantilla de plan de seguimiento de eventos

Cree un catálogo de eventos revisable que cubra el grano, la propiedad, los campos, la privacidad, la retención, la validación y las dependencias de SQL posteriores.

Abrir plantilla

Más integraciones

Contexto OpenTelemetry en eventos estructurados

Conecte los eventos comerciales Telemetry a los seguimientos OpenTelemetry existentes registrando identificadores de seguimiento y tramo seguros en los límites del flujo de trabajo.

abrir guia

Flujo de trabajo de acciones GitHub Integración Telemetry

Envíe un resultado de flujo de trabajo de terminal delimitado desde acciones GitHub con ejecución, intento, trabajo, conclusión, duración y contexto de lanzamiento.

abrir guia

Análisis de procesamiento y retraso del consumidor de Kafka

Supervise los resultados del consumidor de Kafka, el retraso de la partición, la latencia del procesamiento, los reintentos y el manejo de mensajes dudosos con eventos estructurados.

abrir guia