Générer des fichiers de dump de diagnostic AlloyDB Omni

Sélectionnez une version de la documentation :

Générez un dump de débogage AlloyDB Omni avec l'état du système et les journaux de diagnostic pour résoudre les problèmes inattendus dans vos déploiements. Les journaux de débogage fournissent des informations de diagnostic essentielles sur l'état d'AlloyDB Omni, ce qui vous aide, vous ou l'équipe Cloud Customer Care, à analyser les problèmes liés aux défaillances ou aux problèmes d'exécution de divers services de la pile AlloyDB Omni. Collectez ces fichiers à l'aide d'un rôle Ansible ou d'un outil autonome.

Contrôlez les journaux de diagnostic au niveau de l'orchestrateur pour alloydbctl et Ansible afin d'ajuster le niveau de détail pour le dépannage ou de désactiver la sortie pour les scripts automatisés. Ces journaux sont essentiels pour diagnostiquer les problèmes lors de l'amorçage, de la gestion ou du fonctionnement général du cluster.

Collecter et vider les informations de débogage

Vous pouvez collecter et vider les informations de débogage à l'aide d'un rôle Ansible ou de l'outil de vidage de débogage.

Collecter des informations de débogage à l'aide d'Ansible

Le rôle Ansible google.alloydbomni_orchestrator.dump_debug automatise le processus de collecte sur tous les nœuds AlloyDB Omni définis dans votre spécification de déploiement. Il collecte et consolide les informations suivantes :

  • État de systemd : état actuel de tous les services AlloyDB Omni.
  • Journaux du journal : journaux système, permettant un filtrage basé sur le temps.

Générer un vidage des informations de débogage

  1. Créez un playbook Ansible (par exemple, dump_debug.yml) sur votre nœud de contrôle. Ajoutez le code suivant au 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
    

    Remplacez les éléments suivants :

    • ANSIBLE_USER : utilisateur avec lequel Ansible se connecte.
    • PATH_TO_PRIVATE_SSH_KEY : chemin d'accès au fichier de clé privée SSH.
    • BINARY_PATH : facultatif. Chemin d'accès aux binaires sur les nœuds distants. La valeur par défaut est /usr/local/bin.
    • COLLECTION_TYPE : facultatif. Type de collection (status, logs, config ou all). La valeur par défaut est all.
    • ANSIBLE_DESTINATION : facultatif. Destination sur le nœud de contrôle Ansible. La valeur par défaut est /tmp/debug_dump.
    • TAG_NAME : facultatif. Identifiant personnalisé. Des suffixes (par exemple, _1) sont ajoutés si le tag existe. La valeur par défaut est le code temporel du système.
    • JOURNAL_SPEC : facultatif. Accepte les options journalctl (par exemple, "--since '1 hour ago'"). Valeur par défaut : -n 1000.
  2. Exécutez le playbook à l'aide de la commande ansible-playbook, en spécifiant votre deployment_spec.yaml comme inventaire.

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

    Vous pouvez également exécuter le playbook avec un tag personnalisé et une spécification de journal de votre choix.

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

    Remplacez les éléments suivants :

    • PATH_TO_DEPLOYMENT_SPEC : chemin d'accès au fichier YAML de spécification de votre déploiement.
    • TAG_NAME : facultatif. Identifiant personnalisé. Des suffixes (par exemple, _1) sont ajoutés si le tag existe. La valeur par défaut est le code temporel du système.
    • JOURNAL_SPEC : facultatif. Accepte les options journalctl (par exemple, "--since '1 hour ago'"). La valeur par défaut est -n 1000.

Collecter des informations de débogage à l'aide de l'outil de vidage de débogage

Vous pouvez utiliser l'outil alloydbomni_dump pour générer un fichier de dump. Cet outil est inclus dans le package de l'outil d'orchestration AlloyDB Omni.

Générer un fichier de dump

Exécutez le script suivant sur les nœuds de cluster AlloyDB Omni que vous souhaitez déboguer.

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

Remplacez les éléments suivants :

  • SSH_KEY : chemin d'accès à la clé privée SSH de l'utilisateur.
  • USER : nom d'utilisateur pour l'accès SSH aux nœuds du cluster.
  • PATH_TO_DEPLOYMENT_SPEC : chemin d'accès au fichier YAML de spécification de votre déploiement.
  • OUTPUT_DIRECTORY : répertoire local dans lequel enregistrer le fichier de dump généré.

