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 detail dan diperlukan dalam kasus dukungan akan memudahkan Tim Dukungan Google Cloud Apigee untuk merespons Anda dengan cepat dan efisien. Saat tim dukungan Anda tidak memiliki detail penting, kita perlu meminta informasi lebih lanjut, yang mungkin melibatkan bolak-balik beberapa kali. Hal ini memerlukan waktu yang lebih lama dan dapat menyebabkan keterlambatan penyelesaian masalah. Panduan Praktik Terbaik ini memberi tahu Anda informasi yang kami perlukan untuk menyelesaikan masalah teknis kasus dukungan dengan lebih cepat.

Mendeskripsikan masalah

Masalah harus berisi informasi yang menjelaskan detail tentang apa yang terjadi dan apa yang terjadi apa yang diharapkan terjadi, serta kapan dan bagaimana hal 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 yang mengamati masalah, termasuk versi jika perlu.
  • Versi
Detail Masalah Deskripsi masalah yang jelas dan mendetail yang menguraikan masalah, termasuk jika ada.
  • Pesan error
  • Output alat rekaman aktivitas
  • Langkah-langkah untuk merekonstruksi masalah
  • Menyelesaikan permintaan/perintah API
  • Pesan error
  • Output alat rekaman aktivitas
  • Langkah-langkah untuk merekonstruksi masalah
  • Menyelesaikan permintaan/perintah API
  • Log diagnostik komponen
Waktu Stempel waktu spesifik kapan masalah mulai terjadi 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 mendetail tempat masalah diamati.
  • Nama organisasi
  • Nama env
  • Nama proxy API
  • Revisi
  • Topologi jaringan
  • Komponen Edge Gagal

Bagian berikut menjelaskan konsep-konsep ini secara lebih mendetail.

Produk

Terdapat berbagai produk Apigee, yaitu Apigee Edge di Public Cloud dan Apigee Edge di Private Cloud, sehingga kita memerlukan informasi produk tertentu yang mengalami masalah.

Tabel berikut berisi beberapa contoh yang menunjukkan informasi lengkap di kolom TINDAKAN, dan informasi yang tidak lengkap di kolom Kolom LARANGAN:

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 pada Edge Private Cloud versi 4.50.00 ...

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 setiap) dan perilaku yang diharapkan serta aktual yang diamati.

Tabel berikut menyediakan beberapa contoh yang menampilkan informasi lengkap di kolom TINDAKAN, dan informasi tidak lengkap di kolom LARANGAN:

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 {i>proxy<i} menampilkan kesalahan atau respons yang tidak diharapkan.)

Klien kami mendapatkan 500 error 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 Error 500 saat membuat permintaan ke proxy API.

(Hanya menyampaikan 500 Error tidak memberikan informasi yang memadai bagi kami untuk selidiki masalahnya. Kita perlu mengetahui pesan {i>error<i} dan kode {i>error<i} yang sebenarnya yang sedang diamati.)

Waktu

Waktu adalah informasi yang sangat kritis. Penting bagi Teknisi Dukungan untuk mengetahui kapan Anda pertama kali melihat masalah ini, berapa lama masalah itu terjadi, dan apakah masalah tersebut masih terjadi.

Engineer Dukungan yang menyelesaikan masalah ini mungkin tidak menggunakan zona waktu Anda, jadi pernyataan yang bersifat relatif tentang waktu akan membuat masalah itu lebih sulit untuk didiagnosis. Oleh karena itu, sebaiknya gunakan Format ISO 8601 untuk tanggal dan waktu stempel waktu untuk memberikan informasi waktu tepat tentang kapan masalah itu ditemukan.

Tabel berikut menampilkan beberapa contoh yang menunjukkan waktu dan durasi yang akurat saat terjadi di kolom TINDAKAN, dan informasi yang ambigu atau tidak jelas tentang kapan terjadi di kolom LARANGAN:

ANJURAN LARANGAN
Sejumlah besar 503s diamati kemarin antara 06-11-2020 pukul 17.30 PDT dan 2020-11-06 17:35 PDT...

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

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

Latensi tinggi diamati di Proxy API berikut dari 2020-11-09 15:30 IST hingga 09-11-2020 18:10 IST ...

Latensi tinggi diamati di beberapa Proxy API minggu lalu.

(Tidak jelas hari dan durasi mana masalah ini diamati dalam seminggu terakhir.)

Penyiapan

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

  • Jika Anda menggunakan Apigee Cloud, Anda mungkin memiliki lebih dari satu organisasi, jadi kami perlu untuk mengetahui organisasi spesifik dan detail lain tempat Anda mengamati masalah:
    • 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 opsi yang didukung topologi penginstalan. Jadi kami perlu tahu topologi apa yang Anda gunakan, termasuk rincian seperti jumlah pusat data dan {i>node<i}.

