Libellés de métadonnées de ressources

Dans Cloud Monitoring, les ressources surveillées sont dotées d'un ensemble de libellés permettant d'identifier une instance particulière du type de ressource surveillée. Ces libellés sont documentés pour chaque type de ressource surveillée dans la liste des ressources surveillées.

De plus, Monitoring peut créer des libellés supplémentaires pour capturer des métadonnées concernant une ressource surveillée. Ces libellés de métadonnées système sont disponibles pour les utilisateurs sous forme de valeurs en lecture seule. Les utilisateurs peuvent également créer leurs propres libellés de métadonnées de ressource. Pour en savoir plus, consultez la section Libellés de métadonnées de ressource.

Un groupe de libellés de métadonnées de ressources surveillées est devenu obsolète. Soit les libellés de l'ensemble sont redondants et peuvent être remplacés par des libellés équivalents existants, soit ils représentent des concepts obsolètes qui ne sont plus compatibles avec les règles d'alerte, les graphiques, les tableaux de données ou les groupes de ressources Cloud Monitoring.

Conséquences de cette obsolescence

L'ensemble des règles d'alerte, graphiques, tableaux de données et groupes de ressources qui spécifient une ressource surveillée et utilisent des libellés de métadonnées pour lesquels des libellés de remplacement auraient pu être déterminés ont été automatiquement migrés afin d'utiliser les remplacements avant le 31 juillet 2020. Toutes les autres utilisations de libellés obsolètes doivent être migrées manuellement. Cette page fournit des informations sur la migration.

L'ensemble des règles d'alerte, graphiques, tableaux de données et groupes de ressources utilisant des libellés de métadonnées qui n'ont pas été migrés automatiquement ou manuellement avant le 31 juillet 2020 ne sont plus compatibles et peuvent cesser de fonctionner.

Action requise

Pour réparer des règles d'alerte, des graphiques, des tableaux de données ou des groupes de ressources qui ne fonctionnent plus en raison de libellés de métadonnées obsolètes, vous devez prendre certaines mesures. Vous pouvez supprimer les règles d'alerte, les graphiques, les tableaux de données ou les groupes, ou modifier les filtres utilisant ces libellés obsolètes pour utiliser des libellés au comportement similaire.

De même, si vous avez des filtres qui utilisent des libellés de métadonnées mais ne spécifient pas de ressources surveillées, il n'est pas possible de déterminer automatiquement si ces libellés sont obsolètes. Vous devez les évaluer et les traiter manuellement.

Cette page inclut un script pour vous aider à identifier les utilisations de libellés de métadonnées obsolètes.

Libellés de métadonnées obsolètes

Le tableau suivant répertorie les libellés de métadonnées de ressources obsolètes et leurs remplaçants, le cas échéant.


Type de ressource surveillée Libellé obsolète Libellé équivalent
Tous les types Google Cloud metadata.system_labels.cloud_account* resource.labels.project_id
cloud_tasks_queue metadata.system_labels.name
metadata.system_labels.state
resource.labels.queue_id
aucun
dataflow_job metadata.system_labels.name
metadata.system_labels.state
resource.labels.job_name
aucun
gae_app metadata.system_labels.gaeapp

metadata.system_labels.gaemodule

metadata.system_labels.gaeversion
aucun
envisagez d'utiliser resource.labels.project_id
aucun
envisagez d'utiliser resource.labels.module_id
aucun
envisagez d'utiliser resource.labels.version_id
gce_disk metadata.user_labels.name metadata.system_labels.name
gce_instance metadata.user_labels.name metadata.system_labels.name
l7_lb_rule metadata.system_labels.state aucun
pubsub_topic metadata.system_labels.name# metadata.system_labels.name
pubsub_subscription metadata.system_labels.name#
metadata.system_labels.name
vpn_gateway metadata.system_labels.region resource.labels.region

* La syntaxe de filtre Cloud Monitoring n'autorise pas l'utilisation du libellé resources.labels.project_id de manière aussi flexible que le libellé metadata.system_labels.cloud_account. Par exemple, vous ne pouvez pas effectuer les opérations suivantes :

  • Utiliser OR pour combiner une expression utilisant le libellé project_id et une expression utilisant des libellés de métadonnées.
  • Utiliser l'opération != avec le libellé project_id.
  • Utiliser les fonctions starts_with ou has_substring avec le libellé project_id.

Pour les ressources gae_app : les libellés de ressources suggérés sont semblables aux libellés de métadonnées obsolètes, ce qui signifie qu'ils peuvent être efficaces. Toutefois, comme ils ne sont que similaires, ils ne sont pas migrés automatiquement.

pour les ressources gce_disk et gce_instance : si vous ne définissez pas d'élément metadata.user_labels.name, celui-ci est automatiquement renseigné avec la valeur de metadata.system_labels.name. Ce remplissage automatique a également été abandonné le 31 juillet 2020. Les règles d'alerte, les graphiques, les tableaux de données et les groupes de ressources qui filtrent sur la valeur metadata.user_labels.name renseignée automatiquement ont été migrés pour utiliser metadata.system_labels.name à la place.

# Concernant les ressources pubsub_topic et pubsub_subscription, nous avons corrigé un bug persistant provoquant la conversion automatique en minuscules de metadata.system_labels.name (par exemple, "My-Subscription" devient "my-subscription"). Cela a généré un comportement inattendu dans les cas où les utilisateurs possèdent plusieurs ressources dont les noms en minuscules sont identiques. Ce comportement a également été abandonné le 31 juillet 2020. Après cette date, le libellé de système de métadonnées name reflète le nom réel du sujet ou de l'abonnement (par exemple, "My-Subscription").

