Como gravar e ver registros

Nesta página, descrevemos os registros disponíveis para aplicativos do App Engine e como gravar e visualizar entradas de registro.

O App Engine coleta dois tipos de registros:

  • Registro de solicitação: um registro das solicitações enviadas para seu app. O App Engine cria entradas automaticamente no registro de solicitação.

  • Registro de apps: as entradas de registro que você grava em um framework ou arquivo compatível, conforme descrito nesta página.

O App Engine envia esses registros automaticamente para o agente do Cloud Logging. É possível visualizá-los no "Visualizador de registros", na linha de comando ou programaticamente.

Como gravar registros de apps

Para gravar entradas de registro, recomendamos que você integre o Logback appender padrão ou o java.util.logging ao Cloud Logging. Essa abordagem ativa todos os recursos do Cloud Logging e requer apenas algumas linhas de código específico do Google Cloud.

Para instruções e amostras de código, consulte Como configurar o Cloud Logging para Java.

Alternativa: como gravar registros estruturados em stdout e stderr

Em vez da abordagem recomendada, é possível enviar strings de texto simples para stdout e stderr. As strings aparecerão como mensagens no "Visualizador de registros", na linha de comando e na API Cloud Logging e serão associadas ao serviço do App Engine e à versão que as emitiu.

Se você quiser filtrar essas strings no "Visualizador de registros" por nível de gravidade, será necessário formatá-las como dados estruturados. Para mais informações, consulte Como gerar registros estruturados.

Se você quiser correlacionar entradas no registro de apps com o registro de solicitação, as entradas do registro de apps estruturadas precisarão conter o identificador de trace da solicitação. É possível extrair o identificador de trace do cabeçalho da solicitação X-Cloud-Trace-Context. Na entrada de registro estruturada, grave o ID em um campo chamado logging.googleapis.com/trace. Para mais informações sobre o cabeçalho X-Cloud-Trace-Context, consulte Como forçar uma solicitação a ser rastreada.

Veja um exemplo de gravação de entradas de registro estruturadas com um ID de trace na documentação do Cloud Run. É possível usar a mesma técnica nos aplicativos do App Engine.

Como visualizar registros

É possível visualizar o aplicativo e solicitar registros usando o Visualizador de registros:

  1. Acesse o Visualizador de registros no Console do Cloud:

    Acessar o "Visualizador de registros"

  2. Selecione um projeto atual do Google Cloud na parte superior da página.

  3. Nos menus suspensos, selecione o Aplicativo do GAE como o tipo de recurso.

  4. Para ver quais entradas do registro de apps estão relacionadas às entradas de registro de solicitação:

    1. Selecione o registro httpRequest.requestUrl no menu de seleção.

    2. Expanda uma entrada de registro de solicitação. Os registros de apps relacionados a essa solicitação aparecem aninhados na entrada de registro da solicitação.

    Se você enviar entradas de texto simples para a saída padrão, não será possível usar o "Visualizador de registros" para filtrar entradas de apps por gravidade, nem ver quais registros de apps correspondem a solicitações específicas. É possível continuar usando outros tipos de filtragem no "Visualizador de registros", como texto e carimbo de data/hora.

É possível filtrar o "Visualizador de registros" por serviço e versão do App Engine e outros critérios. Também é possível pesquisar nos registros por entradas específicas. Consulte os detalhes de Como visualizar os registros.

Como visualizar registros usando a linha de comando

Para visualizar os registros do App Engine na linha de comando, use o seguinte comando:

gcloud app logs tail

Para mais informações, consulte gcloud app logs tail.

Como ler registros de maneira programática

Se você quiser ler os registros de maneira programática, use um destes métodos:

Política de retenção de preços, cotas e registros

Para mais informações sobre os preços aplicáveis aos registros de solicitação e de apps, consulte preços do Cloud Logging.

Para ver a política de retenção de registros e o tamanho máximo das entradas de registro, consulte Cotas e limites. É possível exportar os registros para o Cloud Storage, se você quiser armazená-los por mais tempo. Além disso, é possível exportá-los para o BigQuery e Pub/Sub, se quiser processamento adicional.

Como gerenciar o uso de recursos de registro

É possível controlar a quantidade de atividade de geração de registros no seu app gravando mais ou menos entradas do código do seu app. Os registros de solicitação são criados automaticamente. Portanto, para gerenciar o número de entradas de registro de solicitação associadas ao app, use o recurso de exclusão de registros do Cloud Logging.

Problemas conhecidos

Às vezes, as entradas do registro de apps não são correlacionadas com o registro de solicitação. Isso acontece na primeira vez que seu app recebe uma solicitação e sempre que o App Engine grava mensagens de status no registro do seu app. Para mais informações, consulte https://issuetracker.google.com/issues/138365527 (em inglês).