Tabel berikut menyediakan beberapa contoh yang menampilkan informasi lengkap di kolom TINDAKAN, dan informasi tidak lengkap di kolom LARANGAN:

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.

(Laporan ini tidak memberikan informasi apa pun tentang produk yang digunakan, karena kapan masalahnya yang diamati atau detail penyiapan apa pun.)

Tidak dapat memulai Pemroses Pesan di Edge Private Cloud versi 4.19.06 setelah dan menambahkan node gateway tambahan.

Log diagnostik:
Log Pemroses Pesan dilampirkan.

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

Tidak dapat memulai Pemroses Pesan di Edge Private Cloud versi 4.19.06 setelah dan menambahkan node gateway tambahan.

(Log Pemroses Pesan dan topologi jaringan tidak ada.)

Artefak berguna

Memberikan artefak yang terkait dengan masalah kepada kami akan mempercepat penyelesaian masalah, karena ini akan membantu kami memahami perilaku sebenarnya yang Anda amati dan mendapatkan lebih banyak wawasan.

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 rekaman aktivitas Output alat Trace berisi informasi mendetail tentang permintaan API yang mengalir Produk Apigee. Hal ini berguna untuk error runtime seperti 4XX, 5XX, dan masalah latensi.
Screenshot Screenshot membantu menyampaikan konteks perilaku sebenarnya atau error yang diamati. Penting 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 proses debug masalah terkait UI. Gambar ini dapat direkam menggunakan browser seperti Chrome, Firefox, atau Internet Explorer.
tcpdumps Alat tcpdump menangkap paket TCP/IP yang ditransfer atau diterima melalui jaringan. Cara ini berguna untuk masalah terkait jaringan seperti kegagalan TLS handshake, 502 error, 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 lebih cepat diagnosis masalah.

Artefak Deskripsi
Topologi jaringan Diagram topologi penginstalan Edge yang menjelaskan penyiapan Private Cloud Anda termasuk semua pusat data, {i>node<i}, dan komponen yang diinstal di setiap {i>node<i}.
Log diagnostik komponen Edge Log diagnostik yang terkait dengan komponen Apigee Edge tertentu seperti Message Processor, 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 membantu jika memori tinggi pemanfaatan atau error OutOfMemory terlihat pada komponen Edge tertentu.
Thread dump Thread dump adalah snapshot dari semua thread dari proses Java yang sedang berjalan.

Hal ini sangat membantu 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 {i>template<i} contoh untuk Apigee Edge di Cloud Publik.

Masalah:

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

Pesan error:

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

Masalah waktu mulai (format ISO 8601):

Masalah waktu berakhir (format ISO 8601):

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

Langkah-langkah untuk mereproduksi bug:

<Berikan langkah-langkah untuk merekonstruksi masalah jika memungkinkan>

Informasi diagnostik:

<Daftar file terlampir>

Contoh kasus

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

Masalah:

Kami melihat tingginya error Layanan Tidak Tersedia 503 di akun Public Cloud kami org. Dapatkah Anda melihat 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): 2020-10-04 06:30 IST

Waktu berakhir masalah (format ISO 8601): Masalah masih terjadi.

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

Langkah-langkah untuk mereproduksi bug:

Jalankan perintah curl berikut untuk mereproduksi masalah:

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

Informasi diagnostik:

Output alat rekaman aktivitas (trace-503.xml)

Apigee Edge untuk Private Cloud

Template

Bagian ini menyediakan {i>template<i} contoh untuk Apigee Edge untuk Private Cloud.

Masalah:

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

Pesan error:

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

Masalah waktu mulai (format ISO 8601):

Masalah waktu berakhir (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 bug:

<Berikan langkah-langkah untuk merekonstruksi masalah jika memungkinkan>

Informasi diagnostik

<Daftar file terlampir>

Contoh kasus

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

Masalah:

Ketika kami menginstal Server Pengelolaan Apigee di Node #10 sebagai bagian dari Edge Private Cloud 4.19.06 di Linux RHEL 7.6, kita menemukan 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): Terjadi setiap kali kami menginstal

Masalah waktu berakhir (format ISO 8601): Tidak berlaku

Detail penyiapan Edge Private Cloud:

Kami telah melampirkan file network-topology.png

Langkah-langkah untuk mereproduksi bug:

Berikut adalah perintah yang menghasilkan error di atas:

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

Informasi diagnostik:

Terlampir file berikut:

  • output.txt berisi output lengkap dari perintah di atas termasuk pesan error
  • Pengelolaan log server dan
  • File konfigurasi NonProdConfig.txt