Praktik terbaik untuk kasus dukungan Google Cloud Apigee

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Anda sedang melihat dokumentasi Apigee X.
Lihat dokumentasi Apigee Edge.

Memberikan informasi yang mendetail dan diperlukan dalam kasus dukungan akan memudahkan tim Dukungan Google Cloud Apigee merespons Anda dengan cepat dan efisien. Jika kasus dukungan Anda tidak memiliki detail penting, kami perlu meminta informasi lebih lanjut, yang mungkin melibatkan bolak-balik beberapa kali. Proses ini memerlukan waktu lebih lama dan dapat memperlambat penyelesaian masalah. Panduan Praktik Terbaik ini memungkinkan Anda mengetahui informasi yang kami perlukan untuk menyelesaikan kasus dukungan teknis dengan lebih cepat.

Mendeskripsikan masalah

Suatu masalah harus berisi informasi yang menjelaskan detail tentang apa yang terjadi versus apa yang diharapkan terjadi, serta kapan dan bagaimana itu terjadi. Kasus dukungan Apigee yang baik harus berisi informasi utama berikut untuk setiap produk Apigee:

Informasi utama Deskripsi Apigee Edge untuk Cloud Publik Apigee Edge untuk Private Cloud
Produk Produk Apigee tertentu tempat masalah diamati, termasuk informasi versi jika ada.
  • Versi
Detail Masalah Deskripsi masalah yang jelas dan mendetail yang menguraikan masalah, termasuk pesan error lengkap, jika ada.
  • Pesan error
  • Output alat trace
  • Langkah-langkah untuk merekonstruksi masalah
  • Menyelesaikan permintaan/perintah API
  • Pesan error
  • Output alat trace
  • Langkah-langkah untuk merekonstruksi masalah
  • Menyelesaikan permintaan/perintah API
  • Log diagnostik komponen
Waktu Stempel waktu spesifik saat masalah dimulai dan berapa lama masalah tersebut berlangsung.
  • Tanggal, waktu, dan zona waktu terjadinya masalah
  • Durasi masalah
  • Tanggal, waktu, dan zona waktu terjadinya masalah
  • Durasi masalah
Penyiapan Informasi terperinci di mana masalah diamati.
  • Nama organisasi
  • Nama Env
  • Nama proxy API
  • Revisi
  • Topologi jaringan
  • Komponen Fail Edge

Bagian berikut menjelaskan konsep ini secara lebih mendetail.

Produk

Ada berbagai produk Apigee, Apigee Edge di Cloud Publik dan Apigee Edge di Private Cloud, sehingga kami memerlukan informasi spesifik tentang produk tertentu yang mengalami masalah.

Tabel berikut memberikan beberapa contoh yang menunjukkan informasi lengkap di kolom DOs, dan informasi tidak lengkap di kolom DON'Ts:

ANJURAN LARANGAN
Deployment proxy API OAuth2 gagal di organisasi Public Cloud kami ...

Deployment proxy API gagal

(Kami perlu mengetahui produk Apigee yang bermasalah.)

Penginstalan gagal dengan error berikut di Edge Private Cloud versi 4.50.00 kami ...

Penginstalan gagal pada penyiapan Private Cloud kami.

(Informasi versi tidak ada)

Detail Masalah

Berikan informasi akurat tentang masalah yang sedang diamati, termasuk pesan error (jika ada) serta perilaku yang diharapkan dan yang sebenarnya diamati.

Tabel berikut memberikan beberapa contoh yang menunjukkan informasi lengkap di kolom DOs, dan informasi tidak lengkap di kolom DON'Ts:

ANJURAN LARANGAN

Proxy edgemicro baru edgemicro_auth gagal dengan error berikut:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

Proxy edgemicro baru yang dibuat hari ini tidak berfungsi

(Nama proxy tidak diketahui. Tidak jelas apakah proxy menampilkan error atau respons tidak terduga.)

Klien kami mendapatkan error 500 dengan pesan error berikut saat membuat permintaan ke proxy API:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

Klien kami mendapatkan 500 Error saat membuat permintaan ke proxy API.

(Hanya menyampaikan Error 500 tidak memberikan informasi yang memadai bagi kami untuk menyelidiki masalahnya. Kita perlu mengetahui pesan error sebenarnya dan kode error yang diamati.)

Waktu

Waktu adalah informasi yang sangat penting. Penting bagi Support Engineer untuk mengetahui kapan Anda pertama kali melihat masalah ini, berapa lama masalah tersebut berlangsung, dan apakah masalah tersebut masih terjadi.

Support Engineer yang dapat menyelesaikan masalah ini mungkin tidak berada di zona waktu Anda, jadi pernyataan relatif tentang waktu akan membuat masalah lebih sulit untuk didiagnosis. Oleh karena itu, sebaiknya gunakan format ISO 8601 untuk tanggal dan stempel waktu guna memberikan informasi waktu yang tepat tentang kapan masalah itu diamati.

