Etiquetas de metadados de recursos obsoletas

Os recursos monitorizados no Cloud Monitoring incluem um conjunto de etiquetas que são usadas para identificar uma instância específica do tipo de recurso monitorizado. Estas etiquetas estão documentadas para cada tipo de recurso monitorizado na lista de recursos monitorizados.

Além disso, a monitorização pode criar etiquetas adicionais para captar metadados sobre um recurso monitorizado. Estas etiquetas de metadados do sistema estão disponíveis para os utilizadores como valores só de leitura. Os utilizadores também podem criar as suas próprias etiquetas de metadados de recursos. Para mais informações, consulte o artigo Etiquetas de metadados de recursos.

Um grupo de etiquetas de metadados de recursos monitorizados foi descontinuado. As etiquetas no conjunto são redundantes e podem ser substituídas por etiquetas equivalentes existentes, ou representam conceitos obsoletos que já não são suportados pelas políticas de alerta, pelos gráficos, pelas tabelas de dados ou pelos grupos de recursos do Cloud Monitoring.

Efeitos da descontinuação

Todas as políticas de alerta, gráficos, tabelas de dados e grupos de recursos que especificam um recurso monitorizado e usam etiquetas de metadados para as quais foi possível determinar etiquetas de substituição foram migrados automaticamente para usar as substituições até 31 de julho de 2020. Todas as outras utilizações de etiquetas descontinuadas têm de ser migradas manualmente. Esta página fornece informações sobre como migrá-los.

Notas:

• Se tiver um filtro que não especifica um recurso monitorizado, mas usa etiquetas de metadados, não foi possível determinar se a etiqueta de metadados está descontinuada: as etiquetas de metadados não são únicas em todos os recursos monitorizados, e as etiquetas descontinuadas estão associadas a recursos monitorizados específicos. Tem de avaliar esses filtros manualmente.
• As etiquetas de metadados nos filtros numa agregação secundária não foram migradas automaticamente.
• As etiquetas de metadados em consultas escritas na linguagem de consulta de monitorização (MQL) não foram migradas automaticamente.

Quaisquer políticas de alerta, gráficos, tabelas de dados e grupos de recursos que usem etiquetas de metadados que não foram migradas automaticamente nem manualmente até 31 de julho de 2020 já não são suportados e podem deixar de funcionar.

Ação necessária

Para reparar políticas de alerta, gráficos, tabelas de dados ou grupos de recursos que deixaram de funcionar devido a etiquetas de metadados descontinuadas, tem de tomar algumas medidas. Pode remover as políticas de alerta, os gráficos, as tabelas de dados ou os grupos, ou pode modificar os filtros que usam essas etiquetas descontinuadas para usar etiquetas que ofereçam um comportamento semelhante.

Da mesma forma, se tiver filtros que usam etiquetas de metadados, mas não especificam recursos monitorizados, não é possível determinar automaticamente se estas etiquetas estão descontinuadas. Tem de os avaliar e resolver manualmente.

Esta página inclui um script para ajudar a identificar utilizações de etiquetas de metadados descontinuadas.

Etiquetas de metadados descontinuadas

A tabela seguinte apresenta as etiquetas de metadados de recursos que estão a ser descontinuadas e as respetivas substituições, se existirem.

Nota: nos filtros, o prefixo da etiqueta resource.metadata é usado onde a tabela mostra o prefixo metadata.system_labels. Por exemplo, a etiqueta apresentada como metadata.system_labels.name na tabela é referida como resource.metadata.name nos filtros.

Tipo de recurso monitorizado	Etiqueta descontinuada	Etiqueta equivalente
Todos os Google Cloud tipos	metadata.system_labels.cloud_account^*	resource.labels.project_id
cloud_tasks_queue	metadata.system_labels.name metadata.system_labels.state	resource.labels.queue_id none
dataflow_job	metadata.system_labels.name metadata.system_labels.state	resource.labels.job_name none
gae_app	metadata.system_labels.gaeapp metadata.system_labels.gaemodule metadata.system_labels.gaeversion	nenhum^† considere resource.labels.project_id nenhum^† considere resource.labels.module_id nenhum^† considere 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	nenhum
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

^* A sintaxe do filtro do Cloud Monitoring não permite que a etiqueta resources.labels.project_id seja usada com a mesma flexibilidade que a etiqueta metadata.system_labels.cloud_account. Por exemplo, não pode fazer o seguinte:

• Use OR para combinar uma expressão com a etiqueta project_id e uma expressão com etiquetas de metadados.
• Use a operação != com a etiqueta project_id.
• Use as funções starts_with ou has_substring com a etiqueta project_id.

^† Para recursos gae_app: as etiquetas de recursos indicadas são semelhantes às etiquetas de metadados descontinuadas, pelo que podem ser boas substituições. No entanto, uma vez que são apenas semelhantes, não foram migrados automaticamente.

^‡ Para recursos gce_disk e gce_instance: se não definir metadata.user_labels.name de outra forma, este campo é preenchido automaticamente com o valor de metadata.system_labels.name. Esta funcionalidade de preenchimento automático também terminou a 31 de julho de 2020. As políticas de alerta, os gráficos, as tabelas de dados e os grupos de recursos que filtram o valor metadata.user_labels.name preenchido automaticamente foram migrados para usar metadata.system_labels.name.