Que dois-je faire ?

Voici les deux étapes principales à suivre :

  1. Déterminez si vous utilisez des libellés de métadonnées affectés par cette obsolescence. Consultez la section Rechercher des libellés de métadonnées obsolètes pour en savoir plus sur l'exécution du script de détection fourni.

  2. Si vous utilisez des libellés de métadonnées concernés, mettez-les à jour ou supprimez-les. Pour en savoir plus, consultez la section Mettre à jour vos filtres.

Rechercher des libellés de métadonnées obsolètes

Vous pouvez utiliser ce script Python pour identifier les références à des libellés de métadonnées obsolètes : metadata_label_detection.py.

Résumé de la syntaxe : python3 metadata_label_detection.py PROJECT_ID_OR_NUMBER

PROJECT_ID_OR_NUMBER peut être un ID de projet (par exemple, my-project) ou un numéro de projet (par exemple, 123456789). N'incluez pas le préfixe projects/.

Pour utiliser le script, procédez comme suit :

  1. Accédez à Google Cloud Console.

    Accéder à Cloud Console

  2. Cliquez sur Activer Cloud Shell en haut de la page Google Cloud Console de votre projet.

  3. Cliquez sur Ouvrir l'éditeur dans la barre d'outils Cloud Shell. Si l'espace de travail de votre répertoire d'accueil n'est pas déjà ouvert, ouvrez-le en sélectionnant Fichier, puis Ouvrir l'espace de travail. Choisissez l'espace de travail incluant votre nom d'utilisateur.

  4. Créez un fichier appelé metadata_label_detection.py en sélectionnant Fichier, puis Nouveau fichier. Collez le texte du champ metadata_label_detection.py dans l'éditeur. Enregistrez le fichier en sélectionnant Fichier, puis Enregistrer.

  5. Revenez à la fenêtre de terminal en cliquant sur Ouvrir le terminal dans la barre d'outils Cloud Shell.

  6. Dans l'invite de ligne de commande dans Cloud Shell, installez les dépendances de script en exécutant la commande suivante :

    sudo pip3 install google-cloud-monitoring=="1.*" google-cloud-monitoring-dashboards
    
  7. Après avoir installé les dépendances, exécutez le script de détection :

    python3 metadata_label_detection.py $GOOGLE_CLOUD_PROJECT
    

Le script génère un rapport semblable à l'extrait suivant :

Alert "Test alert" (projects/PROJECT_ID/alertPolicies/8401129027900817186) is affected.
URL: https://console.cloud.google.com/monitoring/alerting/policies/8401129027900817186?project=PROJECT_ID
        metadata.system_labels.cloud_account is deprecated for non-AWS resource
types. Please manually remove the reference.

Group "Test group" (projects/PROJECT_ID/groups/4518177785663978371) might be affected,
depending on the type of resources it is used for.
URL: https://console.cloud.google.com/monitoring/groups/4518177785663978371?project=PROJECT_ID
        metadata.system_labels.name is deprecated for dataflow_job. Please
manually remove the reference if this group is used for dataflow_job resources.
        metadata.system_labels.name is deprecated for cloud_tasks_queue. Please
manually remove the reference if this group is used for cloud_tasks_queue resources.

Xy_chart "Test chart" in dashboard "Demo dashboard" (projects/PROJECT_ID/dashboards/2826428163455705326) is affected.
URL: https://console.cloud.google.com/monitoring/dashboards/custom/2826428163455705326?project=PROJECT_ID
        metadata.user_labels.name is deprecated for gce_instance. Please
manually remove the reference.

Mettre à jour vos filtres

Pour mettre à jour vos règles d'alerte, graphiques, tableaux de données et groupes de ressources :

  1. Connectez-vous à Google Cloud Console.

  2. Exécutez le script de détection comme expliqué dans la section Rechercher des libellés obsolètes.

  3. Inspectez chaque règle d'alerte, graphique et groupe de ressources pour vérifier si la valeur que vous récupérez provient de l'un des libellés obsolètes identifiés par le script.

    Pour vérifier tous les graphiques, vous devez vérifier individuellement chaque graphique sur chaque tableau de bord personnalisé que vous avez défini.

    N'oubliez pas que les filtres utilisent le préfixe resource.metadata au lieu de metadata.system_labels.

    Pour chaque libellé obsolète, effectuez l'une des opérations suivantes :

    • Si le libellé n'a pas de remplaçant, supprimez l'utilisation du libellé ou supprimez la règle d'alerte, le graphique ou le groupe de ressources.

    • Si le libellé a un remplaçant, remplacez le libellé obsolète par celui-ci.

    Si vous ne faites rien, la règle d'alerte, le graphique ou le groupe de ressources concerné ne fonctionnera pas.

    Pour obtenir de l'aide supplémentaire sur les mises à jour à l'aide de Google Cloud Console, consultez les ressources répertoriées dans la section Modifier.

    Dans certains cas, vous devrez peut-être utiliser l'API Cloud Monitoring plutôt que Cloud Console. L'API peut exprimer des requêtes qu'il est impossible de construire autrement.

  4. Exécutez à nouveau le script de détection pour vérifier qu'il ne reste aucun libellé obsolète.

Informations supplémentaires

Pour en savoir plus sur les libellés de métadonnées de ressources, sur les filtres ou sur les types de ressources surveillées spécifiques, consultez les pages suivantes :

Modifications

Pour plus d'informations sur la mise à jour des règles d'alerte, des graphiques, des tableaux de bord et des groupes de ressources, consultez les pages suivantes :