Red Hat Summit Red Hat SummitSupportConsoleDéveloppeursCommencer un essaiContact

Chapitre 6. Collecte de données sur votre cluster

Lors de l’ouverture d’un cas de support, il est utile de fournir des informations de débogage sur votre cluster à Red Hat Support.

Il est recommandé de fournir:

6.1. À propos de l’outil must-collectther
Copier lien

La commande oc adm must-collectther CLI recueille les informations de votre cluster qui sont très probablement nécessaires pour le débogage des problèmes, y compris:

  • Définitions des ressources
  • Journaux de service

La commande oc adm must-collectther utilise l’image du plugin par défaut et écrit dans ./must-collectther.local.

Alternativement, vous pouvez collecter des informations spécifiques en exécutant la commande avec les arguments appropriés comme décrit dans les sections suivantes:

  • Afin de recueillir des données relatives à une ou plusieurs fonctionnalités spécifiques, utilisez l’argument --image avec une image, comme indiqué dans une section suivante.

    À titre d’exemple: 

    $ oc adm must-gather \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v4.18.0
    Copy to Clipboard Toggle word wrap

  • Afin de collecter les journaux d’audit, utilisez l’argument -- /usr/bin/collect_audit_logs, comme décrit dans une section suivante.

    À titre d’exemple: 

    $ oc adm must-gather -- /usr/bin/gather_audit_logs
    Copy to Clipboard Toggle word wrap
    Note

    Les journaux d’audit ne sont pas recueillis dans le cadre de l’ensemble d’informations par défaut pour réduire la taille des fichiers.

Lorsque vous exécutez oc adm must-collectther, un nouveau pod avec un nom aléatoire est créé dans un nouveau projet sur le cluster. Les données sont collectées sur ce pod et enregistrées dans un nouveau répertoire qui commence par must-collectther.local dans le répertoire de travail actuel.

À titre d’exemple: 

NAMESPACE                      NAME                 READY   STATUS      RESTARTS      AGE
...
openshift-must-gather-5drcj    must-gather-bklx4    2/2     Running     0             72s
openshift-must-gather-5drcj    must-gather-s8sdh    2/2     Running     0             72s
...
Copy to Clipboard Toggle word wrap

En option, vous pouvez exécuter la commande oc adm must-collectther dans un espace de noms spécifique en utilisant l’option --run-namespace.

À titre d’exemple: 

$ oc adm must-gather --run-namespace <namespace> \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v4.18.0
Copy to Clipboard Toggle word wrap

Il est possible de recueillir des informations de débogage sur votre cluster à l’aide de la commande oc adm must-collectther CLI.

Conditions préalables

  • En tant qu’utilisateur, vous avez accès au cluster avec le rôle cluster-admin.
  • L’OpenShift CLI (oc) est installé.

Procédure

  1. Accédez au répertoire dans lequel vous souhaitez stocker les données must-gather.

  2. Exécutez la commande oc adm must-collectther: 

    $ oc adm must-gather
    Copy to Clipboard Toggle word wrap
    Note

    Comme cette commande sélectionne un nœud de plan de contrôle aléatoire par défaut, le pod peut être programmé dans un nœud de plan de contrôle qui est dans l’état NotReady et SchedulingDisabled.

    1. En cas d’échec de cette commande, par exemple, si vous ne pouvez pas programmer un pod sur votre cluster, utilisez la commande d’inspection oc adm pour recueillir des informations pour des ressources particulières.

      Note

      Contactez Red Hat Support pour obtenir les ressources recommandées.

  3. Créez un fichier compressé à partir du répertoire must-collectther qui vient d’être créé dans votre répertoire de travail. À titre d’exemple, sur un ordinateur qui utilise un système d’exploitation Linux, exécutez la commande suivante: 

    $ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/
    1
    Copy to Clipboard Toggle word wrap
    1
    Assurez-vous de remplacer must-collectther-local.5421342344627712289/ par le nom de répertoire réel.
  4. Joindre le fichier compressé à votre dossier d’assistance sur la page Assistance clientèle du portail client Red Hat.

6.1.2. Drapeaux à collectionner
Copier lien

Les drapeaux listés dans le tableau suivant sont disponibles à utiliser avec la commande oc adm must-collectther.

