AlloyDB Omni 診断ダンプファイルを生成する

ドキュメントのバージョンを選択してください。

システムの状態と診断ログを含む AlloyDB Omni デバッグダンプを生成して、デプロイで予期しない問題のトラブルシューティングを行います。デバッグログには、AlloyDB Omni の状態に関する重要な診断情報が含まれています。これにより、ユーザーや Cloud カスタマーケア チームは、AlloyDB Omni スタックのさまざまなサービスの実行に関する障害や問題に関連する問題を分析できます。これらのファイルは、Ansible ロールまたはスタンドアロン ツールを使用して収集します。

alloydbctl と Ansible のオーケストレーター レベルの診断ログを制御して、トラブルシューティングのために詳細度を調整したり、自動スクリプトの出力を抑制したりします。これらのログは、クラスタのブートストラップ、管理、一般的なオペレーション中の問題を診断するうえで不可欠です。

デバッグ情報を収集してダンプする

デバッグ情報の収集とダンプは、Ansible ロールまたはデバッグダンプ ツールを使用して行えます。

Ansible を使用してデバッグ情報を収集する

google.alloydbomni_orchestrator.dump_debug Ansible ロールは、Deployment の仕様で定義されているすべての AlloyDB Omni ノードで収集プロセスを自動化します。次の情報を収集して統合します。

  • Systemd ステータス: すべての AlloyDB Omni サービスの現在の状態。
  • ジャーナル ログ: システムログ。時間ベースのフィルタリングが可能です。

デバッグ情報のダンプを生成する

  1. コントロール ノードに Ansible ハンドブックを作成します(例: dump_debug.yml)。ハンドブックに次の内容を追加します。

    - 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
    

    次のように置き換えます。

    • ANSIBLE_USER: Ansible がログインするユーザー。
    • PATH_TO_PRIVATE_SSH_KEY: SSH 秘密鍵ファイルのパス。
    • BINARY_PATH: 省略可。リモートノード上のバイナリへのパス。デフォルトは /usr/local/bin です。
    • COLLECTION_TYPE: 省略可。コレクション タイプ(status、logs、config、all)。デフォルトは all です。
    • ANSIBLE_DESTINATION: 省略可。Ansible コントロール ノードの宛先。デフォルトは /tmp/debug_dump です。
    • TAG_NAME: 省略可。カスタム識別子。タグが存在する場合は、接尾辞(_1 など)が追加されます。デフォルトはシステム タイムスタンプです。
    • JOURNAL_SPEC: 省略可。journalctl フラグ(例: "--since '1 hour ago'")をサポートします。デフォルトは -n 1000 です。
  2. ansible-playbook コマンドを使用して、deployment_spec.yaml をインベントリとして指定して、ハンドブックを実行します。

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

    または、カスタムタグと任意のジャーナル仕様を使用してハンドブックを実行します。

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

    次のように置き換えます。

    • PATH_TO_DEPLOYMENT_SPEC: デプロイ仕様の YAML ファイルのパス。
    • TAG_NAME: 省略可。カスタム識別子。タグが存在する場合は、接尾辞(_1 など)が追加されます。デフォルトはシステム タイムスタンプです。
    • JOURNAL_SPEC: 省略可。journalctl フラグ("--since '1 hour ago'" など)をサポートします。デフォルトは -n 1000 です。

デバッグダンプ ツールを使用してデバッグ情報を収集する

alloydbomni_dump ツールを使用してダンプファイルを生成できます。このツールは、AlloyDB Omni オーケストレーター パッケージに含まれています。

ダンプファイルを生成する

デバッグする AlloyDB Omni クラスタノードで次のスクリプトを実行します。

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

次のように置き換えます。

  • SSH_KEY: ユーザーの SSH 秘密鍵のパス。
  • USER: クラスタノードへの SSH アクセスのユーザー名。
  • PATH_TO_DEPLOYMENT_SPEC: デプロイ仕様の YAML ファイルのパス。
  • OUTPUT_DIRECTORY: 生成されたダンプファイルを保存するローカル ディレクトリ。

