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 mendetail dan yang diperlukan dalam kasus dukungan akan mempermudah tim Dukungan Google Cloud Apigee untuk merespons Anda dengan cepat dan efisien. Jika kasus dukungan Anda tidak memiliki detail penting, kami perlu meminta informasi lebih lanjut, yang mungkin memerlukan komunikasi berulang beberapa kali. Hal ini memerlukan lebih banyak waktu dan dapat menyebabkan penundaan penyelesaian masalah. Panduan Praktik Terbaik ini memberi tahu Anda informasi yang kami perlukan untuk menyelesaikan kasus dukungan teknis Anda dengan lebih cepat.

Menjelaskan masalah

Masalah harus berisi informasi yang menjelaskan detail tentang apa yang terjadi versus apa yang diharapkan akan terjadi, serta kapan dan bagaimana hal itu terjadi. Kasus dukungan Apigee yang baik harus berisi informasi penting berikut untuk setiap produk Apigee:

Informasi utama Deskripsi Apigee Edge untuk Public Cloud Apigee Edge untuk Private Cloud
Produk Produk Apigee tertentu tempat masalah diamati, termasuk informasi versi jika berlaku.
  • Versi
Detail Masalah Deskripsi masalah yang jelas dan mendetail yang menguraikan masalah, termasuk pesan error lengkap, jika ada.
  • Pesan error
  • Output alat pelacakan
  • Langkah-langkah untuk merekonstruksi masalah
  • Menyelesaikan permintaan/perintah API
  • Pesan error
  • Output alat pelacakan
  • 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 tentang tempat masalah diamati.
  • Nama organisasi
  • Nama lingkungan
  • Nama proxy API
  • Revisi
  • Topologi jaringan
  • Komponen Edge gagal

Bagian berikut menjelaskan konsep ini secara lebih mendetail.

Produk

Ada berbagai produk Apigee, Apigee Edge di Cloud Publik dan Apigee Edge di Cloud Pribadi, jadi kami memerlukan informasi spesifik tentang produk mana yang mengalami masalah.

Tabel berikut memberikan beberapa contoh yang menampilkan informasi lengkap di kolom HARUS, dan informasi yang tidak lengkap di kolom JANGAN:

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

Deployment proxy API gagal

(Kami perlu mengetahui produk Apigee tempat Anda melihat masalah tersebut.)

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

Penginstalan gagal pada penyiapan Private Cloud kami.

(Informasi versi tidak ada)

Detail Masalah

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

Tabel berikut memberikan beberapa contoh yang menampilkan informasi lengkap di kolom HARUS, dan informasi yang tidak lengkap di kolom JANGAN:

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 yang 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 Error 500 saat membuat permintaan ke proxy API.

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

Waktu

Waktu adalah informasi yang sangat penting. Engineer Dukungan perlu mengetahui kapan Anda pertama kali melihat masalah ini, berapa lama masalah ini berlangsung, dan apakah masalah ini masih terjadi.

Engineer Dukungan yang menyelesaikan masalah mungkin tidak berada di zona waktu Anda, sehingga pernyataan relatif tentang waktu akan mempersulit diagnosis masalah. Oleh karena itu, sebaiknya gunakan format ISO 8601 untuk stempel tanggal dan waktu guna memberikan informasi waktu yang tepat tentang kapan masalah diamati.

Tabel berikut memberikan beberapa contoh yang menunjukkan waktu dan durasi yang akurat saat masalah terjadi di kolom HARUS, dan informasi yang ambigu atau tidak jelas tentang kapan masalah terjadi di kolom JANGAN:

ANJURAN LARANGAN
Sejumlah besar 503s diamati kemarin antara 2020-11-06 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 yang tersirat dan juga tidak jelas di zona waktu mana masalah ini diamati.)

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

Latensi tinggi diamati di beberapa Proxy API minggu lalu.

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

Penyiapan

Kami perlu mengetahui detail tentang tempat Anda melihat masalah tersebut. 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 lainnya tempat Anda mengamati masalah:
    • Nama Organisasi dan Lingkungan
    • Nama proxy API dan nomor revisi (untuk kegagalan permintaan API)
  • Jika menggunakan Cloud Pribadi, 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 menampilkan informasi lengkap di kolom HARUS, dan informasi yang tidak lengkap di kolom JANGAN:

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 lingkungan: 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, 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 Message Processor.

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 Pemroses Pesan dan topologi jaringan tidak ada.)

Artefak yang berguna

Memberikan artefak yang terkait dengan masalah ini akan mempercepat penyelesaiannya, karena hal ini membantu kami memahami perilaku yang Anda amati secara tepat dan mendapatkan lebih banyak insight tentangnya.

Bagian ini menjelaskan beberapa artefak berguna yang bermanfaat 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 pelacakan Output alat Trace berisi informasi mendetail tentang permintaan API yang mengalir melalui produk Apigee. Hal ini berguna untuk error runtime seperti 4XX, 5XX, dan masalah latensi.
Screenshot Screenshot membantu menyampaikan konteks perilaku atau error sebenarnya yang diamati. Hal ini berguna untuk error atau masalah yang diamati, seperti di UI atau Analytics.
HAR (Http ARchive) HAR adalah file yang diambil oleh alat sesi HTTP untuk men-debug masalah terkait UI. Screenshot 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 menjelaskan penyiapan Cloud Pribadi 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 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 instalasi atau migrasi.

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

Hal ini berguna jika CPU atau Beban 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 memberikan contoh template untuk Apigee Edge di Public Cloud.

Masalah:

<Berikan deskripsi mendetail tentang masalah atau perilaku yang diamati di pihak Anda. Sertakan nama dan versi produk jika ada.>

Pesan error:

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

Waktu mulai masalah (format ISO 8601):

Waktu akhir masalah (format ISO 8601):

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

Langkah-langkah untuk mereproduksi:

<Berikan langkah-langkah untuk merekonstruksi masalah jika memungkinkan>

Informasi diagnostik:

<List of files attached>

Contoh kasus

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

Masalah:

Kami melihat banyak error 503 Layanan Tidak Tersedia di organisasi Cloud Publik kami. Bisakah Anda memeriksa masalah ini dan menyelesaikannya atau memberi tahu kami cara menyelesaikannya?

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 lingkungan: dev
  Nama proxy API: myproxy
  Nomor revisi: 3

Langkah-langkah untuk mereproduksi:

Jalankan perintah curl berikut untuk mereproduksi masalah:

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

Informasi diagnostik:

Output alat pelacakan (trace-503.xml)

Apigee Edge untuk Private Cloud

Template

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

Masalah:

<Berikan deskripsi mendetail tentang masalah atau perilaku yang diamati di pihak Anda. Sertakan nama dan versi produk jika ada.>

Pesan error:

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

Waktu mulai masalah (format ISO 8601):

Waktu akhir masalah (format ISO 8601):

Detail penyiapan Edge Private Cloud:

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

Langkah-langkah untuk mereproduksi:

<Berikan langkah-langkah untuk merekonstruksi masalah jika memungkinkan>

Informasi diagnostik

<List of files attached>

Contoh kasus

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

Masalah:

Saat menginstal Server Pengelolaan Apigee 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

Waktu mulai masalah (format ISO 8601): Ini terjadi setiap kali kita menginstal

Waktu berakhir masalah (format ISO 8601): Tidak berlaku

Detail penyiapan Edge Private Cloud:

Melampirkan file network-topology.png

Langkah-langkah untuk mereproduksi:

Berikut adalah perintah yang menyebabkan error di atas:

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

Informasi diagnostik:

Melampirkan file berikut:

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