^# Para recursos pubsub_topic e pubsub_subscription: corrigimos um erro antigo que fazia com que metadata.system_labels.name fosse convertido automaticamente em minúsculas (por exemplo, "My-Subscription" tornou-se "my-subscription"). Isto produziu um comportamento inesperado nos casos em que os utilizadores tinham vários recursos cujos nomes em minúsculas eram idênticos. Este comportamento também terminou a 31 de julho de 2020. Após esta data, a etiqueta do sistema de metadados name reflete o nome real do tópico ou da subscrição (por exemplo, "My-Subscription").

O que necessito de fazer?

Existem dois passos de alto nível:

1. Determine se está a usar etiquetas de metadados afetadas por esta descontinuação. Consulte o artigo Encontre etiquetas de metadados descontinuadas para obter informações sobre a execução do script de deteção fornecido.

2. Se estiver a usar etiquetas de metadados afetadas, atualize-as ou remova-as. Consulte o artigo Atualize os seus filtros para ver passos mais detalhados.

Encontre etiquetas de metadados descontinuadas

Pode usar este script Python para identificar referências a etiquetas de metadados descontinuadas: metadata_label_detection.py.

Nota: o script não consegue detetar etiquetas de metadados em filtros em agregações secundárias.

Resumo da sintaxe: python3 metadata_label_detection.py PROJECT_ID_OR_NUMBER

PROJECT_ID_OR_NUMBER pode ser um ID do projeto (por exemplo, my-project) ou um número do projeto (por exemplo, 123456789). Não inclua o prefixo projects/.

Os passos seguintes descrevem uma forma de usar o script:

1. Aceda à Google Cloud consola.

   Aceda à Google Cloud consola

2. Clique em Ativar Cloud Shell na parte superior da Google Cloud página da consola do seu projeto.

3. Clique em Abrir editor na barra de ferramentas do Cloud Shell. Se o espaço de trabalho do seu diretório inicial ainda não estiver aberto, abra-o selecionando Ficheiro e, de seguida, Abrir espaço de trabalho. Escolha o espaço de trabalho com o seu nome de utilizador.

4. Crie um novo ficheiro denominado metadata_label_detection.py selecionando Ficheiro e, de seguida, Novo Ficheiro. Cole o texto de metadata_label_detection.py no editor. Guarde o ficheiro selecionando Ficheiro e, de seguida, Guardar.

5. Regresse ao terminal clicando em Abrir terminal na barra de ferramentas do Cloud Shell.

6. Na linha de comandos do Cloud Shell, instale as dependências do script executando o seguinte comando:

   sudo pip3 install google-cloud-monitoring=="1.*" google-cloud-monitoring-dashboards
   

7. Depois de instalar as dependências, execute o script do detetor:

   python3 metadata_label_detection.py $GOOGLE_CLOUD_PROJECT
   

O script gera um relatório semelhante ao seguinte excerto:

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.

Nota: nos filtros, o prefixo da etiqueta resource.metadata é usado quando o script comunica o prefixo metadata.system_labels. Por exemplo, a etiqueta apresentada como metadata.system_labels.name na saída é referida como resource.metadata.name nos filtros.

Atualize os seus filtros

Para atualizar as políticas de alerta, os gráficos, as tabelas de dados e os grupos de recursos:

1. Inicie sessão na Google Cloud consola.

2. Execute o script do detetor conforme descrito em Encontre etiquetas descontinuadas.

3. Inspeccione cada uma das suas políticas de alerta, gráficos e grupos de recursos para verificar se o valor que está a obter é proveniente de uma das etiquetas descontinuadas identificadas pelo script.

   Para verificar todos os gráficos, tem de verificar cada gráfico em cada painel de controlo personalizado que definiu.

   Lembre-se de que os filtros usam o prefixo resource.metadata em vez de metadata.system_labels.

   Nota: se criou painéis de controlo com tabelas de dados usando a API, tem de usar a API para os verificar. Não é possível editar as tabelas de dados a partir da Google Cloud consola.

   Para cada etiqueta descontinuada, faça uma das seguintes ações:

   • Se a etiqueta não tiver uma substituição, remova a utilização da etiqueta ou elimine a política de alerta, o gráfico ou o grupo de recursos.

   • Se a etiqueta tiver uma substituição, substitua a etiqueta descontinuada pela substituição.

   Se não fizer nada, a política de alertas, o gráfico ou o grupo de recursos afetado não vai funcionar.

   Para obter ajuda adicional sobre como fazer atualizações através da Google Cloud consola, consulte os recursos indicados em Edição.

   Em alguns casos, pode ter de usar a API Cloud Monitoring em vez da Google Cloud consola. A API pode expressar algumas consultas que não podem ser construídas de outra forma.

4. Execute novamente o script do detetor para verificar que não restam etiquetas descontinuadas.

Informações adicionais

Para obter informações sobre etiquetas de metadados de recursos, filtros ou tipos de recursos monitorizados específicos, consulte o seguinte:

• Etiquetas: etiquetas de metadados de recursos
• Filtros: filtros de monitorização
• Tipos de recursos monitorizados específicos: lista de recursos monitorizados

Edição

Para obter informações sobre a atualização de políticas de alerta, gráficos, painéis de controlo e grupos de recursos, consulte o seguinte:

• Políticas de alerta: gerir políticas
• Painéis de controlo e gráficos através da Google Cloud consola: Gerir painéis de controlo
• Painéis de controlo através da API Monitoring: atualizar painéis de controlo
• Grupos de recursos: editar um grupo