Tabel berikut memberikan beberapa contoh yang menunjukkan waktu dan durasi akurat saat masalah terjadi di kolom DOs, serta informasi yang ambigu atau tidak jelas tentang kapan masalah terjadi di kolom DON'Ts:

ANJURAN LARANGAN
Sejumlah besar 503s diamati kemarin antara 06-11-2020 17.30 PDT dan 06-11-2020 17.35 PDT...

Sejumlah besar 503s diamati kemarin pukul 17.30 selama 5 menit.

(Kami dipaksa menggunakan tanggal tersirat dan juga tidak jelas di zona waktu mana masalah ini diamati.)

Latensi tinggi teramati pada Proxy API berikut dari 09-11-2020 15.30 IST hingga 09-11-2020 18.10 IST ...

Latensi tinggi teramati di beberapa Proxy API minggu lalu.

(Tidak jelas hari dan durasi terjadinya masalah ini selama seminggu terakhir.)

Penyiapan

Kami perlu mengetahui detail lokasi masalah yang Anda lihat. Bergantung pada produk yang Anda gunakan, kami memerlukan informasi berikut:

  • Jika menggunakan Apigee Cloud, Anda mungkin memiliki lebih dari satu organisasi, jadi kami perlu mengetahui organisasi tertentu dan detail lain tempat Anda mengamati masalah tersebut:
    • Nama Organisasi dan Lingkungan
    • Nama proxy dan nomor revisi API (untuk kegagalan permintaan API)
  • Jika menggunakan Private Cloud , Anda mungkin menggunakan salah satu dari banyak topologi penginstalan yang didukung. Jadi, kami perlu mengetahui topologi yang Anda gunakan, termasuk detail seperti jumlah pusat data dan node.

Tabel berikut memberikan beberapa contoh yang menunjukkan informasi lengkap di kolom DOs, dan informasi tidak lengkap di kolom DON'Ts:

ANJURAN LARANGAN

401 Error telah meningkat di Edge Public Cloud sejak 06-11-2020 09.30 CST.

Detail penyiapan Edge:

Detail API yang gagal adalah sebagai berikut:
Nama organisasi: myorg
Nama Env: test
Nama proxy API: myproxy
Nomor revisi: 3

Error:

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

401 Error telah meningkat.

(Tidak memberikan informasi apa pun tentang produk yang digunakan, sejak saat masalah diamati atau detail penyiapan apa pun.)

Tidak dapat memulai Message Processor di Edge Private Cloud versi 4.19.06, setelah menambahkan node gateway tambahan.

Log diagnostik:
Melampirkan log Prosesor Pesan.

Topologi jaringan:
Melampirkan file network-topology.png yang berisi node tambahan.

Tidak dapat memulai Message Processor di Edge Private Cloud versi 4.19.06, setelah menambahkan node gateway tambahan.

(Log Prosesor Pesan dan topologi jaringan hilang.)

Artefak yang berguna

Dengan memberikan artefak yang terkait dengan masalah tersebut, kami akan mempercepat penyelesaian karena membantu kami memahami perilaku sebenarnya yang Anda amati dan mendapatkan lebih banyak insight tentang masalah tersebut.

Bagian ini menjelaskan beberapa artefak berguna yang berguna untuk semua produk Apigee:

Artefak umum untuk semua produk Apigee

Artefak berikut berguna untuk semua produk Apigee: Apigee Edge di Public Cloud dan Apigee Edge di Private Cloud:

Artefak Deskripsi
Output alat perekaman aktivitas Output alat Trace berisi informasi mendetail tentang permintaan API yang mengalir melalui produk Apigee. Hal ini berguna untuk setiap error runtime seperti 4XX, 5XX, dan masalah latensi.
Screenshot Screenshot membantu menyampaikan konteks perilaku atau error yang sebenarnya diamati. Hal ini berguna untuk setiap error atau masalah yang diamati, seperti di UI atau Analytics.
HAR (Http ARchive) HAR adalah file yang direkam oleh alat sesi HTTP untuk men-debug masalah terkait UI. Ini dapat diambil menggunakan browser seperti Chrome, Firefox, atau Internet Explorer.
tcpdumps Alat tcpdump merekam paket TCP/IP yang ditransfer atau diterima melalui jaringan. Hal ini berguna untuk masalah terkait jaringan seperti kegagalan handshake TLS, error 502, dan masalah latensi, dll.

Artefak tambahan untuk Apigee Edge untuk Private Cloud

Untuk Apigee Edge untuk Private Cloud, kami mungkin memerlukan beberapa artefak tambahan yang akan memfasilitasi diagnosis masalah yang lebih cepat.

