Configure o Google Cloud Observability para a monitorização de aplicações

Quando implementa uma aplicação do App Hub, esta pode enviar dados de telemetria para vários Google Cloud projetos. Para ver toda a telemetria gerada pela sua aplicação através de uma única interface, como através dos painéis de controlo prontos a usar (OOTB) que a monitorização de aplicações oferece, tem de configurar a Google Cloud Observability. Este documento descreve a configuração necessária.

Este documento aplica-se quando implementa a sua aplicação e, em seguida, a regista no App Hub ou quando implementa as suas aplicações através do Application Design Center.

Além de configurar o Google Cloud Observability, pode querer fazer o seguinte:

  1. Anexe etiquetas específicas da aplicação às suas políticas de alerta. Quando adiciona estas etiquetas, os incidentes associados à sua aplicação são apresentados nos painéis de controlo predefinidos. Para obter informações sobre este passo, consulte a secção Associe uma política de alerta a uma aplicação do App Hub deste documento.

  2. Se implementar cargas de trabalho no Google Kubernetes Engine e quiser que os sinais de ouro de tráfego, latência e taxa de erros sejam apresentados nos painéis de controlo OOTB, instrumente a sua aplicação com o OpenTelemetry. Para mais informações, consulte o artigo Instrumente para a monitorização de aplicações.

Antes de começar

  • Identifique o projeto cujo âmbito de observabilidade vai configurar. Este projeto é o seu projeto anfitrião do App Hub ou o projeto de gestão das pastas com apps ativadas. Por exemplo, se o nome a apresentar da pasta for My Folder, o nome a apresentar do projeto de gestão é My Folder-mp.

  • Certifique-se de que tem as funções de gestão de identidade e de acesso (IAM) necessárias para configurar o âmbito de observabilidade. As funções de IAM necessárias dependem de planear criar um destino agregado, que lhe permite centralizar o armazenamento de dados de registo.

    Configure o destino e os âmbitos

    Para receber as autorizações de que precisa para configurar âmbitos de observabilidade e criar um destino de registo agregado, peça ao seu administrador que lhe conceda a função do IAM de administrador da organização (roles/resourcemanager.organizationAdmin) na sua organização. Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

    Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

    Configure apenas âmbitos

    Para receber as autorizações de que precisa para configurar o âmbito de observabilidade, peça ao seu administrador que lhe conceda as seguintes funções de IAM:

    Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

    Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

Configure o âmbito da observabilidade

O âmbito da observabilidade controla a forma como as páginas do explorador e do painel de controlo pesquisam os dados a apresentar. Cada Google Cloud projeto contém um único âmbito de observabilidade. Não configura diretamente o âmbito de observabilidade de um projeto. Em alternativa, para o seu projeto, configure o seguinte:

  • O âmbito do registo predefinido

    Configure este âmbito para que, quando abrir a página do Explorador de registos ou ver painéis de controlo, os dados de registo da sua aplicação sejam apresentados. Certifique-se de que este âmbito lista os projetos e as visualizações de registos que armazenam os dados de registo da sua aplicação.

  • O âmbito das métricas

    Configure este âmbito para que os seus gráficos, por exemplo, os que cria através da página Explorador de métricas, e as políticas de alerta possam apresentar ou monitorizar os dados de métricas da sua aplicação. Certifique-se de que este âmbito apresenta os projetos que armazenam os dados de métricas da sua aplicação.

  • O âmbito do rastreio predefinido

    Configure este âmbito para que, quando abrir a página do Explorador de rastreios, os dados de rastreio da sua aplicação sejam apresentados. Certifique-se de que este âmbito lista os projetos que armazenam os dados de rastreio da sua aplicação.

O resto desta secção fornece orientações sobre como configurar estes âmbitos.

Configure e defina o âmbito do registo predefinido

