Gravar e consultar entradas de registros com a gcloud CLI

Gravar entradas de registro usando a CLI gcloud

A geração de registros aceita entradas de registro com dados estruturados e não estruturados. Os dados estruturados consistem em uma estrutura de dados JSON (por exemplo, {"weather": "partly cloudy"}). Os dados não estruturados são uma string de caracteres (por exemplo, "A simple entry").

Nas próximas etapas, você usará a CLI gcloud para gravar uma entrada de registro com dados não estruturados e uma entrada de registro com dados estruturados. A CLI gcloud fornece uma interface de linha de comando para a API Cloud Logging.

1. Grave uma entrada de registro com dados não estruturados no registro my-test-log e execute o comando gcloud logging write:

   gcloud logging write my-test-log "A simple entry."
   

   Depois que o comando for concluído, você verá a mensagem: Created log entry.

2. Grave uma entrada de registro com dados estruturados no registro my-test-log:

   gcloud logging write --payload-type=json my-test-log '{ "message": "My second entry", "weather": "partly cloudy"}'
   

   Ao gravar uma entrada de registro com dados estruturados, é preciso incluir --payload-type=json. Se você omitir esse campo, o Logging vai interpretar o payload como dados não estruturados.

Se my-test-log não existir, o Logging criará o registro quando a entrada for recebida.

Listar entradas de registro usando a CLI gcloud

É possível recuperar entradas de registro do Logging e exibi-las usando a CLI gcloud. Por exemplo, para recuperar e exibir as entradas de registro com o tipo de recurso global, execute o seguinte comando:

gcloud logging read "resource.type=global"

O comando retorna um resultado semelhante ao seguinte:

---
insertId: jpj9zjf73t1mn
jsonPayload:
  message: My second entry
  weather: partly cloudy
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:31.114507977Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
timestamp: '2018-11-01T18:39:31.114507977Z'
---
insertId: vd4m1if7h7u1a
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:19.718100792Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
textPayload: A simple entry
timestamp: '2018-11-01T18:39:19.718100792Z'

Para informações sobre como ler registros, consulte a documentação de referência gcloud logging read.

Ver entradas de registro no Explorador de registros

Para ver entradas de registro no Cloud de Confiance console, use a Análise de registros. A maioria dos projetos do Cloud de Confiance armazena um grande número de registros. É possível selecionar determinadas entradas de registro escrevendo uma consulta.

Para ver as entradas de registro que você escreveu usando a Análise de registros, faça o seguinte:

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

   Acessar a Análise de registros

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

   Verifique se o projeto Cloud de Confiance está selecionado na barra de navegação Cloud de Confiance by S3NS. Se necessário, use a lista suspensa do projeto Cloud de Confiance para selecionar seu projeto Cloud de Confiance .

2. No menu Recurso, selecione Global.

   Se a opção de menu Global ou as entradas de registro não forem exibidas, aguarde alguns minutos e atualize a página. Pode demorar alguns minutos para o Logging receber entradas de registro.

3. Para ver os detalhes de uma entrada de registro, clique no chevron_right Menu.

   A primeira entrada de registro tem os dados armazenados em textPayload. A segunda entrada de registro contém dados estruturados armazenados em jsonPayload. O payload estruturado contém as chaves message e weather.

Para informações sobre o formato de dados das entradas de registro, consulte o tipo LogEntry.

Consultar entradas de registro no Explorador de registros

É possível consultar entradas de registro usando o editor de consultas e, com registros estruturados, pela chave e pelo valor. Por exemplo, para mostrar todas as entradas de registro que contêm o texto simple, faça o seguinte:

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

   Acessar a Análise de registros

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

2. No menu Recurso, selecione Global.

3. No editor de consultas, insira a string simple entre aspas. Apenas a entrada de registro A simple entry. será exibida.

4. Depois de ver o registro, remova a string de consulta adicionada e clique em Executar consulta. As entradas de registro são reexibidas na tela.

Para mostrar todas as entradas de registro com dados estruturados que tenham uma chave weather em que o campo value contém partly, faça o seguinte:

1. O editor de consultas contém a linha resource.type="global". Digite este comando:

   jsonPayload.weather:partly
   

2. Clique em Executar consulta. O resultado é a única entrada de registro My second entry.

O Explorador de registros também oferece consultas salvas, sugeridas e recentes. Para mais informações sobre consultas, acesse Criar consultas no Explorador de registros.

Para ver exemplos de consultas, veja Amostra de consultas usando o Explorador de registros.

Solução de problemas

• Os erros tipográficos e os nomes de campos desconhecidos resultam em comandos da CLI gcloud preenchidos com mensagens de argumento inválido. Por exemplo, se você esquecer o ponto em resource.type, o resultado será o erro:

   ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.
  

• Quando o Cloud Logging não tiver recebido as permissões de acesso necessárias, os comandos da CLI gcloud vão resultar em mensagens de permissão negada. Por exemplo, se uma instância de VM do Compute Engine estiver configurada com as configurações padrão da API, o comando list resultará em um erro de permissão negada:

   ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.
  

  Para corrigir essa condição, modifique as permissões da instância de VM do Compute Engine para conceder permissão de leitura ao Cloud Logging da seguinte forma:

  1. Acesse a página Detalhes da instância de VM. Clique em Interromper. Essa ação pode levar um ou dois minutos para ser concluída.
  2. Para modificar a configuração, clique em Editar.
  3. Procure o cabeçalho Escopos de acesso da API Cloud e clique em Detalhes para exibir as configurações de cada API. Altere a entrada da API Cloud Logging para Total. Clique em Salvar.
  4. Para reiniciar a instância de VM, clique em Iniciar. Depois de alguns momentos, sua VM estará pronta para uso.