Expand
Tableau 6.1. Le Red Hat OpenShift Service sur les drapeaux AWS pour oc adm must-collectther
DrapeauCommande d’exempleDescription

--toutes les images

ajouter au panier OC adm must-collectther --all-images=false

Collectez des données à collecter à l’aide de l’image par défaut pour tous les opérateurs du cluster qui sont annotés avec operators.openshift.io/must-collect-image.

--dest-dir

ajouter au panier OC adm must-collectther --dest-dir='&lt;directory_name&gt;'

Définissez un répertoire spécifique sur la machine locale où les données recueillies sont écrites.

--host-network

ajouter au panier OC adm must-collectther --host-network=false

Exécutez des pods must-collectther comme hostNetwork: true. Pertinent si une commande et une image spécifiques doivent capturer des données de niveau hôte.

--image

adm OC must-collectther --image=[&lt;plugin_image&gt;]

Indiquez une image de plugin must-gather à exécuter. Dans le cas contraire, Red Hat OpenShift Service sur l’image must-collectther par défaut d’AWS est utilisée.

--image-stream

ajouter au panier OC adm must-collectther --image-stream=[&lt;image_stream&gt;]

Indiquez un '&lt;image_stream&gt;' à l’aide d’un espace de noms ou d’une valeur name:tag contenant une image de plugin must-gather à exécuter.

--nom de node

ajouter au panier OC adm must-collectther --node-name='&lt;node&gt;'

Définissez un nœud spécifique à utiliser. Dans le cas contraire, un maître aléatoire est utilisé par défaut.

--sélecteur de nœuds

adm OC must-collectther --node-selector='&lt;node_selector_name&gt;'

Définissez un sélecteur de nœud spécifique à utiliser. Ce n’est pertinent que lorsque vous spécifiez une commande et une image qui doivent capturer des données sur un ensemble de nœuds de cluster simultanément.

--run-namespace

ajouter au panier OC adm must-collectther --run-namespace='&lt;namespace&gt;'

Il s’agit d’un espace de noms privilégié où les pods must-collectther devraient s’exécuter. Dans le cas contraire, un espace de noms temporaire est généré.

--depuis

ajouter au panier OC adm must-collectther --depuis=&lt;time&gt;

Les journaux de retour sont seulement plus récents que la durée spécifiée. Défaut à tous les journaux. Les plugins sont encouragés mais ne sont pas nécessaires pour soutenir cela. Il n’y en a qu’un depuis ou depuis.

--depuis le temps

adm OC must-collectther --depuis-time=&lt;date_and_time&gt;'

Les journaux de retour seulement après une date et une heure spécifiques, exprimés en format (RFC3339). Défaut à tous les journaux. Les plugins sont encouragés mais ne sont pas nécessaires pour soutenir cela. Il n’y en a qu’un depuis ou depuis.

--source-dir

ajouter au panier OC adm must-collectther --source-dir='/&lt;directory_name&gt;/'

Définissez le répertoire spécifique sur le pod où vous copiez les données recueillies.

--timeout

adm OC must-collectther --timeout=&lt;time&gt;'

La durée de collecte des données avant l’expiration, exprimée en secondes, minutes ou heures, par exemple 3s, 5m ou 2h. Le temps spécifié doit être supérieur à zéro. Défaut à 10 minutes s’il n’est pas spécifié.

--volume-pourcentage

adm OC must-massage --volume-pourcentage=&lt;pourcentage&gt;

Indiquez le pourcentage maximal du volume alloué de pod qui peut être utilisé pour la collecte obligatoire. En cas de dépassement de cette limite, le must-collectther cesse de recueillir, mais toujours des copies recueillies. Défaut à 30% si elle n’est pas spécifiée.

Il est possible de collecter des informations de débogage sur des fonctionnalités spécifiques en utilisant la commande oc adm must-collectther CLI avec l’argument --image ou --image-stream. L’outil must-collectther prend en charge plusieurs images, de sorte que vous pouvez collecter des données sur plus d’une fonctionnalité en exécutant une seule commande.

Expand
Tableau 6.2. Images à collectionner supportées
ImageBut

Registry.redhat.io/container-native-virtualization/cnv-must-collectther-rhel9:v4.18.0

Collecte de données pour OpenShift Virtualization.

Registry.redhat.io/openshift-serverless-1/svls-must-collectther-rhel8

