Configurar o monitoramento de aplicativos

Este documento descreve como configurar a Observabilidade do Google Cloud para que você possa visualizar a telemetria de um aplicativo registrado no App Hub. Você pode implantar o app e depois fazer o registro dele no App Hub ou implantar os apps usando a Central de design de apps. O monitoramento de aplicativos pode ajudar você a entender o desempenho dos seus aplicativos, serviços e cargas de trabalho.

Antes de começar

  • Identifique o projeto cujo escopo de observabilidade você vai configurar. Esse projeto é o host do App Hub ou o projeto de gerenciamento das pastas com app ativado. Por exemplo, se o nome de exibição da pasta for My Folder, o nome de exibição do projeto de gerenciamento será My Folder-mp.

  • Verifique se você tem os papéis necessários do Identity and Access Management (IAM) para configurar o escopo de observabilidade. Os papéis do IAM necessários dependem se você planeja criar um coletor agregado, que permite centralizar o armazenamento de dados de registro.

    Configurar o coletor e os escopos

    Para receber as permissões necessárias para configurar os escopos de observabilidade e criar um sink de registro agregado, peça ao administrador para conceder a você o papel do IAM de Administrador da organização (roles/resourcemanager.organizationAdmin) na sua organização. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

    Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

    Configurar apenas escopos

    Para receber as permissões necessárias para configurar o escopo de observabilidade, peça ao administrador para conceder a você os seguintes papéis do IAM:

    Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

    Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

Configurar o escopo de observabilidade

O escopo de observabilidade controla como as páginas do explorador e do painel procuram os dados a serem exibidos. Cada projeto do Google Cloud contém um único escopo de observabilidade. Não é possível configurar diretamente o escopo de observabilidade de um projeto. Em vez disso, para seu projeto, configure o seguinte:

  • O escopo de registro padrão

    Configure esse escopo para que, quando você abrir a página Logs Explorer ou visualizar os painéis, os dados de registro do aplicativo sejam exibidos. Verifique se esse escopo lista os projetos e as visualizações de registro que armazenam os dados de registro do seu aplicativo.

  • Escopo de métricas

    Configure esse escopo para que seus gráficos, por exemplo, aqueles que você cria usando a página Metrics Explorer, e as políticas de alerta possam mostrar ou monitorar os dados de métrica do seu aplicativo. Verifique se esse escopo lista os projetos que armazenam os dados de métrica do aplicativo.

  • O escopo de rastreamento padrão

    Configure esse escopo para que, quando você abrir a página Trace Explorer, os dados de trace do aplicativo sejam exibidos. Verifique se esse escopo lista os projetos que armazenam os dados de rastreamento do aplicativo.

O restante desta seção fornece orientações sobre como configurar esses escopos.

Configurar e definir o escopo de registro padrão

Escolha uma destas opções:

  • Se você tiver um coletor agregado no nível da organização que encaminha todos os dados de registro da organização para um bucket de registro centralizado, recomendamos o seguinte:

    1. Crie uma visualização de registro no bucket de registro centralizado para os registros do aplicativo.

    2. No projeto host do App Hub ou no projeto de gerenciamento da pasta ativada para o app, crie um escopo de registro, adicione a visualização de registro e defina esse escopo como o escopo de registro padrão.

  • Se você estiver usando uma pasta ativada por app e não tiver um coletor agregado no nível da organização ou pastas aninhadas, recomendamos o seguinte:

    1. Crie um coletor agregado de interceptação para a pasta com o app ativado e direcione esses registros para o bucket de registro _Default do projeto em que você vai acessar os registros.

    2. No projeto de gerenciamento da pasta ativada pelo app, verifique se o escopo de registro chamado _Default está definido como o escopo de registro padrão. O escopo chamado _Default lista a visualização _AllLogs no bucket de registros _Default do projeto, que é o local de armazenamento centralizado do aplicativo.

  • Se você não estiver usando um coletor agregado, configure o escopo de registro padrão para listar os locais de armazenamento dos dados de registro do aplicativo no projeto host do App Hub ou no projeto de gerenciamento da pasta ativada para o app. Em vez de adicionar projetos ao seu escopo de registro, recomendamos que você adicione visualizações de registro nos buckets de registro que armazenam seus dados de registro.

Configurar o escopo das métricas

