Conferir a telemetria do aplicativo

Este documento descreve como visualizar os painéis prontos para uso (OOTB) para seus aplicativos, serviços e cargas de trabalho do App Hub. Esses painéis podem ajudar a entender como os recursos do aplicativo estão funcionando e a diagnosticar problemas.

A telemetria mostrada nesses painéis OOTB inclui dados de registro e métricas, além de informações sobre incidentes abertos. Os painéis de aplicativos fornecem informações como localização, criticidade e proprietários. Os painéis de serviço e carga de trabalho incluem informações sobre o App Hub e os tipos de infraestrutura.

Rótulos específicos do aplicativo

Os rótulos específicos do App Hub permitem que a Observabilidade do Google Cloud construa a hierarquia dos painéis OOTB e filtre a telemetria mostrada para um serviço ou carga de trabalho. Também é possível usar esses rótulos para filtrar os dados de registro e métrica.

Os rótulos específicos do aplicativo são anexados aos dados de registro e métricas quando o aplicativo registrado é executado em serviços e cargas de trabalho com suporte ao monitoramento de aplicativos. Em algumas configurações do Google Cloud Managed Service para Prometheus, os rótulos do aplicativo também são anexados aos dados de métrica do Prometheus.

Rótulos de registro

As entradas de registro contêm um campo apphub que lista os rótulos do aplicativo e de um serviço ou carga de trabalho. O formato dos dados é ilustrado a seguir:

apphub: {
  application: {
    id: "my-app"
    location: "my-app-location"
  }
  workload: {
    criticalityType: "MEDIUM"
    environmentType: "STAGING"
    id: "my-workload-id"
  }
}

Rótulos de métrica

Esta seção descreve como os rótulos específicos do aplicativo são anexados a dados de métricas gerados por recursos Google Cloud e a métricas do Prometheus ingeridas usando o Google Cloud Managed Service para Prometheus. No exemplo a seguir, interprete a.b.{x,y} como a.b.x e a.b.y.

Os seguintes rótulos do App Hub são anexados a dados de métricas dos recursos Google Cloud usados pelo seu app:

  • metadata.system_labels.apphub_application_{container,id,location}
  • metadata.system_labels.apphub_{workload,service}_{criticality_type,environment_type,id}

Os rótulos de aplicativos do App Hub são anexados às métricas do Google Cloud Managed Service para Prometheus quando uma das seguintes condições é verdadeira:

  • Uma carga de trabalho está sendo executada em um cluster do Google Kubernetes Engine com a versão 1.30 ou mais recente, e o tipo de controlador da carga de trabalho é uma das seguintes opções:

    • apps.k8s.io/{Deployment,StatefulSet,DaemonSet}
    • batch.k8s.io/CronJob

  • Quando você usa o OpenTelemetry no Cloud Run.

  • Quando você usa o OpenTelemetry no Google Kubernetes Engine e segue as orientações de ingestão do OTLP Kubernetes.

O serviço gerenciado para Prometheus usa a API App Hub para determinar se um aplicativo do App Hub existe. Quando um aplicativo é encontrado, os seguintes rótulos específicos do aplicativo são adicionados aos dados de rastreamento:

  • metric.labels.apphub_application_{container,id,location}
  • metric.labels.apphub_workload_{criticality_type,environment_type,id}

Rótulos da política de alertas

Os rótulos de serviço e de carga de trabalho não são anexados automaticamente às políticas de alerta. No entanto, é possível associar uma política de alertas a uma carga de trabalho ou serviço específico anexando todos os rótulos a seguir com as seguintes chaves à política de alertas:

  • apphub_application_location
  • apphub_application_id
  • apphub_service_id ou apphub_workload_id

Quando uma política de alertas inclui as chaves anteriores, os incidentes dela são mostrados nos painéis OOTB.

Para mais informações, consulte Associar uma política de alerta a um serviço ou carga de trabalho.

O console do Google Cloud redefine automaticamente o seletor de recursos de uma pasta ativada pelo app para o projeto de gerenciamento da pasta quando uma página de Observabilidade do Google Cloud é aberta.

O Cloud Logging oferece suporte a pastas como um recurso. Por exemplo, é possível criar sinks de registro e buckets de registro em um recurso de pasta. Da mesma forma, as pastas contêm buckets de registro _Default e _Required, e talvez você queira conferir o conteúdo delas. Para acessar o recurso de pasta, use o seletor de recursos e selecione manualmente a pasta ativada para o app.

Antes de começar

Antes de usar o monitoramento de aplicativos, configure o projeto host do App Hub ou o projeto de gerenciamento da pasta ativada por apps. Esse é o projeto que você usa para conferir os dados de telemetria do aplicativo:

  • Para ter as permissões necessárias para conferir dados de registro e métricas, criar políticas de alerta e personalizar painéis, peça ao administrador para conceder a você os seguintes papéis do IAM:

    • Leitor de registros (roles/logging.viewer) no projeto host do App Hub ou no projeto de gerenciamento da pasta ativada para o 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.
    • Logs View Accessor (roles/logging.viewAccessor) nas visualizações de registro listadas no escopo de registro padrão do seu projeto de host do App Hub ou no projeto de gerenciamento da sua pasta habilitada para apps. Para saber mais sobre como conceder acesso a uma visualização de registro, consulte Controlar o acesso a uma visualização de registro.
    • Editor do Monitoring (roles/monitoring.editor) no projeto de host do App Hub ou no projeto de gerenciamento da pasta ativada para apps. Para diretores que não precisam criar ou modificar políticas de alertas ou painéis, conceda o papel de Leitor do Monitoring (roles/monitoring.viewer).
    • Visualizador do App Hub no projeto host do App Hub ou no projeto de gerenciamento da pasta para gerenciar apps. Para mais informações, consulte Papéis e permissões do App Hub.

    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.

  • Verifique se você configurou o escopo de observabilidade do seu projeto de host do App Hub ou o projeto de gerenciamento da sua pasta ativada para gerenciar apps. Para mais informações, consulte Configurar o monitoramento de aplicativos.

    O escopo de observabilidade controla quais dados estão disponíveis para o projeto de host do App Hub ou o projeto de gerenciamento da pasta habilitada para gerenciar apps. As configurações padrão desses escopos podem não permitir que você acesse todos os dados de registro ou métricas.

  • Atualize as políticas de alerta que monitoram os dados do aplicativo para incluir rótulos específicos do aplicativo. Para mais informações, consulte Associar uma política de alerta a um serviço ou carga de trabalho.

Conferir o resumo de todos os aplicativos

O painel OOTB de nível superior fornece um resumo conciso do estado dos aplicativos registrados. Para cada aplicativo, a página lista o número de incidentes abertos e informações sobre o local, a gravidade e o ambiente.

Para abrir o painel OOTB de nível superior, que lista informações resumidas dos apps registrados no App Hub, faça o seguinte:

  1. No console do Google Cloud, acesse a página Monitoramento de aplicativos:

    Acessar Monitoramento de aplicativos

    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 pasta habilitada para gerenciamento de apps.

  3. Opcional: para abrir um aplicativo no App Hub, clique em Mais e selecione Gerenciar no AppHub.

  4. Para abrir o painel OOTB de um aplicativo, selecione-o. A próxima seção fornece orientações sobre como analisar ou interpretar a telemetria.

Analisar a telemetria e os incidentes do aplicativo

Quando você seleciona um aplicativo listado na página Monitoramento de aplicativos, o painel OOTB de nível superior para o aplicativo é aberto. Esse painel ajuda você a entender a integridade do seu aplicativo, resumindo o número de incidentes abertos e listando os valores de vários indicadores de ouro. Por exemplo, se essa página mostrar falhas generalizadas, isso poderá indicar que a origem da falha é a infraestrutura, e não o aplicativo.

Para abrir o painel OOTB de um aplicativo, faça o seguinte:

  1. No console do Google Cloud, acesse a página Monitoramento de aplicativos:

    Acessar Monitoramento de aplicativos

    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 pasta habilitada para gerenciamento de apps.

  3. Na página Monitoramento de aplicativos, selecione o nome de um aplicativo.

    O painel OOTB do aplicativo é aberto com a guia Visão geral selecionada. Essa guia lista cada serviço e carga de trabalho, além do número de incidentes abertos e valores para as golden signals:

    • Tráfego: taxas de solicitações de entrada no serviço ou na carga de trabalho no período selecionado.
    • Taxa de erros do servidor: porcentagem média de solicitações recebidas que geram ou mapeiam para códigos de resposta HTTP 5xx no período selecionado.
    • Latência P95: 95º percentil de latência de uma solicitação atendida no período selecionado, em milissegundos.
    • Saturação: mede o quanto seu serviço ou carga de trabalho está cheio. Por exemplo, para grupos de instâncias gerenciadas (MIGs), implantações do Cloud Run e do Google Kubernetes Engine, esse campo mostra a utilização da CPU.

    Na guia Visão geral, você pode fazer o seguinte:

    • Redefina o período. Quando você abre o painel, o período é definido como a hora mais recente.
    • Confira informações sobre o aplicativo, como operador, desenvolvedor e proprietários de empresas.
    • Abra o aplicativo, um serviço ou uma carga de trabalho no App Hub.
    • Abra o painel de um serviço ou carga de trabalho.

  4. Para conferir a telemetria do aplicativo e informações sobre incidentes abertos, selecione a guia Painel.

    A guia Painel mostra informações sobre registros, métricas e incidentes. A guia está configurada para sobrepor anotações de eventos nos gráficos. As anotações podem ajudar a correlacionar dados de diferentes fontes ao resolver um problema. Para conferir quais anotações estão ativadas, clique em Anotações na barra de ferramentas.

    A guia também contém filtros, que podem ser usados para restringir os dados que são mostrados. Para mais informações sobre como analisar os dados mostrados nesta guia, consulte as seguintes seções deste documento:

Filtrar um painel

A guia Painel mostra dados de serviços e cargas de trabalho em um aplicativo. No entanto, é possível filtrar esse painel para um serviço específico ou para um conjunto de serviços.

Por exemplo, a barra de ferramentas na guia Painel contém um filtro como apphub_service_id: *. Se você quiser conferir dados de serviços específicos, clique em Menu e selecione os serviços na lista.

Analisar dados de registro

Se você estiver visualizando a guia Painel de um painel de aplicativo, os dados de registro serão mostrados na seção Registros do aplicativo. Caso contrário, seus dados serão mostrados na seção Registros.

As seções Application Logs e Logs de um painel mostram as entradas de registro que correspondem a um filtro e são armazenadas pelos recursos listados no escopo de registro padrão do projeto host do App Hub ou do projeto de gerenciamento da pasta ativada por apps. Para aplicativos, o filtro é semelhante ao seguinte:

-- Application logs
(apphub_application_location=global)
(apphub_application_id=my-app)

Para serviços e cargas de trabalho, o filtro contém cláusulas adicionais. Para conferir o filtro aplicado aos dados de registro, clique em Mostrar consulta.

Se você quiser escrever consultas, abra um menu suspenso ou a página Logs Explorer. Ambas as opções permitem que você escreva e execute consultas e mude o escopo. No entanto, o menu suspenso mantém seu contexto atual e permite salvar os resultados da análise em um painel personalizado:

  • Para abrir um menu suspenso, clique em Analisar dados.

    Quando a análise detalhada for concluída, clique em Cancelar para fechar o menu suspenso e descartar as mudanças. Se você quiser salvar as alterações em um painel personalizado, clique em Salvar no painel e preencha a caixa de diálogo. Não é possível salvar suas mudanças no painel que você estava visualizando quando abriu o menu suspenso.

    O menu suspenso não lista os filtros mostrados pelo botão Mostrar consulta. Esses filtros são aplicados no nível do painel e não podem ser removidos.

  • Para abrir a página Análise de registros em uma nova guia do navegador, clique em Ver no Explorador de registros.

    A consulta é pré-configurada para mostrar entradas de registro que correspondem a rótulos de aplicativo específicos e que estão no período especificado pelo painel. Quando você fecha a guia do navegador, suas alterações são descartadas.

Para mais informações sobre como analisar seus registros, consulte os seguintes documentos:

Acessar dados de métricas

Os gráficos e tabelas no painel mostram sinais de ouro e outros dados de métrica relevantes para os recursos usados pelo aplicativo, serviço ou carga de trabalho. Os dados exibidos podem ser armazenados em qualquer projeto listado pelo escopo de métricas do projeto host do App Hub ou do projeto de gerenciamento da pasta ativada para o app.

Em qualquer gráfico ou tabela que mostre dados de métricas, é possível conferir detalhes como o tipo de métrica e as opções de agregação. Para conferir essas informações, acesse a barra de ferramentas de um gráfico ou tabela e clique em Informações.

