Gravar e consultar entradas de registro usando um script Python

Primeiros passos

Use o ambiente do Cloud Shell ou um ambiente Linux genérico para concluir este guia de início rápido. O Python está pré-instalado no Cloud Shell.

Clonar fonte

Para configurar o Cloud Shell neste guia de início rápido, faça o seguinte:

1. Clone o projeto python-logging do GitHub:

     git clone https://github.com/googleapis/python-logging
   

   O diretório samples/snippets contém os dois scripts usados neste guia de início rápido:

   • snippets.py permite que você gerencie as entradas em um registro.
   • export.py permite que você gerencie as exportações de registros.

2. Altere para o diretório snippets:

     cd python-logging/samples/snippets
   

Gravar entradas de registro

O script snippets.py usa as bibliotecas de cliente em Python para gravar entradas de registro no Logging. Quando a opção write for especificada na linha de comando, o script gravará as seguintes entradas de registro:

• Uma entrada com dados não estruturados e nenhum nível de gravidade especificado.
• Uma entrada com dados não estruturados e um nível de gravidade de ERROR.
• Uma entrada com dados estruturados em JSON e nenhum nível de gravidade especificado.

Para gravar novas entradas de registro no registro my-log, execute o script snippets.py com a opção write:

python snippets.py my-log write

Exibir entradas de registro

Para visualizar as entradas de registro no Cloud Shell, execute o script snippets.py com a opção list:

python snippets.py my-log list

O comando é concluído com o resultado:

    Listing entries for logger my-log:
    * 2018-11-15T16:05:35.548471+00:00: Hello, world!
    * 2018-11-15T16:05:35.647190+00:00: Goodbye, world!
    * 2018-11-15T16:05:35.726315+00:00: {u'favorite_color': u'Blue', u'quest': u'Find the Holy Grail', u'name': u'King Arthur'}

Se o resultado não mostrar entradas, tente o comando novamente. Demora alguns momentos para o Logging receber e processar entradas de registro.

Também é possível ver suas entradas de registro usando o Explorador de registros. Para mais Para mais detalhes, consulte Ver registros usando a Análise de registros.

Excluir entradas de registro

Para excluir todas as entradas de registro no my-log, execute o script snippets.py com a opção delete:

python snippets.py my-log delete

O comando é concluído com o resultado:

Deleted all logging entries for my-log

Encaminhar registros

Nesta seção, você realizará as ações a seguir:

• Criar um bucket do Cloud Storage como o destino dos seus dados.
• Criar um coletor que copie novas entradas de registro para o destino.
• Atualizar as permissões do seu bucket do Cloud Storage.
• Gravar entradas de registro no Logging.
• Como opção, verificar o conteúdo do seu bucket do Cloud Storage.

Criar destino

O destino de exportação para este guia de início rápido é um bucket do Cloud Storage. Para criar um bucket do Cloud Storage, siga estas etapas:

1. No console do Google Cloud, acesse a página Buckets:

   Acessar Buckets

   Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado cujo subtítulo é Cloud Storage:

2. Clique em Criar bucket.
3. Digite um nome para o bucket.
4. Em Tipo de local, selecione Região, que seleciona um local de bucket com a menor latência.
5. Em Classe de armazenamento padrão, selecione Padrão.
6. Em Controle de acesso, selecione Detalhado.
7. Em Ferramentas de proteção, selecione Nenhum e clique em Criar.

O nome de bucket do Cloud Storage deste guia de início rápido é myloggingproject-1.

Criar coletor

Um coletor é uma regra que determina se o Logging encaminha uma entrada de registro recém-chegada para um destino. Um coletor tem três atributos:

• Nome
• Destino
• Filtro

Para mais informações sobre coletores, consulte Coletores.

Se uma entrada de registro recente atender às condições da consulta, ela será encaminhada para o destino.

O script export.py usa as bibliotecas de cliente em Python para criar, listar, modificar e excluir coletores. Para criar o coletor mysink que exporta todas as entradas de registro com gravidade de pelo menos INFO para o bucket myloggingproject-1 do Cloud Storage, execute o seguinte comando:

python export.py create mysink myloggingproject-1 "severity>=INFO"

Para visualizar os coletores, execute o script export.py com a opção list:

python export.py list

O script retorna o resultado a seguir:

    mysink: severity>=INFO -> storage.googleapis.com/myloggingproject-1

Atualizar permissões de destino