Efetue um dos seguintes passos:

  • Se tiver um destinatário agregado ao nível da organização que encaminha todos os dados de registo na sua organização para um contentor de registos centralizado, recomendamos o seguinte:

    1. Crie uma vista de registo no contentor de registos centralizado para os registos da sua aplicação.

    2. No projeto anfitrião do App Hub ou no projeto de gestão da pasta com apps, crie um âmbito de registo e adicione a vista de registo e, em seguida, defina este âmbito como o âmbito de registo predefinido.

  • Se estiver a usar uma pasta com apps e não tiver um destino agregado ao nível da organização ou pastas aninhadas, recomendamos que siga as seguintes instruções:

    1. Crie um destinatário agregado de interceção para a pasta ativada para apps e encaminhe esses registos para o recipiente de registos _Default do projeto de gestão.

    2. No projeto de gestão da pasta com apps, certifique-se de que o âmbito do registo denominado _Default está definido como o âmbito do registo predefinido. O âmbito denominado _Default apresenta a vista _AllLogs no contentor de registos do projeto, que é a localização de armazenamento centralizada da sua aplicação._Default

  • Se não estiver a usar um destino agregado, para o projeto de anfitrião do App Hub ou o projeto de gestão da pasta com apps, configure o âmbito do registo predefinido para listar as localizações de armazenamento dos dados de registo da sua aplicação. Recomendamos que adicione visualizações de registos nos contentores de registos que armazenam os seus dados de registos.

Por exemplo, suponhamos que configurou uma pasta com apps e que não está a usar um destino agregado. Em seguida, pode fazer o seguinte:

  1. No projeto de gestão, cria um âmbito de registo.

  2. Adiciona ao âmbito do registo uma vista de registo para cada projeto na sua pasta, incluindo o projeto de gestão.

    A vista que adiciona é a vista _AllLogs no contentor de registos _Default do projeto. Esta vista inclui todos os registos no contentor de registos _Default e o contentor de registos _Default armazena os dados de registo da sua aplicação.

    Depois de concluir este passo, o âmbito do registo pode ter entradas como:

    _Default/_AllLogs     my-folder-mp
_Default/_AllLogs     project-in-my-folder
_Default/_AllLogs     another-project-in-my-folder

  3. Guarda o âmbito do registo e define-o como o âmbito do registo predefinido.

Configure o âmbito das métricas

Certifique-se de que o âmbito das métricas do projeto anfitrião do App Hub ou do projeto de gestão da pasta com apps ativadas apresenta todos os projetos que armazenam os dados das métricas da sua aplicação:

  • Para pastas com apps ativadas, o Google Cloud Observability tenta sincronizar a lista de projetos na pasta com apps ativadas com a lista de projetos no âmbito das métricas. Por exemplo, se adicionar um projeto à pasta com apps ativadas, é emitido um comando para adicionar esse projeto ao âmbito das métricas.

    Quando o número de projetos na sua pasta com apps ativadas não excede a quota do âmbito das métricas, que é de 375 projetos por âmbito das métricas por predefinição, o Google Cloud Observability pode manter a lista de projetos no âmbito das métricas sincronizada com a lista de projetos na sua pasta com apps ativadas. Por exemplo, suponhamos que a quota é de 375 projetos por âmbito de métricas. Se a pasta com apps tiver 100 projetos, o âmbito das métricas apresenta todos os projetos na pasta com apps. Se adicionar projetos à pasta com apps ativadas, estes também são adicionados ao âmbito das métricas.

    Quando o número de projetos na pasta com apps excede a quota do âmbito das métricas, a lista de projetos no âmbito das métricas não inclui todos os projetos na pasta com apps. Por exemplo, suponhamos que a quota é de 375 projetos por âmbito de métricas e que a sua pasta com apps ativadas contém 380 projetos. Depois de adicionar 375 projetos ao âmbito das métricas, a quota é esgotada e as tentativas de adicionar os 5 projetos restantes falham. Como resultado, alguns dados da aplicação não estão disponíveis para o seu projeto de gestão.

    Recomendamos que reveja a sua utilização da quota do âmbito das métricas e determine se precisa de pedir uma atualização da quota ou modificar manualmente o âmbito das métricas. Para obter informações acerca destes passos, consulte o artigo Âmbitos das métricas para pastas com apps ativadas.

  • Para projetos anfitriões do App Hub, tem de configurar o âmbito das métricas do projeto anfitrião.

    Se alterar o conjunto de projetos que armazenam os dados das métricas, também tem de atualizar o âmbito das métricas do projeto anfitrião.