Collecte de données pour OpenShift Serverless.

Registry.redhat.io/openshift-service-mesh/istio-must-collectther-rhel8:&lt;installed_version_service_mesh&gt;

Collecte de données pour Red Hat OpenShift Service Mesh.

Registry.redhat.io/rhmtc/openshift-migration-must-collectther-rhel8:v&lt;installed_version_migration_toolkit&gt;

Collecte de données pour la boîte à outils de migration pour conteneurs.

Registry.redhat.io/openshift-logging/cluster-logging-rhel9-operator:v&lt;installed_version_logging&gt;

Collecte de données pour l’enregistrement.

à propos de Quay.io/netobserv/must-collectther

Collecte de données pour l’opérateur d’observation du réseau.

Registry.redhat.io/openshift-gitops-1/must-collectther-rhel8:v&lt;installed_version_GitOps&gt;

Collecte de données pour Red Hat OpenShift GitOps.

Registry.redhat.io/openshift4/ose-secrets-store-csi-mustgather-rhel9:v&lt;installé_version_secret_store&gt;

Collecte de données pour l’opérateur de conducteur CSI Store Secrets Store.

Note

Afin de déterminer la dernière version d’un service Red Hat OpenShift sur l’image du composant AWS, consultez la page Web OpenShift Operator Cycles sur le portail client Red Hat.

Conditions préalables

  • En tant qu’utilisateur, vous avez accès au cluster avec le rôle cluster-admin.
  • L’OpenShift CLI (oc) est installé.

Procédure

  1. Accédez au répertoire dans lequel vous souhaitez stocker les données must-gather.

  2. Exécutez la commande oc adm must-collectther avec un ou plusieurs arguments --image ou --image-stream.

    Note
    • Ajoutez l’argument --image-stream=openshift/must-collectther pour collecter les données par défaut en plus des caractéristiques spécifiques.

    À titre d’exemple, la commande suivante recueille à la fois les données du cluster par défaut et les informations spécifiques à OpenShift Virtualization: 

    $ oc adm must-gather \
  --image-stream=openshift/must-gather \
    1 
    
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel9:v4.18.0
    2
    Copy to Clipboard Toggle word wrap
    1
    Le service par défaut Red Hat OpenShift sur AWS must-collectther image
    2
    L’image incontournable pour OpenShift Virtualization

    Il est possible d’utiliser l’outil must-collectther avec des arguments supplémentaires pour recueillir des données spécifiquement liées à OpenShift Logging et à l’opérateur de journalisation Red Hat OpenShift dans votre cluster. Dans OpenShift Logging, exécutez la commande suivante: 

    $ oc adm must-gather --image=$(oc -n openshift-logging get deployment.apps/cluster-logging-operator \
  -o jsonpath='{.spec.template.spec.containers[?(@.name == "cluster-logging-operator")].image}')
    Copy to Clipboard Toggle word wrap

    Exemple 6.1. Exemple de sortie must-collectther pour OpenShift Logging

    ├── cluster-logging