As permissões do destino, neste caso o bucket do Cloud Storage, não são modificadas quando você cria um coletor usando o script export.py. Altere as configurações de permissão do bucket do Cloud Storage para conceder permissão de gravação ao coletor. Para informações sobre contas de serviço, escopos de acesso e papéis do gerenciamento de identidade e acesso, consulte Contas de serviço.

Para atualizar as permissões no seu bucket do Cloud Storage:

1. Identifique a Identidade do gravador do seu coletor:

   1. No console do Google Cloud, acesse a página Roteador de registros:

      Acessar o roteador de registros

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

      Você verá uma tabela de resumo dos seus coletores.

   2. Encontre o coletor na tabela, selecione more_vert Menu e, em seguida, selecione Ver detalhes do coletor.

   3. Copie a identidade do gravador para a área de transferência.

2. No console do Google Cloud, acesse a página Buckets:

   Acessar Buckets

   Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado cujo subtítulo é Cloud Storage:

3. Para abrir a visualização detalhada, clique no nome do seu bucket.

4. Selecione Permissões e clique em Conceder acesso.

5. Cole a identidade do gravador na caixa Novos principais. Remova o Prefixo serviceAccount: do endereço de identidade do gravador.

6. Defina o Papel como Storage Object Creator e clique em Salvar.

Para mais informações, consulte Definir permissões de destino.

Validar o coletor

Para validar que seu coletor e o destino estão configurados corretamente, faça o seguinte:

1. Grave novas entradas de registro no registro my-log:

   python snippets.py my-log write
   

2. Veja o conteúdo do bucket do Cloud Storage:

   1. No console do Google Cloud, acesse a página Buckets:

      Acessar Buckets

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

   2. Para abrir a visualização detalhada, clique no nome do seu bucket. A vista detalhada lista as pastas que contêm dados. Se não houver dados no seu bucket, esta mensagem será exibida:

      There are no live objects in this bucket.

      Conforme descrito em Entradas de registro atrasadas, pode levar de 2 a 3 horas para que as primeiras entradas apareçam no destino ou antes de ser notificado sobre um erro de configuração.

      Depois que o bucket tiver recebido dados, a visualização detalhada mostrará um resultado semelhante a este:

      

   3. Os dados em cada pasta são organizados em uma série de pastas identificadas. A pasta do nível superior consiste no nome do registro, seguida pelo ano, mês e dia. Para acessar os dados que foram exportados pelo coletor, clique no nome da pasta my-log e continue clicando nas subpastas de ano, mês e dia até chegar a um arquivo que termine com json:

      

   4. O arquivo JSON contém as entradas de registro que foram exportadas para seu bucket do Cloud Storage. Clique no nome do arquivo JSON para ver o conteúdo dele. O conteúdo é semelhante a:

       {"insertId":"yf1cshfoivz48",
       "logName":"projects/loggingproject-222616/logs/my-log",
       "receiveTimestamp":"2018-11-15T23:06:14.738729911Z",
       "resource":{"labels":{"project_id":"loggingproject-222616"},"type":"global"},
       "severity":"ERROR",
       "textPayload":"Goodbye, world!",
       "timestamp":"2018-11-15T23:06:14.738729911Z"}
      

      Como o nível de gravidade de ERROR é maior que o nível de gravidade de INFO, a entrada de registro que contém a string "Goodbye, world!" é exportada para o destino do coletor. As outras entradas de registros gravadas não são exportadas para o destino porque o nível de gravidade foi configurado para o valor padrão, e o nível de gravidade padrão é menor que INFO.

Solução de problemas

Um bucket do Cloud Storage pode estar vazio por vários motivos:

• O bucket não recebeu dados. Pode levar de 2 a 3 horas para que as primeiras entradas apareçam no destino ou antes de você ser notificado sobre um erro de configuração. Para mais informações, consulte Entradas de registro tardias.

• Ocorreu um erro de configuração. Nesse caso, você receberá uma mensagem de e-mail parecida com a seguinte linha de assunto:

   [ACTION REQUIRED] Logging export config error in myloggingproject.

  O conteúdo do corpo do e-mail descreve o problema de configuração. Por exemplo, se você não atualizar as permissões de destino, o e-mail listará o seguinte código de erro:

   bucket_permission_denied

  Para corrigir essa condição específica, consulte Atualize as permissões de destino nesta página.

• Nenhuma entrada de registro foi gravada após a criação do coletor. O coletor é aplicado apenas a entradas de registro recentes. Para corrigir esta situação, grave novas entradas de registro:

   python snippets.py my-log write