Menggunakan kolektor Diagnostik

Saat ini Anda melihat versi 1.7 dokumentasi Hybrid Apigee. Versi ini akan segera berakhir. Anda harus mengupgradenya ke versi yang lebih baru. Untuk informasi selengkapnya, lihat Versi yang didukung.

Version 1.7 (unsupported)

Versi yang didukung:

• v1.13 (terbaru)                        
• v1.12                         
• v1.11                         
• Daftar versi yang didukung

Versi yang tidak didukung:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Pengumpul diagnostik adalah alat yang mengambil data diagnostik pada komponen Kubernetes dari instance hybrid Apigee on demand, dan menyimpannya di bucket Google Cloud Storage. Anda memanggil kolektor Diagnostik dengan perintah apigeectl diagnostic.

Data Sistem apa yang diambil?

Pengumpul diagnostik menangkap jenis data berikut:

• Mengubah level Log.
• Jstack
• yaml konfigurasi POD.
• {i>Output<i} PS -ef.
• dump TCP.
• Output TERATAS.

Apa yang terjadi pada data?

Saat kolektor Diagnostik mengambil data, data akan diupload ke bucket penyimpanan di project Google Cloud Anda. Anda dapat melihat data yang disimpan di Google Cloud Platform: browser Cloud Storage.

Secara opsional, Anda dapat memilih untuk membagikan data ini kepada Dukungan Google Apigee saat membuat tiket dukungan.

Catatan: Tidak ada data runtime pengguna atau informasi sensitif yang diambil dalam data yang dikumpulkan oleh kolektor Diagnostik.

Prasyarat untuk menjalankan kolektor Diagnostik

Sebelum menggunakan kolektor Diagnostik, Anda harus menyelesaikan prasyarat berikut:

Bucket Google Cloud Storage

Membuat bucket Google Cloud Storage dengan nama unik di project Google Cloud Anda. Anda dapat membuat dan mengelola bucket dengan perintah gsutil atau di Google Cloud Platform: browser Cloud Storage.

Contoh:

gsutil mb gs://apigee_diagnostic_data

Creating gs://apigee_diagnostic_data/...

Nama bucket harus unik secara global di semua project Google Cloud, termasuk project di luar organisasi Anda.

Lihat Membuat bucket penyimpanan untuk mengetahui petunjuknya.

Akun layanan

Buat akun layanan dengan peran Storage Admin (roles/storage.admin) di project Anda, dan download file kunci .json akun layanan.

Akun layanan dapat memiliki nama unik apa pun. Panduan ini menggunakan "apigee-diagnostic" untuk nama akun layanan.

Contoh:

gcloud config set project ${PROJECT_ID}

gcloud iam service-accounts create apigee-diagnostic

gcloud projects add-iam-policy-binding ${PROJECT_ID} \
    --member="serviceAccount:apigee-diagnostic@${PROJECT_ID}.iam.gserviceaccount.com" \
    --role="roles/storage.admin"

gcloud iam service-accounts keys create ${PROJECT_ID}-apigee-diagnostic.json \
    --iam-account=apigee-diagnostic@${PROJECT_ID}.iam.gserviceaccount.com

Lihat:

• Membuat dan mengelola akun layanan.
• Membuat dan mengelola kunci akun layanan.
• Memahami peran: Peran Cloud Storage.

Menggunakan kolektor Diagnostik

Urutan untuk menggunakan kolektor Diagnostik adalah:

1. Konfigurasikan stanza Diagnostik di file overrides.yaml untuk memilih jenis informasi, penampung Apigee, dan masing-masing pod yang data diagnostiknya diinginkan. Lihat Mengonfigurasi overrides.yaml untuk kolektor Diagnostik.
2. Jalankan kolektor Diagnostik dengan perintah apigeectl berikut.

   apigeectl diagnostic -f OVERRIDES_FILE

   Dengan OVERRIDES_FILE adalah jalur ke file overrides.yaml Anda.

3. Periksa log:
   1. Dapatkan pod di namespace apigee-diagnostic.

      kubectl get pods -n apigee-diagnostic

   2. Catat pod dengan nama yang berisi diagnostic-collector
   3. Periksa log dengan perintah berikut:

      kubectl -n apigee-diagnostic logs -f POD_NAME

      Dengan POD_NAME adalah nama pod kolektor Diagnostik.

      Anda juga dapat melihat log yang dikumpulkan di Google Cloud Platform: browser Cloud Storage.

4. Setelah Anda mengumpulkan data, hapus pengumpul Diagnostik. Anda tidak dapat menjalankannya lagi hingga Anda menghapusnya.

   apigeectl diagnostic delete -f OVERRIDES_FILE

Mengonfigurasi overrides.yaml untuk kolektor Diagnostik

Sebelum dapat menjalankan kolektor Diagnostik, Anda harus mengonfigurasinya dalam file overrides.yaml.

