Gilfeather/furnace

📝 Improve error messages and logging

Aberta

#6 aberto em 16 de jul. de 2025

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Rust (5 forks)auto 404
enhancementgood first issuehelp wanted

Métricas do repositório

Stars
 (64 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Description

Enhance error messages to be more user-friendly and add structured logging throughout the application.

✅ Completed Items

  • Add structured logging using tracing crate - DONE
  • Replace generic error messages with specific, actionable ones - DONE
  • Add proper error context using comprehensive error types - DONE
  • Log request/response details at debug level - DONE
  • Update error responses to include helpful suggestions - DONE

🔄 Remaining Items

  • Include request IDs for tracing requests
  • Add more granular log levels for different components

Current Implementation Status

Logging: Full structured logging implemented with:

  • Session IDs for server instances
  • Detailed request/response logging
  • Performance metrics logging
  • Error context with stack traces
  • JSON logging support for production

Error Handling: Comprehensive error system with:

  • Detailed error messages with context
  • HTTP status code mapping
  • Structured error responses with timestamps
  • Input validation errors with expected vs actual values
  • Helpful error suggestions in responses

Estimated Remaining Work

Easy - 1-2 hours for request ID tracing

Guia do colaborador

Direção de pesquisa
Implemente o rastreamento de ID de solicitação adicionando um identificador único por requisição e incluindo o nas mensagens de log. Em seguida, adicione níveis de log granulares para diferentes componentes usando os spans e níveis do crate tracing.
Pilha de tecnologia
rust
Domain
backendai
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
RustCargo
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80