Membuat file dump diagnosis AlloyDB Omni

Pilih versi dokumentasi:

Buat dump debug AlloyDB Omni dengan status sistem dan log diagnostik untuk memecahkan masalah yang tidak terduga dalam deployment Anda. Log debug memberikan informasi diagnostik penting tentang status AlloyDB Omni, yang membantu Anda atau tim Cloud Customer Care menganalisis masalah terkait kegagalan atau masalah saat menjalankan berbagai layanan stack AlloyDB Omni. Kumpulkan file ini menggunakan peran Ansible atau alat mandiri.

Kontrol log diagnostik tingkat orchestrator untuk alloydbctl dan Ansible guna menyesuaikan panjang respons untuk pemecahan masalah atau untuk menonaktifkan output untuk skrip otomatis. Log ini penting untuk mendiagnosis masalah selama bootstrap, pengelolaan, atau operasi umum cluster.

Mengumpulkan dan membuang informasi proses debug

Anda dapat mengumpulkan dan membuang informasi debug menggunakan peran Ansible atau alat dump debug.

Mengumpulkan informasi proses debug menggunakan Ansible

Peran Ansible google.alloydbomni_orchestrator.dump_debug mengotomatiskan proses pengumpulan di semua node AlloyDB Omni yang ditentukan dalam spesifikasi deployment Anda. Alat ini mengumpulkan dan menggabungkan informasi berikut:

  • Status systemd: status saat ini dari semua layanan AlloyDB Omni.
  • Log jurnal: log sistem, yang memungkinkan pemfilteran berbasis waktu.

Membuat dump informasi proses debug

  1. Buat playbook Ansible (misalnya, dump_debug.yml) di node kontrol Anda. Tambahkan kode berikut ke playbook:

    - name: Collect AlloyDB Omni Debug Dump
      hosts: all
      become: true
      gather_facts: true
      vars:
        ansible_user: ANSIBLE_USER
        ansible_ssh_private_key_file: PATH_TO_PRIVATE_SSH_KEY
        # Optional: Customize dump behavior
        dump_debug_binary_path: "BINARY_PATH"
        dump_debug_collection_type: "COLLECTION_TYPE"
        dump_debug_local_dest: ""ANSIBLE_DESTINATION""
        dump_debug_tag: ""TAG_NAME""
        dump_debug_journal_spec: "JOURNAL_SPEC"
      roles:
        - role: google.alloydbomni_orchestrator.dump_debug
    

    Ganti kode berikut:

    • ANSIBLE_USER: Pengguna yang digunakan Ansible untuk login.
    • PATH_TO_PRIVATE_SSH_KEY: Jalur ke file kunci pribadi SSH.
    • BINARY_PATH: Opsional. Jalur ke biner di node jarak jauh. Nilai defaultnya adalah /usr/local/bin.
    • COLLECTION_TYPE: Opsional. Jenis koleksi (status, logs, config, atau all). Defaultnya adalah all.
    • ANSIBLE_DESTINATION: Opsional. Tujuan di node kontrol Ansible. Nilai defaultnya adalah /tmp/debug_dump.
    • TAG_NAME: Opsional. ID kustom. Akhiran (misalnya, _1) ditambahkan jika tag ada. Default-nya adalah stempel waktu sistem.
    • JOURNAL_SPEC: Opsional. Mendukung flag journalctl (misalnya, "--since '1 hour ago'"). Default-nya adalah -n 1000.
  2. Jalankan playbook menggunakan perintah ansible-playbook, dengan menentukan deployment_spec.yaml sebagai inventaris.

    # standard execution
    ansible-playbook dump_debug.yml -i PATH_TO_DEPLOYMENT_SPEC

    Atau, jalankan playbook dengan tag kustom dan spesifikasi jurnal pilihan Anda.

    ansible-playbook dump_debug.yml -i PATH_TO_DEPLOYMENT_SPEC \
    -e 'dump_debug_tag=TAG_NAME' \
    -e 'dump_debug_journal_spec: "JOURNAL_SPEC"'

    Ganti kode berikut:

    • PATH_TO_DEPLOYMENT_SPEC: Jalur ke file YAML spesifikasi deployment Anda.
    • TAG_NAME: Opsional. ID kustom. Akhiran (misalnya, _1) ditambahkan jika tag ada. Default-nya adalah stempel waktu sistem.
    • JOURNAL_SPEC: Opsional. Mendukung flag journalctl (misalnya, "--since '1 hour ago'"). Default-nya adalah -n 1000.

Mengumpulkan informasi proses debug menggunakan alat dump debug

Anda dapat menggunakan alat alloydbomni_dump untuk membuat file dump. Alat ini disertakan dalam paket orchestrator AlloyDB Omni.

Membuat file dump

Jalankan skrip berikut di node cluster AlloyDB Omni yang ingin Anda debug.

sudo /usr/local/bin/alloydbomni_dump \
   -k SSH_KEY \
   -u USER \
   -d PATH_TO_DEPLOYMENT_SPEC \
   -o OUTPUT_DIRECTORY \
   [options]

Ganti kode berikut:

  • SSH_KEY: Jalur ke kunci pribadi SSH pengguna.
  • USER: Nama pengguna untuk akses SSH ke node cluster.
  • PATH_TO_DEPLOYMENT_SPEC: Jalur ke file YAML spesifikasi deployment Anda.
  • OUTPUT_DIRECTORY: Direktori lokal untuk menyimpan file dump yang dihasilkan.