Untuk referensi lengkap tentang properti konfigurasi diagnostic, lihat Referensi properti konfigurasi: diagnostic.

Properti wajib

Properti berikut diperlukan agar kolektor Diagnostik dapat dijalankan.

• diagnostic.serviceAccountPath: Jalur ke file kunci akun layanan untuk akun layanan dengan peran Storage Admin di Prasyarat.
• diagnostic.operation: Menentukan apakah akan mengumpulkan semua statistik atau hanya log.

  Nilai adalah: "ALL" atau "LOGGING"

  Jika Anda menetapkan diagnostic.operation ke "LOGGING", properti berikut wajib diisi:

  • diagnostic.loggingDetails.logDuration
  • diagnostic.loggingDetails.loggerNames
  • diagnostic.loggingDetails.logLevel
• diagnostic.bucket: Nama bucket Google Cloud Storage tempat data diagnostik Anda akan disimpan. Ini adalah bucket yang Anda buat dalam Prasyarat.
• diagnostic.container: Menentukan jenis pod tempat Anda mengambil data. Nilainya dapat berupa salah satu dari:

  Nilai container	Komponen Apigee	Namespace Kubernetes	Contoh nama pod dalam penampung ini
  apigee-cassandra	Cassandra	apigee	apigee-cassandra-default-0
  istio-proxy	Ingress Istio	istio-system	istio-ingressgateway-696879cdf8-9zzzf
  apigee-mart-server	MART	apigee	apigee-mart-hybrid-example-d89fed1-151-jj2ux-l7nlb
  apigee-runtime	Message Processor	apigee	apigee-runtime-hybrid-example-3b2ebf3-151-s64bh-g9qmv
  apigee-synchronizer	Penyelaras	apigee	apigee-synchronizer-hybrid-example-3b2ebf3-151-xx4z6cg78
  apigee-udca	UDCA	apigee	apigee-udca-hybrid-example-3b2ebf3-151-q4g2c-vnzg9
  apigee-watcher	Pengamat	apigee	apigee-watcher-hybrid-example-d89fed1-151-cpu3s-sxxdf

• diagnostic.namespace: Namespace Kubernetes tempat pod yang datanya Anda kumpulkan berada. Namespace harus benar untuk penampung yang Anda tentukan dengan diagnostic.container.
• diagnostic.podNames: Nama masing-masing pod tempat Anda ingin mengumpulkan data diagnostik. Contoh:

  diagnostic:
   …
   podNames:
   - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
   - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2

Properti hanya diperlukan jika operasi disetel ke LOGGING

Properti berikut hanya diperlukan saat menjalankan kolektor Diagnostik dengan diagnostic.operation adalah LOGGING.

• diagnostic.loggerNames: Menentukan menurut nama logger yang akan dikumpulkan datanya. Untuk Apigee Hybrid versi 1.6.0, satu-satunya nilai yang didukung adalah ALL, yang berarti semua logger. Contoh:

  diagnostic:
   …
   loggingDetails:
     loggerNames:
     - ALL

• diagnostic.logLevel: Menentukan perincian data logging yang akan dikumpulkan. Di Apigee Hybrid 1.6, Hanya FINE yang didukung.
• diagnostic.logDuration: Durasi data log yang dikumpulkan dalam milidetik. Nilai standarnya adalah 30000.

Properti opsional

Properti berikut bersifat opsional.

• diagnostic.tcpDumpDetails.maxMsgs: Menetapkan jumlah maksimum pesan tcpDump yang akan dikumpulkan. Apigee merekomendasikan nilai maksimum tidak lebih besar dari 1000.
• diagnostic.tcpDumpDetails.timeoutInSeconds: Menetapkan jumlah waktu dalam detik untuk menunggu tcpDump menampilkan pesan.
• diagnostic.threadDumpDetails.delayInSeconds: Penundaan dalam detik antara pengumpulan setiap thread dump. Harus digunakan dengan diagnostic.threadDumpDetails.iterations.
• diagnostic.threadDumpDetails.iterations: Jumlah iterasi dump thread jstack yang akan dikumpulkan. Harus digunakan dengan diagnostic.threadDumpDetails.delayInSeconds.

Contoh umum

Berikut adalah contoh stanza diagnostic yang menampilkan semua kemungkinan entri:

diagnostic:
  # required properties:
  serviceAccountPath: "service-accounts/apigee-diagnostics.json"
  operation: "ALL"
  bucket: "diagnostics_data"
  container: "apigee-runtime"
  namespace: "apigee"
  podNames:
  - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
  - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2

  # required if operation is Logging
  loggingDetails:
    loggerNames:
    - ALL
    logLevel: FINE
    logDuration: 30000

  # optional properties:
  tcpDumpDetails:
    maxMsgs: 10
    timeoutInSeconds: 100

  threadDumpDetails:
    iterations: 5
    delayInSeconds: 2