Configure e defina o âmbito do rastreio predefinido

Faça o seguinte:

  1. No projeto anfitrião do App Hub ou no projeto de gestão da pasta com apps, crie um âmbito de rastreio e adicione os projetos que armazenam os dados de rastreio da aplicação. Se estiver a usar uma pasta com apps ativadas, adicione os projetos nessa pasta.

  2. Defina o âmbito do rastreio personalizado como o âmbito do rastreio predefinido.

Associe uma política de alerta a uma aplicação do App Hub

Para ver as suas políticas de alerta a partir do contexto da monitorização de aplicações, tem de as associar a um serviço ou a uma carga de trabalho adicionando etiquetas específicas da aplicação à política de alerta. Estas etiquetas definidas pelo utilizador também são incluídas em quaisquer incidentes criados para uma política. Para saber mais sobre as etiquetas, consulte o artigo Anote incidentes com etiquetas. Para ver uma lista das etiquetas do App Hub, consulte o artigo Veja a telemetria das aplicações.

Para associar uma política de alertas a uma carga de trabalho ou um serviço através da consola Google Cloud , faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Alertas:

    Aceder a Alertas

    Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

  2. Na barra de ferramentas da Google Cloud consola, selecione o projeto de anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
  3. Encontre a política de alertas, clique em Ver mais, selecione Editar e, de seguida, aceda à secção Notificações e nome.
  4. Na secção Etiquetas de aplicações, selecione a sua aplicação e, em seguida, selecione a sua carga de trabalho ou serviço.
  5. Clique em Guardar política.

Depois de concluir estes passos, as etiquetas com as seguintes chaves são anexadas à sua política de alertas. Estas etiquetas identificam a sua aplicação e o seu serviço ou carga de trabalho:

  • apphub_application_location
  • apphub_application_id
  • apphub_service_id ou apphub_workload_id

Também pode adicionar etiquetas de utilizador a uma política de alerta através da CLI Google Cloud, do Terraform ou da API Cloud Monitoring. No entanto, tem de usar as chaves de etiquetas apresentadas no exemplo anterior. Para mais informações, consulte o seguinte:

Conceder acesso

A IAM gere o acesso aos seus dados de registo, métricas e rastreio. Esta secção resume as funções que pode querer conceder aos diretores:

  • Logs View Accessor (roles/logging.viewAccessor) nas visualizações de registos apresentadas no âmbito de registos predefinido do projeto anfitrião do seu App Hub ou do projeto de gestão da sua pasta com apps ativadas. Para saber como conceder acesso a uma visualização de registos, consulte o artigo Controle o acesso a uma visualização de registos.

  • Visualizador de registos (roles/logging.viewer) no projeto de anfitrião do App Hub ou no projeto de gestão da pasta ativada para apps e em quaisquer outros projetos listados no respetivo âmbito de registo predefinido. Esta função concede acesso à maioria das entradas de registo no contentor de registos _Default. Para mais informações, consulte o artigo Funções de registo.

  • Função de Editor de monitorização (roles/monitoring.editor) no projeto anfitrião do App Hub ou no projeto de gestão da pasta com apps ativadas. Para os responsáveis que não precisam de criar políticas de alerta, considere conceder a função de Leitor de monitorização (roles/monitoring.viewer).

  • Utilizador do Cloud Trace (roles/cloudtrace.user) no seu projeto de anfitrião do App Hub ou no projeto de gestão da sua pasta ativada para apps e nos projetos indicados no respetivo âmbito de rastreio predefinido.

  • Visualizador do centro de apps (roles/apphub.view) no projeto anfitrião do centro de apps ou no projeto de gestão da pasta com apps.

O que se segue?