Documentação da API Log Stack

Visão Geral

A API Log Stack permite que você crie e gerencie logs para seus projetos de forma simples e eficiente.

Para utilizar a API, você precisará:

ID do projeto - Disponível no dashboard do seu projeto
Token de autenticação (para endpoints protegidos)

Importante: Os logs são retidos por 7 dias por padrão. É possível configurar um período de retenção diferente nas configurações do projeto.

Criar Logs

POST /api/projects/{projectId}/logs

Endpoint para enviar novos logs para o sistema

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
level	string	Sim	Nível do log: info, warn, debug, error, verbose, fatal, log, trace, unknown
message	string	Sim	Mensagem do log
source	string	Não	Origem do log (ex: "api", "backend", "frontend"). Padrão: "unknown"
metadata	object	Não	Dados adicionais no formato JSON

Exemplos

# Log básico
curl -X POST \
  https://log-stack.coralcloud.app/api/projects/64f5a1b2c3d4e5f6a7b8c9d0/logs \
  -H "Content-Type: application/json" \
  -d '{
  "level": "info",
  "message": "Usuário logado com sucesso",
  "source": "auth-service"
}'

# Log com metadados
curl -X POST \
  https://log-stack.coralcloud.app/api/projects/64f5a1b2c3d4e5f6a7b8c9d0/logs \
  -H "Content-Type: application/json" \
  -d '{
  "level": "error",
  "message": "Falha na transação de pagamento",
  "source": "payment-service",
  "metadata": {
    "transactionId": "tx_123456789",
    "userId": "user_123",
    "amount": 99.99,
    "errorCode": "CARD_DECLINED"
  }
}'

Respostas

Sucesso (202 Accepted)

{
  "message": "Log aceito para processamento"
}

Erro (400 Bad Request)

{
  "message": "Level e message são obrigatórios"
}

// ou

{
  "message": "Level inválido. Use: info, warn, debug, error, verbose, fatal, log, trace"
}

Erro (404 Not Found)

{
  "message": "Projeto não encontrado"
}

Erro (500 Internal Server Error)

{
  "message": "Erro interno do servidor"
}

Boas Práticas

Use níveis de log apropriados para facilitar a filtragem e análise
Inclua informações de contexto relevantes no campo metadata
Defina a source para identificar facilmente a origem dos logs
Para mensagens de erro, inclua detalhes sobre a exceção e stack trace quando disponível
Ao fazer integração com serviços de terceiros, inclua IDs de correlação no metadata
Evite incluir dados sensíveis nos logs (senhas, tokens, informações pessoais)