gglouc-run-project-template v1.0.0

Registrador de Logs GCP

Sobre esse script

Este script configura um servidor Express para processar logs. Ele busca o nome da aplicação com base no applicationId, envia logs para o Google Cloud Logging e registra um checkpoint em um serviço externo.

Uso

1. Duplique o arquivo .env.example, renomeie-o para .env e configure as variáveis de ambiente conforme necessidade.
2. Crie uma conta de serviço no GCP e coloque o arquivo keyfile.json na pasta raiz do projeto
3. Envie uma requisição POST para / com o seguinte corpo JSON: { "message": "Sua mensagem", "severity": "INFO", "applicationId": "id-da-aplicacao" }

Sobre os tipos de severidade

No Google Cloud Logging, os tipos de severidade que você pode usar são definidos pelo protocolo de severidade de logs do Google. Aqui estão os principais níveis de severidade disponíveis que você pode utilizar:

• DEBUG: Informações detalhadas e técnicas geralmente usadas para depuração.
• INFO: Informações gerais sobre o sistema, útil para rastreamento e monitoramento.
• NOTICE: Informações que indicam um comportamento normal do sistema, mas que são notáveis.
• WARNING: Situações que não são erros, mas podem ser problemas futuros ou comportamento inesperado.
• ERROR: Erros que indicam falhas no sistema ou operações que não foram concluídas.
• CRITICAL: Erros graves que afetam a operação principal do sistema e exigem atenção imediata.
• ALERT: Situações que exigem ação imediata e indicam uma condição crítica.
• EMERGENCY: Condições de sistema inoperante que requerem uma ação imediata para restaurar a funcionalidade do sistema.

Typescript

Para a construção desse modelo foi utilizado o typescript v4.9.5

Deploy automatizado para o Google Cloud Run

Ao publicar o container no Cloud Run, configure a integração contínua diretamente no Cloud Run. Feito isso, após qualquer commit na branch main, o Cloud Run irá fazer o build novamente.

Testes automatizados

Todos os testes automatizados para funções, métodos e endpoints estão na pasta tests. Utilize o comando npm test para executá-los.

Para testes locais e desenvolvimento, use o comando npm run dev. O servidor irá responder em http://localhost:8080

Uso em Produção

Após finalizar o projeto e fazer o commit para o Github, abra o Cloud Run do Google, vincule o repositório e selecione as configurações do container conforme necessário. Feito isso o deploy será feito automaticamente pelo próprio Google, inclusive com entrega contínua.

v1.0.0 (17-08-2024)

• Versão inicial