サポートされているコマンド

  • -k: SSH 秘密鍵の必須パス。
  • -u: 必須のサービス アカウントのユーザー名。
  • -d: Deployment の仕様の YAML ファイルへの必須パス。
  • -o: 最終的な tar ファイルの必須の出力ディレクトリ。
  • -t: カスタムタグ識別子(省略可)。
  • -c: オプションのコレクション タイプ(status、logs、config、all)。
  • -s: ジャーナルのサイズと時間の指定(省略可)(例: -s "--since \"30 minutes ago\"")。

実行例

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

オーケストレーターの診断ログを取得する

alloydbctl と Ansible の両方のオーケストレーターによって生成された診断ログを取得できます。これにより、トラブルシューティングの詳細度を上げたり、自動スクリプトの出力を抑制したりできます。ロギングは、クラスタのブートストラップ、管理、一般的なオペレーション中の問題を診断するために不可欠です。

alloydbctl デバッグログを取得する

alloydbctl ツールは、ログレベルと出力先を制御するコマンドライン引数をサポートしています。ログレベルは、ログに記録されるメッセージの重大度を決定します。ログの宛先は、これらのログが書き込まれる場所を指定します。

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

ログレベル(-l / --log_level)

次のログレベルを使用できます。ログレベルでは大文字と小文字は区別されません(たとえば、DEBUG と debug は同じものとして扱われます)。

  • NOTSET(デフォルト): ロギングなし。
  • DEBUG: 詳細情報をログに記録します。通常、問題の診断時にのみ必要になります。RPC リクエストとレスポンスをログに記録します。
  • INFO: は、想定どおりに動作していることを確認します。
  • WARNING: 予期しない事象(「ディスク容量が少ない」など)が発生したことを示しますが、ソフトウェアは引き続き動作しています。
  • ERROR: より深刻な問題により、ソフトウェアが一部の機能を実行できない。
  • CRITICAL: 重大なエラー。プログラム自体の実行を継続できない可能性があることを示します。

ログの宛先(-f / --log_file)

次のログの宛先を選択できます。

  • ファイルパス: 指定されている場合(例: -f /tmp/alloydbctl.log)、ログは指定されたファイルに書き込まれます。
  • 標準出力: 指定しない場合、ログはコンソール(stdout)に出力されます。

例

次の例では、alloydbctl を使用して、DEBUG レベルのロギングを有効にしながら、デプロイメントとリソースの仕様を適用します。詳細情報や RPC リクエスト/レスポンスなどのログは、標準出力ではなく /tmp/alloydbctl_debug.log ファイルに書き込まれます。

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

Ansible デバッグログを取得する

Ansible Orchestrator は、Ansible タスクと Ansible モジュールからログを生成します。標準の Ansible コマンドライン引数を渡して、タスクとモジュールの両方のロギング動作を変更できます。詳細については、ansible-playbook のドキュメントをご覧ください。

Ansible モジュールのログレベル

デフォルトでは、ログはハンドブックが実行されているコンソールに送信されます。

log_level 構成設定を設定するには、次のコマンドを実行します。

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

次の標準の Ansible 詳細フラグを使用して、出力の詳細度を制御することもできます。

  • -v: 基本的な詳細度(INFO レベルのログ)。
  • -vv 以上: 詳細度を上げます(DEBUG レベルのログ)。

次に例を示します。

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

Ansible モジュールのログパス

デフォルトでは、ログはキャプチャされません。ログファイルにログをキャプチャするには、ログレベルを構成する必要があります。

Ansible の出力をログファイルに保存するには、次のコマンドを実行して log_path 構成を設定します。

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

失敗した systemd インスタンスをリセットする

デバッグダンプに、古い、失敗したサービス インスタンスが表示されている場合は、影響を受けるクラスタノードで次のコマンドを実行して、それらをクリアします。

sudo systemctl reset-failed

特定の systemd サービスをリセットするには、サービス インスタンス名を指定します。

sudo systemctl reset-failed INSTANCE_NAME

INSTANCE_NAME は、systemd サービス インスタンスの名前(例: alloydbomni18@abc.service)に置き換えます。