Design Soft DDD

Appearance

Design Soft DDDDDD, OpenTelemetry e Stack Docker de Observabilidade

Documentação técnica do estado atual do projeto, da instrumentação automática e manual e da infraestrutura local baseada em Grafana, Tempo, Loki, Mimir e Prometheus.

Visão Geral do Projeto
Logging com Pino
Stack Docker
🧭

Mapa do Projeto

Estrutura atual do código, responsabilidades por diretório, estado de maturidade das camadas e fluxo de execução da aplicação.

📡

Instrumentação Explicada

Documentação detalhada da instrumentação automática e manual do OpenTelemetry, incluindo métricas, spans, logs e boas práticas.

🐳

Infraestrutura Documentada

Explicação completa dos containers Docker, arquivos do diretório infra, healthchecks, pipelines do Collector e provisionamento do Grafana.

🛠️

Operação e Troubleshooting

Scripts, dependências, comandos úteis, smoke tests e caminhos de diagnóstico para falhas comuns da stack.

Roteiro de leitura recomendado ​

Ordem sugerida

  1. Leia Visão Geral do Projeto.
  2. Siga para O que é OpenTelemetry.
  3. Leia Pino.
  4. Depois leia Logging na Arquitetura.
  5. Em seguida leia OpenTelemetry na Arquitetura.
  6. Continue em Infraestrutura / Stack Docker.
  7. Para implementar novas rotas e use-cases, use OpenTelemetry na Prática.

Atalhos operacionais ​

bash
npm run start:local
npm run observability:up
npm run observability:ps
npm run observability:smoke
npm run docs:dev

O que esta documentado ​

  • Estado atual do projeto e avaliação técnica.
  • Estrutura das pastas e responsabilidades por camada.
  • Dependências principais e scripts operacionais.
  • Implementação de logging estruturado com Pino.
  • Implementação da instrumentação automática e manual do OpenTelemetry.
  • Implementação detalhada do diretório infra/ e dos containers Docker.
  • Troubleshooting para falhas comuns da stack de observabilidade.

Documentação técnica do estado atual do projeto e da stack de observabilidade.

Design Soft DDD