Collecter des informations de diagnostic

Ce document explique comment collecter des informations sur une instance de machine virtuelle (VM) à l'aide d'un outil de diagnostic. Utilisez les informations collectées par les outils pour vous aider à résoudre les problèmes de base avant de contacter Cloud Customer Care.

Cet outil effectue les opérations suivantes :

  • Il collecte uniquement les informations de la VM spécifiée.

  • Les informations sont stockées uniquement dans votre projet.

  • Stocke les informations pendant 10 jours dans un bucket Cloud Storage auquel vous seul avez accès par défaut.

Avant de partager les informations collectées avec le service client, procédez comme suit :

  1. Vérifiez que les informations ne contiennent pas d'informations confidentielles ou des informations permettant d'identifier personnellement l'utilisateur.

  2. Supprimez ou masquez les informations si nécessaire.

Avant de commencer

  • Par défaut, Compute Engine installe l'outil de diagnostic sur les versions publiques des images Windows Server dont la version est ultérieure à v20190714. Sinon, si la version de votre image Windows Server est antérieure à v20190714 ou si vous utilisez une image personnalisée, installez l'outil à l'aide de la commande googet install google-compute-engine-diagnostics.
  • Si ce n'est pas déjà fait, configurez l'authentification. L'authentification permet de valider votre identité pour accéder aux services et aux API Google Cloud . Pour exécuter du code ou des exemples depuis un environnement de développement local, vous pouvez vous authentifier auprès de Compute Engine en sélectionnant l'une des options suivantes :

    Sélectionnez l'onglet correspondant à la façon dont vous prévoyez d'utiliser les exemples de cette page :

    Console

    Lorsque vous utilisez la console Google Cloud pour accéder aux services et aux API Google Cloud , vous n'avez pas besoin de configurer l'authentification.

    gcloud

    1. Installez la Google Cloud CLI. Après l'installation, initialisez la Google Cloud CLI en exécutant la commande suivante : 

      gcloud init

      Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  • Définissez une région et une zone par défaut.

Informations de diagnostic recueillies à partir de la VM

Cet outil de diagnostic collecte des informations sur les éléments suivants :

Pour en savoir plus sur la façon dont Compute Engine collecte ces informations, consultez le dépôt GitHub public.

Limites

  • Vous pouvez collecter des informations de diagnostic uniquement à partir de VM créées sur Windows Server.

Rôles requis

Pour obtenir les autorisations nécessaires pour exécuter l'outil de diagnostic à l'aide de Google Cloud CLI, demandez à votre administrateur de vous accorder le rôle IAM Créateur de jetons du compte de service (roles/iam.serviceAccountTokenCreator) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.

Pour joindre des informations de diagnostic à une demande d'assistance, vous devez également disposer du rôle Éditeur de l'assistance technique (roles/cloudsupport.techSupportEditor).

Collecter des informations de diagnostic à partir d'une VM

Exécutez l'outil de diagnostic soit directement depuis la VM, soit à distance, à l'aide de Google Cloud CLI.

gcloud

  1. Si ce n'est pas déjà fait, attribuez le rôle iam.serviceAccountTokenCreator sur le projet au compte utilisateur ou au compte de service qui exécutera la commande gcloud compute diagnose export-logs :

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member user:EMAIL \
    --role roles/iam.serviceAccountTokenCreator

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du projet
    • EMAIL : l'adresse e-mail pour attribuer le rôle iam.serviceAccountTokenCreator

  2. Exportez les informations de diagnostic en tant qu'objet vers un bucket Cloud Storage à l'aide de la commande diagnose export-logs.

    gcloud compute diagnose export-logs VM_NAME \
  [--collect-process-traces]

    L'option facultative --collect-process-traces permet de spécifier si l'outil de diagnostic collecte une trace de 10 minutes du système en cours d'exécution, ce qui inclut l'activité du processeur, du disque, du fichier et l'activité réseau. Sur les VM Windows, l'outil utilise Windows Performance Recorder.

    Remplacez VM_NAME par le nom de la VM à partir de laquelle collecter les informations de diagnostic.

  3. Le processus d'exportation des journaux peut prendre quelques minutes. Affichez l'état à l'aide de la commande gcloud compute instances get-serial-port-output.

  4. Compute Engine formate le nom du bucket contenant les informations de diagnostic comme suit : diagnostic_logs_project_PROJECT_NUMBER. Affichez ou téléchargez le bucket à l'aide de gcloud CLI ou depuis la page Cloud Storage dans la consoleGoogle Cloud  :

    Accéder à "Stockage"

