Procedimientos recomendados de compatibilidad

En este tutorial se proporcionan instrucciones para desarrolladores de Fabric Extensibility Toolkit sobre cómo brindar apoyo a sus clientes. Trata los procedimientos recomendados para mantener, guardar y correlacionar encabezados de solicitud importantes, así como recomendaciones para el registro, la supervisión y el soporte técnico.

Información general

El Kit de herramientas de extensibilidad de Fabric permite a los desarrolladores crear cargas de trabajo que se integren sin problemas con la plataforma de Microsoft Fabric. En este documento se describen las prácticas de compatibilidad que deben seguir los desarrolladores para garantizar una solución de problemas eficaz y el soporte técnico al cliente.

Cabeceras de peticiones

Fabric expone dos encabezados importantes en las solicitudes realizadas entre los clientes y Fabric, que son cruciales para la compatibilidad:

  • ActivityId: un identificador único global que puede usar usted, el desarrollador, para correlacionar la solicitud con los sistemas cuando un usuario de Fabric interactúa con la carga de trabajo.
  • RequestId: un identificador único global que ayuda a Fabric a correlacionar la solicitud con seguimientos de plataforma, lo que ayudará a investigar problemas y proporcionar asistencia. Si no puede determinar el problema por su parte mediante ActivityId, puede proporcionar el RequestId al soporte de Fabric al notificar un problema. Asegúrese de mantener y guardar el RequestId para que se pueda proporcionar fácilmente más adelante.

Procedimientos recomendados para la compatibilidad

Para respaldar eficazmente a los clientes, es esencial mantener, guardar y correlacionar estos identificadores. Estos son algunos procedimientos recomendados:

1. Registro

  • Retención de registros: asegúrese de que los registros se conservan durante un período suficiente para permitir una solución de problemas eficaz.
  • Registro detallado: incluya el ActivityId y el RequestId en todas las entradas de registro pertinentes. Esto le ayudará a realizar un seguimiento del flujo de una solicitud a través del sistema.
  • Integración de Application Insights: en el caso de las cargas de trabajo hospedadas en Azure, considere la posibilidad de integrar con Azure Application Insights para capturar automáticamente los identificadores de telemetría y correlación.

2. Supervisión

  • Supervisión en tiempo real: implemente la supervisión en tiempo real para detectar y alertar sobre los problemas a medida que se producen. Esto incluye la supervisión de las tasas de solicitudes, las tasas de error y el rendimiento del sistema.
  • Correlación con encabezados: asegúrese de que las herramientas de supervisión pueden correlacionar registros y métricas mediante los ActivityId y RequestId. Esto le ayudará a identificar y diagnosticar problemas rápidamente.
  • Azure Monitor: considere la posibilidad de usar Azure Monitor para obtener funcionalidades completas de supervisión y alertas.

3. Soporte técnico

  • Soporte técnico al cliente: Entrene a su equipo de soporte para pedir el ActivityId y el RequestId cuando se trate con problemas de los clientes. Esto acelerará el proceso de solución de problemas.
  • Documentación: proporcione documentación clara a los clientes sobre cómo obtener y usar estos identificadores al notificar problemas.
  • Proceso de escalación: establezca procedimientos claros para escalar problemas al soporte de Fabric usando el RequestId cuando se necesite una investigación a nivel de plataforma.

Flujo de trabajo de ejemplo

  1. Entrada de registro: Cuando se recibe una solicitud, registre ActivityId y RequestId junto con otra información relevante.
  2. Supervisión: use herramientas de supervisión para realizar un seguimiento de la solicitud en tiempo real, correlacionando con los identificadores.
  3. Solución de problemas: si surge un problema, use y ActivityIdRequestId para realizar un seguimiento de la solicitud a través de los registros y sistemas.
  4. Soporte técnico: cuando un cliente informa de un problema, pida ActivityId y RequestId para localizar rápidamente los registros pertinentes y proporcionar asistencia. Si no se puede determinar el problema en su entorno, proporcione la RequestId al soporte de Fabric para una investigación más detallada.

Consideraciones sobre la implementación

Para cargas de trabajo de Frontend-Only

  • Extraiga los encabezados de correlación del contexto del cliente de la carga de trabajo cuando estén disponibles
  • Pase identificadores de correlación a cualquier llamada API externa que realicen sus procesos
  • Incluir identificadores de correlación en los registros de consola del navegador para la depuración de errores

Para cargas de trabajo con componentes de backend

  • Propagación de encabezados de correlación a través de la arquitectura de servicio
  • Implementación del registro estructurado que incluye identificadores de correlación
  • Configuración de paneles de supervisión que pueden filtrar por identificadores de correlación

Integración de Azure

  • Application Insights: captura automáticamente la correlación de solicitudes y proporciona paneles integrados
  • Azure Log Analytics: consulta de registros mediante identificadores de correlación para solucionar problemas
  • Alertas de Azure: configuración de alertas basadas en patrones de error o métricas de rendimiento

Directrices de soporte al cliente

Para sus clientes

Proporcione a los clientes instrucciones claras sobre cómo notificar problemas:

  1. Id. de actividad: a menudo se puede encontrar en los registros de consola de las herramientas de desarrollo del explorador.
  2. Id. de solicitud: puede mostrarse en mensajes de error o disponibles a través de herramientas de soporte técnico
  3. Marca de tiempo: cuando se produjo el problema
  4. Contexto: la operación que estaban realizando cuando se produjo el problema

Para el equipo de soporte técnico

Entrenar al equipo de soporte técnico para:

  1. Recopilar identificadores de correlación: Siempre pida ActivityId y RequestId al investigar problemas.
  2. Usar herramientas de diagnóstico: aproveche los sistemas de registro y supervisión para realizar un seguimiento de los problemas
  3. Escalar cuando sea necesario: saber cuándo escalar al soporte de Fabric con RequestId
  4. Soluciones de documentos: crear una base de conocimiento de problemas comunes y sus patrones de correlación

Conclusión

Siguiendo estos procedimientos recomendados, los desarrolladores pueden apoyar eficazmente a sus clientes en la plataforma Fabric, garantizando un proceso de solución de problemas fluido y eficaz. Los protocolos de registro, supervisión, administración de solicitudes y soporte técnico adecuados son esenciales para mantener la alta calidad del servicio y la satisfacción del cliente.

Para obtener instrucciones de implementación más detalladas, consulte:

  • Last updated on