│  ├── clo
│  │  ├── cluster-logging-operator-74dd5994f-6ttgt
│  │  ├── clusterlogforwarder_cr
│  │  ├── cr
│  │  ├── csv
│  │  ├── deployment
│  │  └── logforwarding_cr
│  ├── collector
│  │  ├── fluentd-2tr64
│  ├── eo
│  │  ├── csv
│  │  ├── deployment
│  │  └── elasticsearch-operator-7dc7d97b9d-jb4r4
│  ├── es
│  │  ├── cluster-elasticsearch
│  │  │  ├── aliases
│  │  │  ├── health
│  │  │  ├── indices
│  │  │  ├── latest_documents.json
│  │  │  ├── nodes
│  │  │  ├── nodes_stats.json
│  │  │  └── thread_pool
│  │  ├── cr
│  │  ├── elasticsearch-cdm-lp8l38m0-1-794d6dd989-4jxms
│  │  └── logs
│  │     ├── elasticsearch-cdm-lp8l38m0-1-794d6dd989-4jxms
│  ├── install
│  │  ├── co_logs
│  │  ├── install_plan
│  │  ├── olmo_logs
│  │  └── subscription
│  └── kibana
│     ├── cr
│     ├── kibana-9d69668d4-2rkvz
├── cluster-scoped-resources
│  └── core
│     ├── nodes
│     │  ├── ip-10-0-146-180.eu-west-1.compute.internal.yaml
│     └── persistentvolumes
│        ├── pvc-0a8d65d9-54aa-4c44-9ecc-33d9381e41c1.yaml
├── event-filter.html
├── gather-debug.log
└── namespaces
   ├── openshift-logging
   │  ├── apps
   │  │  ├── daemonsets.yaml
   │  │  ├── deployments.yaml
   │  │  ├── replicasets.yaml
   │  │  └── statefulsets.yaml
   │  ├── batch
   │  │  ├── cronjobs.yaml
   │  │  └── jobs.yaml
   │  ├── core
   │  │  ├── configmaps.yaml
   │  │  ├── endpoints.yaml
   │  │  ├── events
   │  │  │  ├── elasticsearch-im-app-1596020400-gm6nl.1626341a296c16a1.yaml
   │  │  │  ├── elasticsearch-im-audit-1596020400-9l9n4.1626341a2af81bbd.yaml
   │  │  │  ├── elasticsearch-im-infra-1596020400-v98tk.1626341a2d821069.yaml
   │  │  │  ├── elasticsearch-im-app-1596020400-cc5vc.1626341a3019b238.yaml
   │  │  │  ├── elasticsearch-im-audit-1596020400-s8d5s.1626341a31f7b315.yaml
   │  │  │  ├── elasticsearch-im-infra-1596020400-7mgv8.1626341a35ea59ed.yaml
   │  │  ├── events.yaml
   │  │  ├── persistentvolumeclaims.yaml
   │  │  ├── pods.yaml
   │  │  ├── replicationcontrollers.yaml
   │  │  ├── secrets.yaml
   │  │  └── services.yaml
   │  ├── openshift-logging.yaml
   │  ├── pods
   │  │  ├── cluster-logging-operator-74dd5994f-6ttgt
   │  │  │  ├── cluster-logging-operator
   │  │  │  │  └── cluster-logging-operator
   │  │  │  │     └── logs
   │  │  │  │        ├── current.log
   │  │  │  │        ├── previous.insecure.log
   │  │  │  │        └── previous.log
   │  │  │  └── cluster-logging-operator-74dd5994f-6ttgt.yaml
   │  │  ├── cluster-logging-operator-registry-6df49d7d4-mxxff
   │  │  │  ├── cluster-logging-operator-registry
   │  │  │  │  └── cluster-logging-operator-registry
   │  │  │  │     └── logs
   │  │  │  │        ├── current.log
   │  │  │  │        ├── previous.insecure.log
   │  │  │  │        └── previous.log
   │  │  │  ├── cluster-logging-operator-registry-6df49d7d4-mxxff.yaml
   │  │  │  └── mutate-csv-and-generate-sqlite-db
   │  │  │     └── mutate-csv-and-generate-sqlite-db
   │  │  │        └── logs
   │  │  │           ├── current.log
   │  │  │           ├── previous.insecure.log
   │  │  │           └── previous.log
   │  │  ├── elasticsearch-cdm-lp8l38m0-1-794d6dd989-4jxms
   │  │  ├── elasticsearch-im-app-1596030300-bpgcx
   │  │  │  ├── elasticsearch-im-app-1596030300-bpgcx.yaml
   │  │  │  └── indexmanagement
   │  │  │     └── indexmanagement
   │  │  │        └── logs
   │  │  │           ├── current.log
   │  │  │           ├── previous.insecure.log
   │  │  │           └── previous.log
   │  │  ├── fluentd-2tr64
   │  │  │  ├── fluentd
   │  │  │  │  └── fluentd
   │  │  │  │     └── logs
   │  │  │  │        ├── current.log
   │  │  │  │        ├── previous.insecure.log
   │  │  │  │        └── previous.log
   │  │  │  ├── fluentd-2tr64.yaml
   │  │  │  └── fluentd-init
   │  │  │     └── fluentd-init
   │  │  │        └── logs
   │  │  │           ├── current.log
   │  │  │           ├── previous.insecure.log
   │  │  │           └── previous.log
   │  │  ├── kibana-9d69668d4-2rkvz
   │  │  │  ├── kibana
   │  │  │  │  └── kibana
   │  │  │  │     └── logs
   │  │  │  │        ├── current.log
   │  │  │  │        ├── previous.insecure.log
   │  │  │  │        └── previous.log
   │  │  │  ├── kibana-9d69668d4-2rkvz.yaml
   │  │  │  └── kibana-proxy
   │  │  │     └── kibana-proxy
   │  │  │        └── logs
   │  │  │           ├── current.log
   │  │  │           ├── previous.insecure.log
   │  │  │           └── previous.log
   │  └── route.openshift.io
   │     └── routes.yaml
   └── openshift-operators-redhat
      ├── ...
    Copy to Clipboard Toggle word wrap

  3. Exécutez la commande oc adm must-collectther avec un ou plusieurs arguments --image ou --image-stream. À titre d’exemple, la commande suivante recueille à la fois les données de cluster par défaut et les informations spécifiques à KubeVirt: 

    $ oc adm must-gather \
 --image-stream=openshift/must-gather \
    1 
    
 --image=quay.io/kubevirt/must-gather
    2
    Copy to Clipboard Toggle word wrap
    1
    Le service par défaut Red Hat OpenShift sur AWS must-collectther image
    2
    L’image incontournable pour KubeVirt

  4. Créez un fichier compressé à partir du répertoire must-collectther qui vient d’être créé dans votre répertoire de travail. À titre d’exemple, sur un ordinateur qui utilise un système d’exploitation Linux, exécutez la commande suivante: 

    $ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/
    1
    Copy to Clipboard Toggle word wrap
    1
    Assurez-vous de remplacer must-collectther-local.5421342344627712289/ par le nom de répertoire réel.
  5. Joindre le fichier compressé à votre dossier d’assistance sur la page Assistance clientèle du portail client Red Hat.

