Configurar o monitoramento de aplicativos

Este documento descreve como configurar o Google Cloud Observability para que você possa ver a telemetria de um aplicativo registrado no App Hub. Você pode implantar o aplicativo e registrá-lo no App Hub ou implantar os aplicativos usando a Central de design de aplicativos. O Application Monitoring ajuda 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 habilitadas para apps. 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 necessários do IAM dependem de você planejar criar um coletor agregado, que permite centralizar o armazenamento de dados de registros.

    Configurar o coletor e os escopos

    Para receber as permissões necessárias para configurar escopos de observabilidade e criar um coletor de registros 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 pesquisam os dados a serem mostrados. Cada projeto 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, configure o seguinte para seu projeto:

  • O escopo de registro padrão

    Configure esse escopo para que, ao abrir a página Análise de registros ou visualizar dashboards, os dados de registro do seu aplicativo sejam mostrados. Verifique se esse escopo lista os projetos e as visualizações de registros que armazenam os dados de registro do seu aplicativo.

  • O escopo de métricas

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

  • O escopo de rastreamento padrão

    Configure esse escopo para que, ao abrir a página Buscador de trace, os dados de trace do seu 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 roteia todos os dados de registro da sua organização para um bucket de registros centralizado, recomendamos o seguinte:

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

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

  • Se você estiver usando uma pasta ativada para apps 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 sua pasta habilitada para gerenciar apps e direcione esses registros para o bucket de registros _Default do projeto de gerenciamento.

    2. No projeto de gerenciamento da pasta ativada para apps, 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 seu 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 em que o app está ativado. Recomendamos adicionar visualizações de registros aos buckets que armazenam seus dados de registro.

Por exemplo, suponha que você tenha configurado uma pasta ativada para apps e não esteja usando um gravador agregado. Em seguida, você pode fazer o seguinte:

  1. No projeto de gerenciamento, crie um escopo de registros.

  2. Adicione ao escopo de registros uma visualização de registros para cada projeto na pasta, incluindo o projeto de gerenciamento.

    A visualização adicionada é a _AllLogs no bucket de registros _Default do projeto. Essa visualização inclui todos os registros no bucket de registros _Default, que armazena os dados de registro do aplicativo._Default

    Depois de concluir essa etapa, o escopo do registro poderá ter entradas como:

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

  3. Você salva e define o escopo de registro como o padrão.

Configurar o escopo de métricas

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

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

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

    Quando o número de projetos na pasta ativada para apps excede a cota do escopo de métricas, a lista de projetos no escopo não inclui todos os projetos na pasta ativada para apps. Por exemplo, suponha que a cota seja de 375 projetos por escopo de métricas e que sua pasta ativada para apps 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 de aplicativos não estão disponíveis para seu projeto de gerenciamento.

    Recomendamos que você analise seu uso da cota de escopo de métricas e determine se é necessário solicitar uma atualização ou modificar manualmente o escopo. Para informações sobre essas etapas, consulte Escopos de métricas para pastas habilitadas para 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 os 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 por app, crie um escopo de rastreamento e adicione os projetos que armazenam os dados de rastreamento do aplicativo. Se você estiver usando uma pasta habilitada para apps, adicione os projetos nela.

  2. Defina seu escopo de rastreamento personalizado como o padrão.

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

Para ver suas políticas de alerta no contexto do Application Monitoring, associe-as a um serviço ou carga de trabalho adicionando rótulos específicos do aplicativo à política de alertas. 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 Classificar incidentes com rótulos. Para uma lista de rótulos do App Hub, consulte Acessar a telemetria de aplicativo.

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

  1. No console 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 Monitoring.

  2. Na barra de ferramentas do consoleGoogle Cloud , selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta habilitada para apps.
  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 de aplicativo, selecione seu aplicativo e depois selecione sua carga de trabalho ou serviço.
  5. Clique em Salvar política.

Depois de concluir essas etapas, os 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 identificadores definidos pelo usuário a uma política de alertas usando a Google Cloud CLI, 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 registros, métricas e rastreamentos. Esta seção resume os papéis que você pode querer conceder aos principais:

  • Acessador da visualização de registros (roles/logging.viewAccessor) nas visualizações de registros listadas no escopo de registros padrão do projeto host do App Hub ou no projeto de gerenciamento da sua pasta habilitada para gerenciar apps. 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 para apps e em qualquer outro projeto listado no escopo de registros padrão. Essa função concede acesso à maioria das entradas de registro no bucket de registros do _Default. Para mais informações, consulte Papéis do Logging.

  • Papel Editor do Monitoring (roles/monitoring.editor) no projeto host do App Hub ou no projeto de gerenciamento da pasta habilitada para apps. Para principais que não precisam criar políticas de alertas, considere conceder o papel de Leitor do Monitoring (roles/monitoring.viewer).

  • Usuário do Cloud Trace (roles/cloudtrace.user) no projeto de host do App Hub ou no projeto de gerenciamento da pasta ativada para apps 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 ativada para apps.

A seguir