Bagikan melalui

Praktik terbaik kemampuan dukungan

Tutorial ini memberikan panduan untuk pengembang Fabric Extensibility Toolkit tentang cara mendukung pelanggan mereka. Ini mencakup praktik terbaik untuk memelihara, menyimpan, dan menghubungkan header permintaan penting, serta rekomendasi untuk pengelogan, pemantauan, dan dukungan.

Gambaran Umum

Fabric Extensibility Toolkit memungkinkan pengembang untuk membuat beban kerja yang terintegrasi dengan mulus dengan platform Microsoft Fabric. Dokumen ini menguraikan praktik dukungan yang harus diikuti pengembang untuk memastikan pemecahan masalah dan dukungan pelanggan yang efektif.

Minta Header

Fabric mengekspos dua header penting dalam permintaan yang dibuat antara pelanggan dan Fabric, yang sangat penting untuk keberlanjutan dukungan.

  • ActivityId: ID unik global yang dapat digunakan oleh Anda, pengembang, untuk menghubungkan permintaan dengan sistem Anda saat pengguna Fabric berinteraksi dengan beban kerja Anda.
  • RequestId: ID unik global yang membantu Fabric menghubungkan permintaan Anda dengan jejak platform, yang akan membantu menyelidiki masalah dan memberikan bantuan. Jika Anda tidak dapat menentukan masalah di sisi Anda menggunakan ActivityId, Anda dapat memberikan RequestId ke dukungan Fabric saat melaporkan masalah. Pastikan Anda menjaga dan menyimpan RequestId agar dapat diberikan dengan mudah nanti.

Praktik Terbaik untuk Dukungan

Untuk mendukung pelanggan Anda secara efektif, penting untuk mempertahankan, menyimpan, dan menghubungkan ID ini. Berikut beberapa praktik terbaik:

1. Pengelogan

  • Retensi Log: Pastikan bahwa log dipertahankan selama periode yang memadai untuk memungkinkan pemecahan masalah yang efektif.
  • Pengelogan Terperinci: Sertakan ActivityId dan RequestId dalam semua entri log yang relevan. Ini akan membantu Anda melacak alur permintaan melalui sistem Anda.
  • Integrasi Application Insights: Untuk beban kerja yang dihosting Azure, pertimbangkan untuk berintegrasi dengan Azure Application Insights untuk menangkap ID telemetri dan korelasi secara otomatis.

2. Pemantauan

  • Pemantauan real time: Terapkan pemantauan real-time untuk mendeteksi dan memperingatkan masalah saat terjadi. Ini termasuk memantau tingkat permintaan, tingkat kesalahan, dan performa sistem.
  • Korelasi dengan Header: Pastikan alat pemantauan Anda dapat menghubungkan log dan metrik menggunakan ActivityId dan RequestId. Ini akan membantu Anda dengan cepat mengidentifikasi dan mendiagnosis masalah.
  • Azure Monitor: Pertimbangkan untuk menggunakan Azure Monitor untuk kemampuan pemantauan dan pemberitahuan yang komprehensif.

3. Dukungan

  • Dukungan Pelanggan: Latih tim dukungan Anda untuk meminta ActivityId dan RequestId saat berhadapan dengan masalah pelanggan. Ini akan mempercepat proses pemecahan masalah.
  • Dokumentasi: Berikan dokumentasi yang jelas kepada pelanggan Anda tentang cara mendapatkan dan menggunakan ID ini saat melaporkan masalah.
  • Proses Eskalasi: Tetapkan prosedur yang jelas untuk meningkatkan masalah ke dukungan Fabric menggunakan RequestId saat penyelidikan tingkat platform diperlukan.

Contoh Alur Kerja

  1. Entri Log: Saat permintaan diterima, catat ActivityId dan RequestId bersama dengan informasi relevan lainnya.
  2. Monitor: Gunakan alat pemantauan untuk melacak permintaan secara real time, berkorelasi dengan ID.
  3. Pemecahan masalah: Jika masalah muncul, gunakan ActivityId dan RequestId untuk melacak permintaan melalui log dan sistem Anda.
  4. Dukungan: Ketika pelanggan melaporkan masalah, minta ActivityId dan RequestId untuk dengan cepat menemukan log yang relevan dan memberikan bantuan. Jika masalah tidak dapat ditentukan di akhir Anda, berikan RequestId kepada dukungan Fabric untuk penyelidikan lebih lanjut.

Pertimbangan Implementasi

Untuk Beban Kerja Hanya Frontend

  • Mengekstrak header korelasi dari konteks klien beban kerja saat tersedia
  • Teruskan ID korelasi ke panggilan API eksternal yang dilakukan beban kerja Anda
  • Sertakan ID korelasi di log konsol browser untuk pemecahan masalah

Untuk Beban Kerja dengan Komponen Backend

  • Menyebarkan header korelasi melalui arsitektur layanan Anda
  • Menerapkan pengelogan terstruktur yang mencakup ID korelasi
  • Menyiapkan dasbor pemantauan yang dapat memfilter menurut ID korelasi

Integrasi Azure

  • Application Insights: Secara otomatis menangkap korelasi permintaan dan menyediakan dasbor bawaan
  • Azure Log Analytics: Log kueri menggunakan ID korelasi untuk pemecahan masalah
  • Pemberitahuan Azure: Menyiapkan pemberitahuan berdasarkan pola kesalahan atau metrik performa

Pedoman Dukungan Pelanggan

Untuk Pelanggan Anda

Berikan instruksi yang jelas kepada pelanggan tentang cara melaporkan masalah:

  1. ID Aktivitas: Sering ditemukan di log konsol alat pengembang browser
  2. ID Permintaan: Dapat ditampilkan dalam pesan kesalahan atau tersedia melalui alat dukungan
  3. Tanda waktu: Ketika masalah terjadi
  4. Konteks: Operasi apa yang mereka lakukan saat masalah terjadi

Untuk Tim Dukungan Anda

Latih tim dukungan Anda untuk:

  1. Kumpulkan ID Korelasi: Selalu minta ActivityId dan RequestId saat menyelidiki masalah
  2. Gunakan Alat Diagnostik: Manfaatkan sistem pengelogan dan pemantauan Anda untuk melacak masalah
  3. Eskalasikan Ketika Diperlukan: Ketahui kapan harus mengeskalasi ke dukungan Fabric dengan RequestId
  4. Solusi Dokumen: Membangun pangkalan pengetahuan tentang masalah umum dan pola korelasinya

Conclusion

Dengan mengikuti praktik terbaik ini, pengembang dapat secara efektif mendukung pelanggan mereka di platform Fabric, memastikan proses pemecahan masalah yang lancar dan efisien. Pencatatan, pemantauan, manajemen permintaan, dan protokol dukungan yang tepat sangat penting untuk menjaga kualitas layanan yang tinggi dan kepuasan pelanggan.

Untuk panduan implementasi yang lebih rinci, lihat:

  • Last updated on