Localement (Windows uniquement)

Pour exécuter l'outil de diagnostic à partir d'une VM Windows, procédez comme suit :

  1. Connectez-vous à la VM Windows.

  2. Ouvrez une invite de commande ou une fenêtre PowerShell avec des droits d'administrateur.

  3. Accédez au répertoire contenant l'outil de diagnostic :

    cd "C:\Program Files\Google\Compute Engine\diagnostics"

  4. Exécutez l'outil de diagnostic :

    .\diagnostics.exe

    Une fois l'exécution de l'outil terminée, les informations de diagnostic collectées sont enregistrées dans le fichier compressé logs.zip de votre répertoire de travail actuel.

Indicateurs facultatifs

  • -trace : capture des informations de traçage supplémentaires. L'outil capture une trace de 10 minutes du système à l'aide de l'enregistreur de performances Windows, qui inclut l'activité du processeur, du disque, du fichier et l'activité réseau.

Joindre des informations de diagnostic à une demande d'assistance

Si vous avez une demande ouverte auprès de Cloud Customer Care, vous pouvez joindre les informations de diagnostic directement à la demande lorsque vous les collectez. Cette option vous évite de télécharger l'archive depuis Cloud Storage et de la joindre vous-même à la demande.

Les informations de diagnostic sont jointes à la demande sans étape d'examen. Si vous devez examiner les informations ou supprimer des informations confidentielles ou permettant d'identifier personnellement l'utilisateur avant de les partager, n'utilisez pas cette option. Collectez plutôt les informations comme décrit dans Collecter des informations de diagnostic à partir d'une VM, examinez l'archive dans Cloud Storage, puis joignez-la à la demande.

Avant de joindre des informations de diagnostic à une demande d'assistance, assurez-vous que :

  • Votre organisation dispose d'un forfait Customer Care qui vous permet de créer des demandes d'assistance technique (assistance Standard, Enhanced ou Premium).
  • Vous disposez du rôle Éditeur de l'assistance technique (roles/cloudsupport.techSupportEditor). Si la demande appartient à une organisation, vous devez disposer du rôle au niveau de l'organisation.
  • L'API Cloud Support est activée dans le projet.
  • La demande est ouverte.

Pour joindre des informations de diagnostic à une demande d'assistance, procédez comme suit :

  1. Assurez-vous d'avoir installé le composant de commandes alpha :

    gcloud components install alpha

  2. Exécutez la commande gcloud alpha compute diagnose export-logs avec l'option --support-case :

    gcloud alpha compute diagnose export-logs INSTANCE_NAME \
    --zone=ZONE \
    --support-case=CASE_NUMBER

    Remplacez les éléments suivants :

    • INSTANCE_NAME : nom de l'instance de calcul Windows Server.
    • ZONE : zone de l'instance
    • CASE_NUMBER : numéro d'une demande d'assistance ouverte.

    La commande vérifie que la demande existe et que vous pouvez y ajouter des pièces jointes avant de commencer la collecte. Il attend ensuite que l'instance ait fini de collecter les informations de diagnostic, ce qui peut prendre quelques minutes, puis importe l'archive dans la demande. L'archive reste également dans le bucket Cloud Storage, comme lorsque vous omettez l'option --support-case.

Étapes suivantes