Kasus penggunaan umum

Contoh berikut menunjukkan cara mengonfigurasi dan menggunakan kolektor Diagnostik dalam beberapa situasi umum.

Latensi Proxy Tinggi

Dalam hal ini, Apigee-runtime memerlukan waktu lama untuk memproses permintaan, sehingga pelanggan melihat latensi proxy yang tinggi. Anda perlu mengumpulkan output Jstack dan TOP.

1. Pilih 2 pod runtime mana saja.
2. Buat stanza diagnostic dengan struktur berikut:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "ALL"
     bucket: "diagnostics_data"
     container: "apigee-runtime"
     namespace: "apigee"
     podNames:
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
   
     tcpDumpDetails:
       maxMsgs: 10
   
     threadDumpDetails:
       iterations: 15
       delayInSeconds: 1

3. Setelah mengonfigurasi stanza diagnostic, jalankan kolektor Diagnostik.

   apigeectl diagnostic -f OVERRIDES_FILE

4. Kumpulkan log dan hapus kolektor Diagnostik.

   apigeectl diagnostic delete -f OVERRIDES_FILE

Masalah jaringan / konektivitas

Anda perlu menjalankan diagnostik di apigee-runtime serta pod gateway masuk.

1. Pilih 2 pod runtime mana saja.
2. Buat stanza diagnostic dengan struktur berikut:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "ALL"
     bucket: "diagnostics_data"
     container: "apigee-runtime"
     namespace: "apigee"
     podNames:
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
   
     tcpDumpDetails:
       maxMsgs: 1000

3. Setelah mengonfigurasi stanza diagnostic, jalankan kolektor Diagnostik.

   apigeectl diagnostic -f OVERRIDES_FILE

4. Kumpulkan log dan hapus kolektor Diagnostik.

   apigeectl diagnostic delete -f OVERRIDES_FILE

5. Pilih dua pod dari gateway ingress Istio.
6. Konfigurasi ulang stanza diagnostic Anda dengan pod ingress Istio:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "ALL"
     bucket: "diagnostics_data"
     container: "istio-proxy"
     namespace: "istio-system"
     podNames:
     - istio-ingressgateway-696879cdf8-9zzzf
     - istio-ingressgateway-696879cdf8-6abc7
   
     tcpDumpDetails:
       maxMsgs: 1000

7. Setelah mengonfigurasi stanza diagnostic, jalankan kolektor Diagnostik.

   apigeectl diagnostic -f OVERRIDES_FILE

8. Kumpulkan log dan hapus kolektor Diagnostik.

   apigeectl diagnostic delete -f OVERRIDES_FILE

Proxy menampilkan error tak terduga atau kontrak baru tidak diterapkan

Dalam hal ini, Anda perlu mengubah level log agar melakukan debug selama minimal 5 menit, atau bahkan 10 menit seperti dalam contoh ini. Hal ini akan menambah jumlah log, tetapi informasi yang berguna akan dicatat. Anda akan menjalankan kolektor Diagnostik dua kali, sekali di runtime Apigee, lalu di sinkronisasi Apigee.

1. Pilih 2 pod runtime mana saja.
2. Buat stanza diagnostic dengan struktur berikut:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "LOGGING"
     bucket: "diagnostics_data"
     namespace: "apigee"
     container: "apigee-runtime"
     podNames:
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-2wcjn
     - apigee-runtime-hybrid-example-3b2ebf3-150-8vfoj-6xzn2
   
     loggingDetails:
       loggerNames:
       - ALL
       logLevel: FINE
       logDuration: 60000

3. Setelah mengonfigurasi stanza diagnostic, jalankan kolektor Diagnostik.

   apigeectl diagnostic -f OVERRIDES_FILE

4. Kumpulkan log dan hapus kolektor Diagnostik.

   apigeectl diagnostic delete -f OVERRIDES_FILE

5. Pilih 2 pod sinkronisasi apa pun.
6. Buat stanza diagnostic dengan struktur berikut:

   diagnostic:
     serviceAccountPath: "service-accounts/apigee-diagnostics.json"
     operation: "LOGGING"
     bucket: "diagnostics_data"
     namespace: "apigee"
     container: "apigee-synchronizer"
     podNames:
     - apigee-synchronizer-hybrid-example-3b2ebf3-150-xx4z-6cg78
     - apigee-synchronizer-hybrid-example-3b2ebf3-150-xx4z-1a2b3
   
     loggingDetails:
       loggerNames:
       - ALL
       logLevel: FINE
       logDuration: 60000

7. Setelah mengonfigurasi stanza diagnostic, jalankan kolektor Diagnostik.

   apigeectl diagnostic -f OVERRIDES_FILE

8. Kumpulkan log dan hapus kolektor Diagnostik.

   apigeectl diagnostic delete -f OVERRIDES_FILE