Commandes compatibles

  • -k : chemin d'accès requis à la clé privée SSH.
  • -u : nom d'utilisateur du compte de service requis.
  • -d : chemin d'accès obligatoire au fichier YAML de spécification du déploiement.
  • -o : répertoire de sortie requis pour le fichier tar final.
  • -t : identifiant de tag personnalisé facultatif.
  • -c : type de collection facultatif (status, logs, config, all).
  • -s : spécification facultative de la taille et de la durée du journal (par exemple, -s "--since \"30 minutes ago\"").

Exemple d'exécution

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

Obtenir les journaux de diagnostic de l'orchestrateur

Vous pouvez obtenir les journaux de diagnostic générés par les orchestrateurs alloydbctl et Ansible. Cela vous permet d'augmenter le niveau de détail pour le dépannage ou de désactiver la sortie pour les scripts automatisés. La journalisation est essentielle pour diagnostiquer les problèmes lors de l'amorçage, de la gestion ou du fonctionnement général de vos clusters.

Obtenir les journaux de débogage alloydbctl

L'outil alloydbctl accepte des arguments de ligne de commande pour contrôler le niveau de journalisation et la destination de sortie. Le niveau de journalisation détermine la gravité des messages à consigner, tandis que la destination des journaux spécifie l'emplacement où ces journaux sont écrits.

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

Niveaux de journalisation (-l / --log_level)

Vous pouvez utiliser les niveaux de journalisation suivants. Les niveaux de journalisation ne sont pas sensibles à la casse (par exemple, DEBUG et debug sont traités de la même manière).

  • NOTSET (par défaut) : aucune journalisation.
  • DEBUG : consigne des informations détaillées, qui ne sont généralement utiles que pour diagnostiquer des problèmes. Enregistre les requêtes et les réponses RPC.
  • INFO : confirme que tout fonctionne comme prévu.
  • WARNING : indique qu'un événement inattendu s'est produit (par exemple, "espace disque faible"), mais que le logiciel fonctionne toujours.
  • ERREUR : en raison d'un problème plus grave, le logiciel ne peut pas exécuter une fonction.
  • CRITICAL : erreur grave, indiquant que le programme lui-même ne peut peut-être pas continuer à s'exécuter.

Destination des journaux (-f / --log_file)

Vous pouvez sélectionner les destinations de journaux suivantes :

  • Chemin d'accès au fichier : s'il est fourni (par exemple, -f /tmp/alloydbctl.log), les journaux sont écrits dans le fichier spécifié.
  • Sortie standard : si elle n'est pas fournie, les journaux sont affichés dans la console (stdout).

Exemple

L'exemple suivant utilise alloydbctl pour appliquer les spécifications de déploiement et de ressources tout en activant la journalisation au niveau DEBUG. Les journaux, y compris les informations détaillées et les requêtes/réponses RPC, sont écrits dans le fichier /tmp/alloydbctl_debug.log au lieu de la sortie standard.

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

Obtenir les journaux de débogage Ansible

L'outil d'orchestration Ansible génère des journaux à partir des tâches et des modules Ansible. Vous pouvez transmettre des arguments de ligne de commande Ansible standards pour modifier le comportement de journalisation des tâches et des modules. Pour en savoir plus, reportez-vous à la documentation ansible-playbook.

Niveau de journalisation pour les modules Ansible

Par défaut, les journaux sont envoyés à la console où le playbook est exécuté.

Pour définir le paramètre de configuration log_level, exécutez la commande suivante :

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

Vous pouvez également utiliser les options de verbosité Ansible standards suivantes pour contrôler la verbosité de la sortie :

  • -v : niveau de détail de base (journaux de niveau INFO).
  • -vv ou supérieur : verbosité accrue (journaux de niveau DEBUG).

Exemple :

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

Chemin d'accès au journal pour les modules Ansible

Par défaut, les journaux ne sont pas capturés. Le niveau de journalisation doit être configuré pour capturer les journaux dans le fichier journal.

Pour enregistrer la sortie Ansible dans un fichier journal, exécutez la commande suivante afin de définir la configuration log_path :

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

Réinitialiser les instances systemd défaillantes

Si le vidage de débogage affiche des instances de service obsolètes ou défaillantes, effacez-les en exécutant la commande suivante sur le nœud de cluster concerné :

sudo systemctl reset-failed

Pour réinitialiser un service systemd spécifique, spécifiez le nom de l'instance de service :

sudo systemctl reset-failed INSTANCE_NAME

Remplacez INSTANCE_NAME par le nom de l'instance de service systemd, par exemple alloydbomni18@abc.service.