Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Envia parte dos logs para o Axiom via API, reduzindo o uso do dreno de logs da Vercel #1838

Merged
merged 1 commit into from
Jan 12, 2025

Conversation

aprendendofelipe
Copy link
Collaborator

Os logs gerados pela integração embutida entre a Vercel e o Axiom continuam sendo encaminhados via dreno de logs da Vercel. No entanto, os logs que criamos diretamente com logger.info ou logger.error agora serão enviados através da API do Axiom. Essa mudança visa reduzir os custos associados ao uso do dreno (alinhado com #1724).

Dependendo dos resultados obtidos, podemos considerar a substituição completa da integração atual pela API do Axiom no futuro.

Mudanças realizadas

  • Foi criada a biblioteca @tabnews/infra que, por enquanto, contém apenas o logger. Esse logger integra o pino com o Axiom e a Vercel, permitindo que os logs sejam enviados sem atrasar as respostas das requisições e sem correr o risco de as lambdas serem encerradas antes do envio completo dos logs.

  • A maneira de definir o ID da requisição foi ajustada para priorizar o cabeçalho x-vercel-id, facilitando o cruzamento de dados entre os logs enviados pelos diferentes métodos.

  • Foram adicionadas as variáveis de ambiente AXIOM_DATASET e AXIOM_TOKEN, que são necessárias nos ambientes onde a API deve ser utilizada. Sem essas variáveis:

    • Em produção e homologação, os logs continuam sendo enviados via integração com a Vercel.
    • Em desenvolvimento, os logs serão direcionados para o console.
  • Se, localmente, apenas a variável AXIOM_DATASET for definida, os logs serão processados pelo pino antes de ir para o stdout. Isso permite analisar o formato e os dados que seriam enviados ao Axiom.

Tipo de mudança

  • Nova funcionalidade

Checklist:

  • As modificações não geram novos logs de erro ou aviso (warning).
  • Eu adicionei testes na @tabnews/infra que provam que a correção ou novo recurso funciona conforme esperado.
  • Tanto os novos testes quanto os antigos estão passando localmente.

Copy link

vercel bot commented Jan 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tabnews ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 10, 2025 11:09pm

Copy link
Collaborator

@Rafatcb Rafatcb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uma melhoria importante!

O motivo para não usar a integração básica com o Pino no @tabnews/infra (axiom-transport.js) é por causa do waitUntil?

@aprendendofelipe
Copy link
Collaborator Author

O motivo para não usar a integração básica com o Pino no @tabnews/infra (axiom-transport.js) é por causa do waitUntil?

Isso e um pouco mais.

A versão deles não é pensada para ser compatível com as lambdas. Logs produzidos nas lambdas não são transmitidos em requisições que não demorem mais de 1 segundo. E mesmo requisições demoradas, se terminarem com erro, acaba não enviando o log dos erros, mas apenas o log inicial. Isso porque os logs são enviados para o Axiom apenas a cada 1 segundo ou se acumular 1000 registros, sem uma maneira de aguardar o envio, sem ter como saber se já foram enviados e sem uma maneira de antecipar o envio, já que o logger.flush do pino não aciona o axiom.ingest.

Nossa versão antecipa o processamento pelo pino e a execução do axiom.ingest, além de aguardar o término do envio, ainda permite fazer tudo isso apenas após responder a requisição e sem interferir no tempo de resposta.

@aprendendofelipe aprendendofelipe merged commit bd9be1b into main Jan 12, 2025
7 checks passed
@aprendendofelipe aprendendofelipe deleted the send-logs-to-Axiom-with-@tabnews/infra branch January 12, 2025 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants