Usar registros da plataforma

Esta página descreve como visualizar os registros da plataforma gerados pelo ambiente de execução do SaaS. Os registros da plataforma no Google Cloud são específicos do serviço, e você pode usá-los para depurar e resolver problemas, além de entender melhor os serviços do Google Cloudque está usando.

Para detalhes sobre os registros da plataforma do ambiente de execução do SaaS compatíveis, consulte Registros da plataforma doGoogle Cloud . Para mais informações sobre como entender os dados nas tabelas de registros da plataforma, consulte Estrutura de entrada de registro.

Antes de começar

  1. No console do Google Cloud , na página do seletor de projetos, selecione ou crie um projeto do Google Cloud .
  2. Verifique se o faturamento foi ativado para o projeto Google Cloud .
  3. Ative a API SaaS Runtime.
  4. Para receber as permissões necessárias para visualizar logs e criar alertas, peça ao administrador para conceder a você os seguintes papéis de Identity and Access Management (IAM) no seu projeto:
    • Visualizador de registros (roles/logging.viewer)
    • Editor do Monitoring (roles/monitoring.editor)

Criar alertas baseados em registros

Para criar um alerta com base em registros, crie uma consulta na Análise de registros que retorne as entradas de registro para as quais você quer receber alertas e configure a política de alertas.

  1. No console do Google Cloud , acesse a página Análise de registros.

    Acessar a Análise de registros

  2. No editor de consultas, insira uma consulta para filtrar as entradas de registro escolhidas. Consulte as seções a seguir para ver exemplos de consultas.

  3. Clique em Criar alerta.

  4. Insira um nome e uma descrição para a política de alertas.

  5. Configure os detalhes do alerta, incluindo canais de notificação.

  6. Clique em Salvar alerta.

Para instruções detalhadas, consulte Criar um alerta baseado em registro.

Exemplos de consultas para registros da plataforma

Nesta seção, apresentamos exemplos de consultas para cenários de alerta comuns com base nos registros da plataforma do tempo de execução do SaaS.

Alertas de operações de SaaS

Para criar um alerta quando uma operação de provisionamento de unidade falhar, use a consulta:

protoPayload.methodName="google.cloud.saasplatform.saasservicemgmt.v1beta1.SaasDeployments.CreateUnitOperation"
protoPayload.response.state="UNIT_OPERATION_STATE_FAILED"

Para criar um alerta quando uma operação de provisionamento de unidade atinge um estado terminal (concluída, falha ou cancelada), use a consulta:

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.UnitOperationLog"
AND (jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_SUCCEEDED" OR jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_FAILED" OR jsonPayload.unit_operation_state="UNIT_OPERATION_STATE_CANCELLED")
AND jsonPayload.unit_operation_type="PROVISION"

Alertas de lançamento

Para criar um alerta se um lançamento regional entrar em um estado PAUSED ou FAILED por um motivo diferente de uma ação do usuário, use a consulta:

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.RolloutLog"
AND (jsonPayload.current_state="PAUSED" OR jsonPayload.current_state="FAILED")
AND jsonPayload.reason!="USER_PAUSE"
AND jsonPayload.root_rollout_id != resource.labels.rollout_id

Para criar um alerta se um lançamento global entrar em um estado PAUSED ou FAILED, use a consulta:

jsonPayload.@type="type.googleapis.com/google.cloud.saasservicemgmt.logging.v1.RolloutLog"
AND (jsonPayload.current_state="PAUSED" OR jsonPayload.current_state="FAILED")
AND jsonPayload.root_rollout_id == resource.labels.rollout_id

Para criar um alerta de registro quando um lançamento entrar em um estado PAUSED (porque o SaaS Runtime identificou o lançamento como não íntegro) ou em um estado FAILED , use a consulta:

logName:"rollout_events" 
(jsonPayload.currentState="PAUSED" jsonPayload.reason="SYSTEM_PAUSE")
OR 
jsonPayload.currentState="FAILED

Para criar um alerta de registro para métricas de estado de lançamento quando um lançamento entra em um estado PAUSED (porque o SaaS Runtime identificou o lançamento como não íntegro) ou em um estado FAILED, use a consulta:

saasservicemgmt_googleapis_com:rollout_state
{state_name="PAUSED", reason="SYSTEM_PAUSE"}
OR
saasservicemgmt_googleapis_com:rollout_state{state_name="FAILED"}

A seguir