Monitorar fluxos de trabalho

O Google Cloud Observability oferece ferramentas de monitoramento, geração de registros e diagnóstico. Essas ferramentas podem ajudar a monitorar e analisar implantações e execuções de fluxos de trabalho, além de entender o comportamento, a integridade e o desempenho dos aplicativos.

Por padrão, o Workflows é configurado para fazer o seguinte:

  • Enviar dados e registros de auditoria do sistema para o Cloud Logging. Use os registros coletados para depurar, resolver problemas e ter insights sobre seus aplicativos.
  • Envie métricas de sistema e recursos para o Cloud Monitoring. É possível usar as métricas coletadas para monitorar a integridade e o desempenho, identificar tendências e problemas e notificar mudanças no comportamento.

Enviar registros de auditoria para o Cloud Logging

O Workflows envia os seguintes tipos de dados de registro de auditoria para o Cloud Logging:

Os registros de auditoria de acesso a dados estão desativados por padrão porque podem ser bem grandes. Para mais informações, consulte Ativar registros de auditoria de acesso a dados.

Para mais informações sobre registros de auditoria no Workflows, consulte:

Também é possível enviar registros de execução para o Cloud Logging.

Enviar métricas para o Cloud Monitoring

O Workflows envia dados de métricas de recursos monitorados para o Google Cloud Observability. Um recurso monitorado no Monitoring representa uma entidade lógica ou física, como uma máquina virtual, um banco de dados ou um aplicativo. Os recursos monitorados contêm um conjunto exclusivo de métricas que podem ser analisadas, exibidas em um painel ou usadas para criar alertas. Cada recurso também tem um conjunto de rótulos de recurso, que são pares de chave-valor com informações adicionais sobre o recurso. Os rótulos de recursos estão disponíveis para todas as métricas associadas ao recurso.

Para ver todos os tipos de recursos, consulte Tipos de recursos monitorados. Para conferir todos os tipos de métricas, consulte métricas doGoogle Cloud . Expanda o seguinte para ver uma lista dos tipos de métricas enviados do Workflows para o Google Cloud Observability:

Tipos de métricas do Workflows

Ler dados de métricas

É possível ler dados de métricas, também chamados de dados de série temporal, usando o método timeSeries.list na API Cloud Monitoring. Há várias maneiras de chamar o método, incluindo o uso de uma biblioteca de cliente específica da linguagem ou a criação de um gráfico com o Metrics Explorer.Também é possível testar o método timeSeries.list usando o APIs Explorer baseado em formulários. Para uma introdução às métricas e série temporal, consulte Métricas, série temporal e recursos. Para saber como ler os dados de métricas, consulte Recuperar dados de séries temporais.

Monitorar métricas de cota

O exemplo a seguir demonstra como usar o APIs Explorer para consultar a cota de alocação total consumida para o Workflows. Especificamente, ele usa a métrica serviceruntime.googleapis.com/quota/allocation/usage no tipo de recurso Consumer Quota. É possível definir outros filtros de rótulo (service, quota_metric) para especificar o tipo de cota. Para mais informações sobre como monitorar métricas de cota, incluindo outros exemplos e como criar políticas de alertas, consulte Gráfico e monitoramento de métricas de cota.

  1. Abra a página de referência de timeSeries.list.

  2. Se o painel Teste este método não estiver visível, clique em Teste!

  3. No campo name, insira o ID do projeto do Google Cloud usando o seguinte formato:

    projects/PROJECT_ID

  4. No campo filtro, especifique um único tipo de métrica e, se quiser, rótulos de métrica e outras informações. Exemplo:

    metric.type = "serviceruntime.googleapis.com/quota/allocation/usage" AND resource.labels.service = "workflowexecutions.googleapis.com"

  5. No campo interval.endTime, insira um horário de término para limitar a quantidade de dados retornados, o que é aplicável ao seu uso. Ele precisa ser formatado como uma string RFC 3339. Por exemplo, 2024-11-07T03:01:02Z.

  6. No campo interval.startTime, insira um horário de início para limitar a quantidade de dados retornados, que é aplicável ao seu uso. Ele precisa ser formatado como uma string RFC 3339, por exemplo, 2024-11-07T03:01:00Z.

  7. Clique em Executar.

    O resultado será semelhante ao seguinte, com 350 indicando a métrica de cota de execuções simultâneas.

    {
"timeSeries": [
   {
      "metric": {
      "labels": {
         "quota_metric": "workflowexecutions.googleapis.com/concurrency"
      },
      "type": "serviceruntime.googleapis.com/quota/allocation/usage"
      },
      "resource": {
      "type": "consumer_quota",
      "labels": {
         "service": "workflowexecutions.googleapis.com",
         "project_id": "PROJECT_ID",
         "location": "europe-west1"
      }
      },
      "metricKind": "GAUGE",
      "valueType": "INT64",
      "points": [
      {
         "interval": {
            "startTime": "2024-11-07T03:01:02Z",
            "endTime": "2024-11-07T03:01:02Z"
         },
         "value": {
            "int64Value": "350"
         }
      }
      ]
   }

  8. No painel lateral recolhido do APIs Explorer, clique em Tela cheia para expandir o APIs Explorer. O painel em tela cheia mostra um painel extra com exemplos de código, respostas do application/json e respostas HTTP brutas. Por exemplo, neste caso, é possível ver o comando curl comparável:

    curl \
'https://monitoring.googleapis.com/v3/projects/PROJECT_ID/timeSeries?filter=metric.type%20%3D%20%22serviceruntime.googleapis.com%2Fquota%2Fallocation%2Fusage%22%20AND%20resource.labels.service%20%3D%20%22workflowexecutions.googleapis.com%22&interval.endTime=2024-11-07T03%3A01%3A02Z&interval.startTime=2024-11-07T03%3A01%3A00Z&key=YOUR_API_KEY' \
   --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
   --header 'Accept: application/json' \
   --compressed

Usar painéis e alertas do Monitoring

É possível usar os painéis do Monitoring e os gráficos associados para visualizar os dados das métricas do Workflows.

Para monitorar essas métricas no Monitoring, crie painéis personalizados. Você também pode adicionar alertas com base nessas métricas.

A seguir