pallavsharma505/warehouse-of-logs

WarehouseOfLogs 📦

基于Bun、TypeScript和SQLite构建的高性能轻量级日志聚合服务，包含日志收集器、查询API和React仪表盘，所有功能整合在单个容器中。

快速开始

bash
docker run -d \
  --name warehouse-of-logs \
  -p 7001:7001 \
  -p 7002:7002 \
  -p 7003:7003 \
  -e ADMIN_USER=admin \
  -e ADMIN_PASSWORD=changeme \
  -v wol-data:/data \
  docker.xuanyuan.run/pallavsharma505/warehouse-of-logs:latest

打开 http://localhost:7003 访问仪表盘。

Docker Compose配置

yaml
services:
  warehouse-of-logs:
    image: docker.xuanyuan.run/pallavsharma505/warehouse-of-logs:latest
    container_name: warehouse-of-logs
    restart: unless-stopped
    ports:
      - "7001:7001"
      - "7002:7002"
      - "7003:7003"
    environment:
      COLLECTOR_PORT: "7001"
      API_PORT: "7002"
      DATABASE_PATH: "/data/logs.sqlite"
      ADMIN_USER: "admin"
      ADMIN_PASSWORD: "changeme"
    volumes:
      - wol-data:/data

volumes:
  wol-data:
    driver: local

启动命令：

bash
docker compose up -d

环境变量

重要提示：部署到生产环境前，请修改默认的ADMIN_USER和ADMIN_PASSWORD。

使用方法

1. 登录

仪表盘和所有API端点（除/health外）需要身份验证。打开**http://localhost:7003**%EF%BC%8C%E4%BD%BF%E7%94%A8%60ADMIN_USER%60%E5%92%8C%60ADMIN_PASSWORD%60%E7%99%BB%E5%BD%95%E3%80%82

通过API获取JWT令牌：

bash
TOKEN=$(curl -s http://localhost:7002/login -X POST \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "changeme"}' | jq -r '.token')

后续API请求需携带令牌：

bash
curl -s http://localhost:7002/logs \
  -H "Authorization: Bearer $TOKEN" | jq

2. 创建API密钥

bash
curl -s http://localhost:7002/keys -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"name": "my-app"}' | jq

保存返回的key，仅显示一次。

3. 发送日志

bash
curl http://localhost:7001/ingest -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -d '{
    "app_name": "my-app",
    "level": "INFO",
    "message": "来自WarehouseOfLogs的问候！"
  }'

4. 查询日志

bash
curl -s http://localhost:7002/logs \
  -H "Authorization: Bearer $TOKEN" | jq

或通过**http://localhost:7003**%E7%9A%84web%E4%BB%AA%E8%A1%A8%E7%9B%98%E6%9F%A5%E8%AF%A2%E3%80%82

日志摄入Schema

json
{
  "app_name": "字符串（必填）",
  "level": "INFO | WARN | ERROR | DEBUG（必填）",
  "message": "字符串（必填）",
  "timestamp": "ISO 8601格式字符串（可选）",
  "metadata": "对象（可选）",
  "persist": "布尔值（可选，默认：false）",
  "expires_in": "秒数（可选，默认：86400）"
}

支持批量摄入，向同一端点发送日志对象数组即可。

持久化存储

SQLite数据库默认存储在容器内/data/logs.sqlite路径。挂载卷到/data可实现容器重启后日志持久化。

npm客户端库

适用于Node.js、Bun或Deno应用的程序化日志发送：

bash
npm install warehouse-of-logs-client

typescript
import { WolClient } from "warehouse-of-logs-client";

const logger = new WolClient({
  collectorUrl: "http://localhost:7001",
  apiKey: "your-api-key",
  appName: "my-service",
});

logger.info("用户登录", { userId: "abc123" });
await logger.shutdown();

完整文档：https://www.npmjs.com/package/warehouse-of-logs-client

API端点

收集器（端口7001）

API服务（端口7002）

源码

GitHub: https://github.com/pallavsharma505/warehouse-of-logs
npm: https://www.npmjs.com/package/warehouse-of-logs-client

许可证

Apache License 2.0 — Copyright 2026 Pallav Sharma.