6.1.4. Collecte des journaux de réseau
Copier lien

Il est possible de recueillir des journaux réseau sur tous les nœuds d’un cluster.

Procédure

  1. Exécutez la commande oc adm must-collectther avec -- collect_network_logs: 

    $ oc adm must-gather -- gather_network_logs
    Copy to Clipboard Toggle word wrap
    Note

    L’outil must-collectther collecte par défaut les bases de données OVN nbdb et sbdb à partir de tous les nœuds du cluster. Ajout de l’option --collect_network_logs pour inclure des journaux supplémentaires qui contiennent des transactions OVN-Kubernetes pour la base de données OVN nbdb.

  2. Créez un fichier compressé à partir du répertoire must-collectther qui vient d’être créé dans votre répertoire de travail. À titre d’exemple, sur un ordinateur qui utilise un système d’exploitation Linux, exécutez la commande suivante: 

    $ tar cvaf must-gather.tar.gz must-gather.local.472290403699006248
    1
    Copy to Clipboard Toggle word wrap
    1
    Il suffit de remplacer must-collectther-local.472290403699006248 par le nom du répertoire.
  3. Joindre le fichier compressé à votre dossier d’assistance sur la page Assistance clientèle du portail client Red Hat.

6.1.5. Changement de la limite de stockage de must-collectther
Copier lien

Lors de l’utilisation de la commande oc adm must-collectther pour collecter des données, le stockage maximum par défaut pour l’information est de 30% de la capacité de stockage du conteneur. Après que la limite de 30% est atteinte, le conteneur est tué et le processus de collecte s’arrête. Les informations déjà collectées sont téléchargées dans votre stockage local. Afin d’exécuter à nouveau la commande must-collectther, vous avez besoin soit d’un conteneur avec plus de capacité de stockage, soit d’ajuster le pourcentage de volume maximal.

Lorsque le conteneur atteint la limite de stockage, un message d’erreur similaire à l’exemple suivant est généré.

Exemple de sortie

Disk usage exceeds the volume percentage of 30% for mounted directory. Exiting...
Copy to Clipboard Toggle word wrap

Conditions préalables

  • En tant qu’utilisateur, vous avez accès au cluster avec le rôle cluster-admin.
  • L’OpenShift CLI (oc) est installé.

Procédure

  • Exécutez la commande oc adm must-collectther avec l’indicateur volume-pourcentage. La nouvelle valeur ne peut pas dépasser 100. 

    $ oc adm must-gather --volume-percentage <storage_percentage>
    Copy to Clipboard Toggle word wrap
Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat