Saltar al contenido
Telemetry
guía de integración

Operación MongoDB Telemetry

Realice un seguimiento de las operaciones de MongoDB con nombre, la latencia, los recuentos de resultados, los reintentos, los resultados de las transacciones y las regresiones de lanzamiento sin recopilar documentos ni valores de consulta.

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

Útil para
  • Análisis de operación lenta
  • Fiabilidad de las transacciones de MongoDB
  • Monitoreo de regresión de lanzamiento
Evidencia de implementación

MongoDB Operation Telemetry: del límite a la fila verificada

Utilice MongoDB Operation 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

    Análisis de operación lenta

  2. 2

    Definir el contrato

    database_system, operación, collection_name, query_fingerprint y liberación

  3. 3

    Instrumentar el límite

    Asigne un nombre a la operación de la aplicación por separado del comando de la base de datos para que los paneles permanezcan estables a medida que cambian las implementaciones de consultas.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • El controlador MongoDB Node.js y telemetry-sh se inicializaron en el lado del servidor
  • Una taxonomía de operaciones limitada que no incluye documentos de recopilación ni valores de filtro.
  • Una distinción revisada entre el momento de la aplicación y el diagnóstico del perfilador de bases de datos

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 mongodb

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.

mongodb

Evento MongoDB Operation Telemetry

javascript
await telemetry.log("mongodb_operation_completed", {
  database_system: "mongodb",
  operation: "workspace_activity.aggregate",
  collection_name: "workspace_activity",
  query_fingerprint: "workspace_activity_summary_v3",
  status: "success",
  duration_ms: Math.round(performance.now() - startedAt),
  result_count: results.length,
  retry_count: 0,
  transaction_status: "not_started",
  read_preference: "primaryPreferred",
  route_template: "/api/workspaces/:workspaceId/activity",
  release: process.env.APP_RELEASE,
});

Contrato de evento

database_system, operación, collection_name, query_fingerprint y liberación

estado, duration_ms, result_count, retry_count y transaction_status

read_preference, write_concern_category, route_template y error_type

Puntos de control de implementación

Punto de control 1

Asigne un nombre a la operación de la aplicación por separado del comando de la base de datos para que los paneles permanezcan estables a medida que cambian las implementaciones de consultas.

Punto de control 2

Mantenga los filtros, los documentos de actualización, los canales de agregación, los documentos devueltos, las cadenas de conexión y los errores de controladores sin restricciones fuera de los eventos.

Punto de control 3

Utilice el generador de perfiles de base de datos MongoDB de forma selectiva para diagnósticos de consultas nativas; sus datos capturados pueden incluir detalles confidenciales de consultas y necesitan su propia revisión de acceso y retención.

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 mongodb

Consulta de verificación MongoDB Operation Telemetry

sql
SELECT *
FROM mongodb_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.

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.

Puntos de partida del esquema de eventos

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.

Función relacionada del producto

Continúe este flujo de trabajo en Consulta SQL API

Ejecute DataFusion SQL de solo lectura sobre tablas de eventos estructurados y reutilice el resultado.

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

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones