Procedure ottimali per la supportabilità

Questa esercitazione fornisce indicazioni per gli sviluppatori di Fabric Extensibility Toolkit su come supportare i clienti. Vengono illustrate le procedure consigliate per la gestione, il salvataggio e la correlazione di intestazioni di richiesta importanti, nonché raccomandazioni per la registrazione, il monitoraggio e il supporto.

Informazioni generali

Fabric Extensibility Toolkit consente agli sviluppatori di creare carichi di lavoro che si integrano perfettamente con la piattaforma Microsoft Fabric. Questo documento descrive le procedure di supporto che gli sviluppatori devono seguire per garantire una risoluzione dei problemi efficace e il supporto tecnico.

Intestazioni delle richieste

Fabric espone due intestazioni importanti nelle richieste effettuate tra i clienti e Fabric, fondamentali per il supporto:

  • ActivityId: ID univoco globale che può essere usato dall'utente, lo sviluppatore, per correlare la richiesta ai sistemi quando un utente di Fabric interagisce con il carico di lavoro.
  • RequestId: ID univoco globale che consente a Fabric di correlare la richiesta con le tracce della piattaforma, che consente di analizzare i problemi e fornire assistenza. Se non riuscite a determinare il problema da parte vostra usando ActivityId, potete fornire il RequestId al supporto di Fabric quando segnalate un problema. Assicurarsi di mantenere e salvare il RequestId in modo che possa essere facilmente fornito in un secondo momento.

Procedure consigliate per il supporto

Per supportare efficacemente i clienti, è essenziale gestire, salvare e correlare questi ID. Ecco alcune procedure consigliate:

1. Registrazione

  • Conservazione dei log: assicurarsi che i log vengano conservati per un periodo sufficiente per consentire una risoluzione dei problemi efficace.
  • Registrazione dettagliata: includere ActivityId e RequestId in tutte le voci di log pertinenti. In questo modo è possibile tracciare il flusso di una richiesta tramite il sistema.
  • Integrazione di Application Insights: per i carichi di lavoro ospitati in Azure, prendere in considerazione l'integrazione con Azure Application Insights per acquisire automaticamente i dati di telemetria e gli ID di correlazione.

2. Monitoraggio

  • Monitoraggio in tempo reale: implementare il monitoraggio in tempo reale per rilevare e avvisare i problemi man mano che si verificano. Sono inclusi il monitoraggio delle frequenze delle richieste, le percentuali di errore e le prestazioni del sistema.
  • Correlazione con le intestazioni: assicurarsi che gli strumenti di monitoraggio possano correlare log e metriche usando ActivityId e RequestId. In questo modo sarà possibile identificare e diagnosticare rapidamente i problemi.
  • Monitoraggio di Azure: è consigliabile usare Monitoraggio di Azure per funzionalità complete di monitoraggio e avvisi.

3. Supporto

  • <​c0>Assistenza clienti: addestra il tuo team di supporto a richiedere <​c1 /> e <​c2 /> quando si gestiscono i problemi dei clienti. In questo modo verrà accelerato il processo di risoluzione dei problemi.
  • Documentazione: fornire ai clienti una documentazione chiara su come ottenere e usare questi ID quando si segnalano problemi.
  • Processo di escalation: stabilire procedure chiare per l'escalation dei problemi al supporto Fabric usando il RequestId quando è necessaria l'analisi a livello di piattaforma.

Flusso di lavoro di esempio

  1. Voce di log: quando viene ricevuta una richiesta, registrare ActivityId e RequestId insieme ad altre informazioni pertinenti.
  2. Monitoraggio: usare gli strumenti di monitoraggio per tenere traccia della richiesta in tempo reale, correlando con gli ID.
  3. Risoluzione dei problemi: se si verifica un problema, usare ActivityId e RequestId per tracciare la richiesta tramite i log e i sistemi.
  4. Supporto: quando un cliente segnala un problema, chiedere ActivityId e RequestId per individuare rapidamente i log pertinenti e fornire assistenza. Se il problema non può essere determinato da parte tua, fornire alla RequestId supporto di Fabric per ulteriori indagini.

Considerazioni sull'implementazione

Per i carichi di lavoro di Frontend-Only

  • Estrarre le intestazioni di correlazione dal contesto del carico di lavoro del client quando disponibile
  • Trasmettete gli ID di correlazione a qualsiasi chiamata API esterna effettuata dal carico di lavoro.
  • Includere gli ID di correlazione nei log della console del browser per il debug

Per i carichi di lavoro con componenti back-end

  • Propagare le intestazioni di correlazione tramite l'architettura del servizio
  • Implementare la registrazione strutturata che include GLI ID di correlazione
  • Configurare i dashboard di monitoraggio che possono filtrare in base agli ID di correlazione

Integrazione di Azure

  • Application Insights: acquisisce automaticamente la correlazione delle richieste e fornisce dashboard predefiniti
  • Azure Log Analytics: eseguire query sui log usando GLI ID di correlazione per la risoluzione dei problemi
  • Avvisi di Azure: configurare gli avvisi in base ai modelli di errore o alle metriche delle prestazioni

Linee guida per il supporto clienti

Per i clienti

Fornire ai clienti istruzioni chiare su come segnalare i problemi:

  1. ID attività: può spesso essere trovato nei log della console degli strumenti di sviluppo del browser
  2. ID richiesta: può essere visualizzato nei messaggi di errore o disponibile tramite strumenti di supporto
  3. Timestamp: quando si è verificato il problema
  4. Contesto: operazione eseguita quando si è verificato il problema

Per il team di supporto

Formare il team di supporto per:

  1. Raccogliere gli ID di correlazione: richiedere sempre ActivityId e RequestId quando si analizzano i problemi
  2. Usare gli strumenti di diagnostica: sfruttare i sistemi di registrazione e monitoraggio per tenere traccia dei problemi
  3. Eseguire l'escalation quando necessario: sapere quando eseguire l'escalation al supporto di Fabric con il RequestId
  4. Soluzioni documento: creare una knowledge base di problemi comuni e i relativi modelli di correlazione

Conclusione

Seguendo queste procedure consigliate, gli sviluppatori possono supportare efficacemente i clienti nella piattaforma Fabric, garantendo un processo di risoluzione dei problemi facile ed efficiente. La registrazione, il monitoraggio, la gestione delle richieste e i protocolli di supporto appropriati sono essenziali per mantenere una qualità elevata del servizio e la soddisfazione dei clienti.

Per indicazioni più dettagliate sull'implementazione, vedere:

  • Last updated on