Artefak Deskripsi
Topologi jaringan Diagram topologi penginstalan Edge yang mendeskripsikan penyiapan Private Cloud Anda termasuk semua pusat data, node, dan komponen yang diinstal di setiap node.
Log diagnostik komponen Edge Log diagnostik yang terkait dengan komponen Apigee Edge tertentu seperti Pemroses Pesan, Router, atau Cassandra.
File Konfigurasi Penginstalan File konfigurasi senyap yang digunakan saat menginstal atau mengupgrade Apigee Edge.

File ini berguna untuk memvalidasi apakah semua setelan sudah benar jika terjadi masalah penginstalan atau migrasi.

Heap dump Heap dump adalah snapshot dari proses memori Java. Hal ini berguna jika pemakaian memori yang tinggi atau error OutOfMemory terlihat pada komponen Edge tertentu.
Thread dump Thread dump adalah snapshot semua thread dari proses Java yang berjalan.

Hal ini berguna jika CPU atau Beban yang tinggi diamati pada komponen Edge tertentu.

Template kasus dan contoh kasus

Bagian ini menyediakan template kasus dan contoh kasus untuk berbagai produk berdasarkan praktik terbaik yang dijelaskan dalam dokumen ini:

Apigee Edge di Cloud Publik

Template

Bagian ini menyediakan template contoh untuk Apigee Edge di Cloud Publik.

Permasalahan:

<Berikan deskripsi mendetail tentang masalah atau perilaku yang Anda amati. Sertakan nama dan versi produk jika berlaku.>

Pesan error:

<Sertakan pesan error lengkap yang diamati (jika ada)>

Waktu mulai masalah (format ISO 8601):

Waktu berakhir masalah (format ISO 8601):

Detail penyiapan Apigee:
Nama organisasi:
Nama Env:
Nama proxy API:
Nomor revisi:

Langkah-langkah untuk mereproduksi:

<Berikan langkah-langkah untuk merekonstruksi masalah jika memungkinkan>

Informasi diagnostik:

<Daftar file yang dilampirkan>

Contoh kasus

Bagian ini menyediakan contoh kasus untuk Apigee Cloud (Apigee di Google Cloud/Apigee Edge di Cloud Publik).

Permasalahan:

Kami melihat banyak sekali error 503 Service Tidak Tersedia di organisasi Public Cloud kami. Bisakah Anda memeriksa masalah tersebut dan menyelesaikannya atau memberi tahu kami cara mengatasinya?

Pesan error:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

Waktu mulai masalah (format ISO 8601): 04-10-2020 06.30 IST

Masalah waktu berakhir (format ISO 8601): Masalah masih terjadi.

Detail penyiapan Cloud Apigee:
Nama organisasi: myorg
Nama Env: dev
Nama proxy API: myproxy
Nomor revisi: 3

Langkah-langkah untuk mereproduksi:

Jalankan perintah curl berikut untuk merekonstruksi masalah:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

Informasi diagnostik:

Output alat perekaman aktivitas (trace-503.xml)

Apigee Edge untuk Private Cloud

Template

Bagian ini menyediakan template contoh untuk Apigee Edge untuk Private Cloud.

Permasalahan:

<Berikan deskripsi mendetail tentang masalah atau perilaku yang Anda amati. Sertakan nama dan versi produk jika berlaku.>

Pesan error:

<Sertakan pesan error lengkap yang diamati (jika ada)>

Waktu mulai masalah (format ISO 8601):

Waktu berakhir masalah (format ISO 8601):

Detail penyiapan Edge Private Cloud:

<Lampirkan topologi jaringan yang menjelaskan penyiapan Private Cloud Anda, termasuk pusat data dan node>

Langkah-langkah untuk mereproduksi:

<Berikan langkah-langkah untuk merekonstruksi masalah jika memungkinkan>

Informasi diagnostik

<Daftar file yang dilampirkan>

Contoh kasus

Bagian ini menyediakan contoh kasus untuk Apigee Edge untuk Private Cloud.

Permasalahan:

Saat menginstal Apigee Management Server di Node #10 sebagai bagian dari Edge Private Cloud 4.19.06 di Linux RHEL 7.6, kami mengalami error berikut.

Pesan Error:

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

Masalah waktu mulai (format ISO 8601): Ini terjadi setiap kali kami menginstal

Waktu berakhir masalah (format ISO 8601): Tidak berlaku

Detail penyiapan Edge Private Cloud:

File network-topology.png dilampirkan

Langkah-langkah untuk mereproduksi:

Berikut ini perintah yang menyebabkan error di atas:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

Informasi diagnostik:

File berikut dilampirkan:

  • output.txt yang berisi output lengkap dari perintah di atas termasuk pesan error
  • Log server manajemen dan
  • File konfigurasi NonProdConfig.txt