Para analisar um gráfico ou uma tabela com mais detalhes, abra um menu suspenso ou a página Metrics Explorer. Com as duas opções, você pode testar diferentes configurações de gráfico e salvar os resultados em um painel personalizado. No entanto, o menu suspenso mantém seu contexto atual:

  • Para abrir um menu suspenso, clique em Analisar dados.

    Quando a análise detalhada for concluída, clique em Cancelar para fechar o menu suspenso e descartar as mudanças. Se você quiser salvar as alterações em um painel personalizado, clique em Salvar no painel e preencha a caixa de diálogo. Não é possível salvar suas mudanças no painel que você estava visualizando quando abriu o menu suspenso.

  • Para conferir o gráfico ou a tabela no Metrics Explorer, acesse a barra de ferramentas, clique em Mais e selecione Ver no Metrics Explorer.

    Agora você tem um gráfico temporário que pode ser modificado e analisado. Por exemplo, você pode mudar as opções de agregação ou o estilo de exibição. Para salvar o gráfico em um painel personalizado, clique em Salvar no painel e preencha a caixa de diálogo.

Analisar incidentes

A seção Alerts dos painéis lista incidentes recentes de políticas de alerta associadas a um serviço ou carga de trabalho. Essas políticas de alerta precisam ser armazenadas no seu projeto host do App Hub ou no projeto de gerenciamento da pasta ativada por apps.

Se não houver entradas na seção Alerts, você não terá políticas de alerta associadas a um serviço ou carga de trabalho. Para criar essa associação, adicione rótulos à política. Para mais informações, consulte Associar uma política de alerta a um serviço ou carga de trabalho.

Para mais informações sobre incidentes e políticas de alertas, faça o seguinte:

  • Para conferir detalhes sobre a política de alertas que causou o incidente, clique no nome dela. O painel que é aberto mostra informações detalhadas sobre a política de alertas, incluindo um gráfico que mostra os dados monitorados e os rótulos.

  • Para conferir todas as políticas de alerta associadas ao aplicativo, acesse a barra de ferramentas e clique em Dados do Explorer. Uma janela pop-up é aberta com a lista de todas as políticas. Para voltar ao painel, clique em Cancelar.

Analisar a telemetria e os incidentes do serviço ou da carga de trabalho

Um painel OOTB é fornecido para cada serviço e carga de trabalho. Esses painéis mostram informações de registro, métrica e incidente e podem ajudar você a entender a integridade de um serviço ou carga de trabalho específico. É possível analisar os dados nesses painéis OOTB de maneira semelhante à análise dos dados mostrados na guia Painel de um aplicativo.

Para abrir o painel OOTB de um serviço ou carga de trabalho, faça o seguinte:

  1. No console do Google Cloud, acesse a página Monitoramento de aplicativos:

    Acessar Monitoramento de aplicativos

    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 pasta ativada para o app.

  3. Na página Monitoramento de aplicativos, selecione o nome de um aplicativo e um serviço ou carga de trabalho.

    Um painel mostra as informações de registro, métrica e incidente do serviço ou da carga de trabalho selecionada. Para cargas de trabalho, o painel é configurado para sobrepor anotações de eventos nos gráficos. As anotações podem ajudar a correlacionar dados de diferentes fontes ao resolver um problema. Para conferir quais anotações estão ativadas, clique em Anotações na barra de ferramentas.

    Para saber como analisar os dados em um painel de serviço ou de carga, consulte as seguintes seções deste documento:

Criar um painel personalizado

A Observability do Google Cloud oferece suporte à criação de painéis personalizados, que permitem que você tenha controle total sobre o conteúdo do painel. Os painéis personalizados são listados na página Painéis do console do Google Cloud e podem ser copiados, editados e excluídos. Elas também podem ser o destino em que você salva um widget de painel configurado. Por exemplo, se você estiver analisando um gráfico em um painel de aplicativo, poderá salvá-lo em um painel personalizado abrindo a barra de ferramentas e selecionando Salvar no painel.

Se você planeja criar um painel personalizado para um aplicativo, serviço ou carga de trabalho, as seguintes informações podem ser úteis:

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

Para associar uma política de alertas a um serviço ou carga de trabalho, adicione rótulos específicos do aplicativo à política de alertas. Quando você adiciona esses rótulos, eles são listados na política de alertas e incluídos em todos os incidentes. Para saber mais sobre rótulos, consulte Anexar rótulos a incidentes.

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 pasta ativada para o 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 identificadores 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:

Resolver problemas

Para informações que podem ajudar você a entender quais dados estão sendo mostrados ou por que um painel não exibe dados, consulte Resolver problemas de monitoramento de aplicativos.