AntonyCyriac/logscope
GitHub: AntonyCyriac/logscope
一款跨平台的开源日志调查平台,提供 CLI、桌面端和 Web UI 三种入口来搜索、分析、索引和报告各类日志格式。
Stars: 0 | Forks: 0
# LogScope
[](https://github.com/AntonyCyriac/logscope/actions/workflows/ci.yml)
[](https://github.com/AntonyCyriac/logscope/releases/latest)
[](LICENSE)
[](#install)
**调查任何日志格式 — CLI、桌面端或浏览器。** 无需一次性脚本即可解析、搜索、报告和持久化索引。
| 平台 | 二进制文件 | 最适合 |
|---------|--------|----------|
| **CLI** | `logscope` | 自动化、CI、高级用户 |
| **桌面端** | `logscope-desktop` | 交互式分析、实时 tail、导出 |
| **Web** | `logscope-web` | 共享工作区、REST API、团队访问 |
## 截图
**CLI** — 从终端进行分析和调查:

**桌面端** — 真实的 `logscope-desktop` 分析 `samples/sample.log`(8 行):

**Web** — 真实的 `logscope-web` SPA(v2.2.1,session 已就绪):

**当前版本:** [`v2.2.1`](CHANGELOG.md) — M15.4 轻量级 auth(session TTL,上传清理,[安全指南](docs/handbook/SECURING_LOGSCOPE_WEB.md))。[路线图](docs/ROADMAP.md) · [更新日志](CHANGELOG.md) · [下载](https://github.com/AntonyCyriac/logscope/releases/latest)
## 为什么选择 LogScope
工程师们仍在使用 grep 处理巨大的文件,拼凑特定格式的工具,并手动重新运行相同的调查步骤。LogScope 为纯文本和 JSONL 日志提供了**一个 pipeline**:
```
Source → Analysis → Investigation → Reporting
↑__________________________|
CLI · Desktop · Web
```
- **格式无关** — 自动检测格式,提取字段,调查内容
- **大规模下依然快速** — 可选的 SQLite 持久化索引(`--persist-index`)适用于大型日志
- **三种平台,一个核心** — 终端、Qt GUI 和浏览器中使用相同的分析引擎
- **可扩展** — 用于 parser、搜索、报告和存储的动态插件
- **AI 辅助** — 自然语言查询和摘要(可插拔 provider)
- **面向生产环境** — 多操作系统 CI、基准测试、模糊测试、MIT 许可证
## 功能
| 领域 | 能力 |
|------|----------------|
| **搜索** | 布尔、regex、全文(FTS5)、字段过滤器 DSL、已保存的搜索 |
| **报告** | 文本、JSON、HTML、PDF — 图表、执行摘要、部分选择器 |
| **分析** | 频率、聚类、时间线、趋势、相关性 |
| **存储** | SQLite 混合索引、压缩、增量追加、查询缓存 |
| **桌面端** | 实时 tail、session 保存/加载、导出对话框、AI 面板 |
| **Web** | REST API、SPA、共享工作区、异步分析、tail 轮询、API 密钥认证 |
| **插件** | 运行时加载 `.so`/`.dll` — parser、报告、搜索、存储 provider |
## 安装
**预编译二进制文件** — 适用于 Windows、macOS 和 Linux 的 [GitHub Releases](https://github.com/AntonyCyriac/logscope/releases/latest):
| 资产 | 起始版本 |
|-------|-------|
| `logscope` CLI | v1.0.0+ |
| `logscope-desktop` | v2.0.1+ |
| `logscope-web` (+ SPA) | v2.1.0+ |
解压后添加到 `PATH`(或直接从归档运行),然后:
```
logscope analyze samples/sample.log
logscope-desktop # GUI
logscope-web --config samples/web.properties # http://127.0.0.1:8080
```
**从源码构建** — CMake 3.20+,C++17(GCC、Clang 或 MSVC)。GoogleTest 和 SQLite 会自动拉取。
```
git clone https://github.com/AntonyCyriac/logscope.git
cd logscope
cmake -S . -B build
cmake --build build
ctest --test-dir build --output-on-failure
```
可选目标:`logscope-desktop` (Qt)、`logscope-web` (`-DLOGSCOPE_WEB=ON`)。请参阅[开发者设置](docs/handbook/DEVELOPER_SETUP.md)。
## 快速开始
### CLI
```
./build/apps/cli/logscope analyze samples/sample.log
./build/apps/cli/logscope investigate samples/sample.log --level error
./build/apps/cli/logscope search samples/sample.log "timeout"
```
更多:[用户手册 §2](docs/handbook/USER_MANUAL.md#2-getting-started) · [CLI 参考](docs/handbook/CLI_REFERENCE.md)
### 桌面端
打开日志文件,按级别过滤,实时 tail,导出 HTML/PDF 报告。[用户手册](docs/handbook/USER_MANUAL.md) · 桌面端自 v2.0.1 起提供。
### Web
```
cmake -S . -B build -DLOGSCOPE_WEB=ON
cmake --build build --target logscope-web
./build/apps/web/logscope-web --config samples/web.properties
```
打开 `http://127.0.0.1:8080`(或使用 TLS 的 HTTPS)。REST API:[ADR-009](docs/architecture/decisions/ADR-009-Web-Platform-REST.md)。保护共享主机:[保护 logscope-web](docs/handbook/SECURING_LOGSCOPE_WEB.md)。
| 标志 / 环境变量 | 用途 |
|------------|---------|
| `--bind-host` / `LOGSCOPE_WEB_BIND_HOST` | 监听地址(默认 `127.0.0.1`) |
| `--bind-port` / `LOGSCOPE_WEB_BIND_PORT` | 监听端口(默认 `8080`) |
| `--tls-cert` / `LOGSCOPE_WEB_TLS_CERT` | HTTPS 证书(PEM) |
| `--tls-key` / `LOGSCOPE_WEB_TLS_KEY` | HTTPS 私钥(PEM) |
## 文档
| 受众 | 从这里开始 |
|----------|------------|
| **用户** | [用户手册](docs/handbook/USER_MANUAL.md) · [CLI 参考](docs/handbook/CLI_REFERENCE.md) · [配置](docs/handbook/CONFIGURATION_GUIDE.md) |
| **贡献者** | [AGENTS.md](AGENTS.md) · [开发者设置](docs/handbook/DEVELOPER_SETUP.md) · [教程](docs/tutorials/README.md) · [开发者指南](docs/handbook/DEVELOPER_GUIDE.md) · [测试](docs/testing/TESTING.md) |
| **架构** | [概述](docs/architecture/ARCHITECTURE_OVERVIEW.md) · [组件目录](docs/architecture/COMPONENT_CATALOG.md) · [产品](docs/PRODUCT.md) |
完整索引:[文档地图](docs/DOCUMENT_MAP.md)
## 仓库布局
```
apps/ CLI, desktop (optional), web (optional)
core/ Libraries (foundation, source, analysis, investigation, reporting, …)
docs/ Product, architecture, handbook, planning
samples/ Example logs and configuration
scripts/ Bulk-log fixtures and CLI matrix runners
tests/ Unit, integration, e2e, regression, benchmarks
```
## 贡献
1. [AGENTS.md](AGENTS.md)(AI 助手) → [开发者设置](docs/handbook/DEVELOPER_SETUP.md) → [开发者指南](docs/handbook/DEVELOPER_GUIDE.md)
2. [Git 规范](docs/handbook/GIT_CONVENTIONS.md) · [Pull Request 指南](docs/handbook/PULL_REQUEST_GUIDE.md)
3. 在发起 PR 之前构建、测试并格式化代码(`cmake --build build --target format`)
## 许可证
[MIT](LICENSE) — 版权所有 (c) 2026 AntonyCyriac
标签:Bash脚本, TCP SYN 扫描, Web UI, 人工智能, 桌面应用, 用户模式Hook绕过, 网络测绘, 调试插件, 运维工具