Perintah yang didukung

  • -k: Jalur yang diperlukan ke kunci pribadi SSH.
  • -u: Nama pengguna akun layanan yang diperlukan.
  • -d: Jalur yang diperlukan ke file YAML spesifikasi deployment.
  • -o: Direktori output yang diperlukan untuk file tar akhir.
  • -t: ID tag kustom opsional.
  • -c: Jenis koleksi opsional (status, logs, config, all).
  • -s: Spesifikasi ukuran dan waktu jurnal opsional (misalnya, -s "--since \"30 minutes ago\"").

Contoh eksekusi

alloydbomni_dump -k /home/user/ssh-key \
  -u sa_12345 -d /tmp/deployment_spec.yaml \
  -o /tmp/debug_dump -s "--since \"2 hours ago\""

Mendapatkan log diagnostik orchestrator

Anda dapat memperoleh log diagnostik yang dihasilkan oleh orchestrator alloydbctl dan Ansible. Hal ini memungkinkan Anda meningkatkan panjang respons untuk pemecahan masalah atau menonaktifkan output untuk skrip otomatis. Logging sangat penting untuk mendiagnosis masalah selama bootstrap, pengelolaan, atau operasi umum cluster Anda.

Mendapatkan log debug alloydbctl

Alat alloydbctl mendukung argumen command line untuk mengontrol level log dan tujuan output. Tingkat log menentukan tingkat keparahan pesan yang akan dicatat ke dalam log, sedangkan tujuan log menentukan tempat log ini ditulis.

alloydbctl [command] ... [{-l|--log_level} <LEVEL>] [{-f|--log_file} <FILE>]

Level log (-l / --log_level)

Anda dapat menggunakan level log berikut. Tingkat log tidak peka huruf besar/kecil (misalnya, DEBUG dan debug diperlakukan sama).

  • NOTSET (Default): tidak ada logging.
  • DEBUG: mencatat informasi mendetail, biasanya hanya diperlukan saat mendiagnosis masalah. Mencatat permintaan dan respons RPC ke dalam log.
  • INFO: mengonfirmasi bahwa semuanya berfungsi seperti yang diharapkan.
  • WARNING: indikasi bahwa sesuatu yang tidak terduga terjadi (misalnya, 'kapasitas disk rendah'), tetapi software masih berfungsi.
  • ERROR: karena masalah yang lebih serius, software tidak dapat menjalankan beberapa fungsi.
  • CRITICAL: error serius, yang menunjukkan bahwa program itu sendiri mungkin tidak dapat terus berjalan.

Tujuan log (-f / --log_file)

Anda dapat memilih tujuan log berikut:

  • Jalur file: jika disediakan (misalnya, -f /tmp/alloydbctl.log), log akan ditulis ke file yang ditentukan.
  • Output standar: jika tidak diberikan, log akan dicetak ke konsol (stdout).

Contoh

Contoh berikut menggunakan alloydbctl untuk menerapkan spesifikasi deployment dan resource sekaligus mengaktifkan logging level DEBUG. Log, termasuk informasi mendetail dan permintaan/respons RPC, ditulis ke file /tmp/alloydbctl_debug.log, bukan output standar.

alloydbctl apply -d deployment_spec.yaml -r resource_spec.yaml -l DEBUG -f /tmp/alloydbctl_debug.log

Mendapatkan log debug Ansible

Ansible Orchestrator menghasilkan log dari tugas Ansible dan modul Ansible. Anda dapat meneruskan argumen command line Ansible standar untuk mengubah perilaku logging untuk tugas dan modul. Untuk mengetahui informasi mendetail, lihat dokumentasi ansible-playbook.

Level log untuk modul Ansible

Secara default, log dikirim ke konsol tempat playbook berjalan.

Untuk menetapkan setelan konfigurasi log_level, jalankan perintah berikut:

ansible-playbook -i inventory.yaml bootstrap.yaml \
  -e resource_spec=resource_spec.yaml \
  -e log_level=DEBUG

Anda juga dapat menggunakan flag panjang respons Ansible standar berikut untuk mengontrol panjang respons output:

  • -v: panjang respons dasar (log level INFO).
  • -vv atau lebih tinggi: meningkatkan panjang respons (log level DEBUG).

Contoh:

ansible-playbook -i inventory.yaml bootstrap.yaml \
  -e resource_spec=resource_spec.yaml \
  -vv

Jalur log untuk modul Ansible

Secara default, log tidak dicatat dan level log harus dikonfigurasi untuk mencatat log dalam file log.

Untuk menyimpan output Ansible ke file log, jalankan perintah berikut untuk menetapkan konfigurasi log_path:

ansible-playbook -i inventory.yaml bootstrap.yaml \
  -e resource_spec=resource_spec.yaml \
  -e log_file=/tmp/ansible-module.log

Mereset instance systemd yang gagal

Jika dump debug menunjukkan instance layanan yang tidak berlaku dan gagal, hapus instance tersebut dengan menjalankan perintah berikut pada node cluster yang terpengaruh:

sudo systemctl reset-failed

Untuk mereset layanan systemd tertentu, tentukan nama instance layanan:

sudo systemctl reset-failed INSTANCE_NAME

Ganti INSTANCE_NAME dengan nama instance layanan systemd, misalnya, alloydbomni18@abc.service.