Verifique se o escopo de métricas do projeto host do App Hub ou do projeto de gerenciamento da sua pasta ativada para apps lista todos os projetos que armazenam os dados de métricas do aplicativo:

  • Para pastas ativadas por apps, a Google Cloud Observability tenta sincronizar a lista de projetos na pasta ativada por apps com a lista de projetos no escopo das métricas. Por exemplo, se você adicionar um projeto à pasta ativada pelo app, um comando será emitido para adicionar esse projeto ao escopo de métricas.

    Quando o número de projetos na pasta ativada pelo app não exceder a cota de escopo de métricas, que é padrão de 375 projetos por escopo de métricas, a Observabilidade do Google Cloud poderá manter a lista de projetos no escopo de métricas sincronizada com a lista de projetos na pasta ativada pelo app. Por exemplo, suponha que a cota seja de 375 projetos por escopo de métricas. Se a pasta ativada para o app tiver 100 projetos, o escopo das métricas vai listar todos os projetos na pasta ativada para o app. Se você adicionar projetos à pasta ativada pelo app, eles também serão adicionados ao escopo de métricas.

    Quando o número de projetos na pasta ativada pelo app excede a cota de escopo de métricas, a lista de projetos no escopo de métricas não inclui todos os projetos na pasta ativada pelo app. Por exemplo, suponha que a cota seja de 375 projetos por escopo de métricas e que a pasta ativada pelo app contenha 380 projetos. Depois que 375 projetos são adicionados ao escopo de métricas, a cota é esgotada e as tentativas de adicionar os cinco projetos restantes falham. Como resultado, alguns dados do aplicativo não estão disponíveis para seu projeto de gerenciamento.

    Recomendamos que você analise o uso da cota do escopo de métricas e determine se precisa solicitar uma atualização de cota ou modificar manualmente o escopo de métricas. Para informações sobre essas etapas, consulte Escopos de métricas para pastas ativadas por apps.

  • Para projetos host do App Hub, é necessário configurar o escopo de métricas do projeto host.

    Se você mudar o conjunto de projetos que armazenam seus dados de métricas, também será necessário atualizar o escopo de métricas do projeto host.

Configurar e definir o escopo de rastreamento padrão

Faça o seguinte:

  1. No projeto host do App Hub ou no projeto de gerenciamento da pasta ativada para o app, crie um escopo de rastreamento e adicione os projetos que armazenam os dados de rastreamento do aplicativo. Se você estiver usando uma pasta com app ativado, adicione os projetos nessa pasta.

  2. Defina o escopo do trace personalizado como o escopo padrão.

Associar uma política de alertas a um aplicativo do App Hub

Para conferir suas políticas de alerta no contexto do monitoramento de aplicativos, é necessário associá-las a um serviço ou carga de trabalho adicionando rótulos específicos do aplicativo à política de alerta. Esses rótulos definidos pelo usuário também são incluídos em todos os incidentes criados para uma política. Para saber mais sobre rótulos, consulte Anexar rótulos a incidentes. Para uma lista de rótulos do App Hub, consulte Acessar a telemetria do aplicativo.

Para associar uma política de alerta a uma carga de trabalho ou serviço usando o console do Google Cloud, faça o seguinte:

  1. No console do Google Cloud, acesse a página  Alertas:

    Acessar Alertas

    Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.

  2. Na barra de ferramentas do console do Google Cloud, selecione o projeto host do App Hub ou o projeto de gerenciamento da sua pasta ativada por app.
  3. Encontre a política de alertas, clique em Ver mais, selecione Editar e acesse a seção Notificações e nome.
  4. Na seção Marcadores do aplicativo, selecione seu aplicativo e depois a carga de trabalho ou o serviço.
  5. Clique em Salvar política.

Depois de concluir essas etapas, rótulos com as seguintes chaves serão anexados à sua política de alertas. Esses rótulos identificam seu aplicativo e seu serviço ou carga de trabalho:

  • apphub_application_location
  • apphub_application_id
  • apphub_service_id ou apphub_workload_id

Também é possível adicionar rótulos de usuário a uma política de alertas usando a CLI do Google Cloud, o Terraform ou a API Cloud Monitoring. No entanto, você precisa usar as chaves de rótulo mostradas no exemplo anterior. Para ver mais informações, consulte os seguintes tópicos:

Conceder acesso

O IAM gerencia o acesso aos seus dados de registro, métrica e rastreamento. Esta seção resume os papéis que você pode conceder a participantes:

  • Logs View Accessor (roles/logging.viewAccessor) nas visualizações de registro listadas no escopo de registro padrão do projeto de host do App Hub ou no projeto de gerenciamento da pasta ativada para o app. Para saber mais sobre como conceder acesso a uma visualização de registro, consulte Controlar o acesso a uma visualização de registro.

  • Visualizador de registros (roles/logging.viewer) no projeto host do App Hub ou no projeto de gerenciamento da pasta ativada pelo app e em todos os outros projetos listados no escopo de registro padrão. Esse papel concede acesso à maioria das entradas de registro no bucket de registro _Default. Para mais informações, consulte Papéis de registro.

  • O papel de Editor do Monitoring (roles/monitoring.editor) no projeto host do App Hub ou no projeto de gerenciamento da sua pasta com apps. Para os principais que não precisam criar políticas de alerta, conceda o papel de Leitor do Monitoring (roles/monitoring.viewer).

  • Usuário do Cloud Trace (roles/cloudtrace.user) no projeto host do App Hub ou no projeto de gerenciamento da sua pasta ativada pelo app e nos projetos listados no escopo de rastreamento padrão.

  • Leitor do App Hub (roles/apphub.view) no projeto host do App Hub ou no projeto de gerenciamento da pasta com suporte a apps.

A seguir