@xhopcfine/aster-plugin-superlog
v0.1.3
Published
Superlog 本地 SQLite 版 Aster 插件。
Downloads
412
Readme
@xhopcfine/aster-plugin-superlog
Superlog 本地 SQLite 版 Aster 插件。
这个插件把 Superlog 的 Web 界面和本地 API 打包成一个 Aster 插件。安装后可以在本机启动 Superlog,用 SQLite 保存数据,不需要 Postgres、ClickHouse、GitHub、Slack、Linear、AWS 或任何外部服务。
特性
- 保留 Superlog 的主要界面和可观测性工作流。
- 数据保存在本机 SQLite,适合对客户数据、日志数据、排障数据有隐私要求的环境。
- Aster 可以直接调用插件工具查询项目、日志、Trace、指标和事故。
- 支持通过 Aster 对话写入本地日志,然后立刻查询。
- 不需要 MCP,Aster 通过插件工具调用本机 API。
安装
先全局安装 Aster:
npm install -g aster-agent@latest再全局安装 Superlog 插件:
npm install -g @xhopcfine/aster-plugin-superlog然后用全局 aster 命令启用 Superlog 插件:
aster plugins install superlog --package @xhopcfine/aster-plugin-superlog --enabled启动 Aster:
aster注意:Aster 不会自动下载这个插件包。用户必须先用 npm install -g @xhopcfine/aster-plugin-superlog 全局安装插件,然后再用 aster plugins install ... 启用它。
快速使用
在 Aster 对话里直接用中文说需求即可。
启动 Superlog:
启动 SuperlogAster 会启动本机 Superlog API 和 Web 界面。默认地址:
http://127.0.0.1:5173记录一条日志:
记录一条日志,服务名是 aster-test,级别是 info,内容是 用户正在测试 Superlog 本地日志写入查看最近日志:
查看 Superlog 最近 10 条日志查询错误日志:
查看最近 20 条 error 日志按服务查询日志:
查看 aster-test 服务最近的日志情况查看项目:
列出 Superlog 项目查看 Trace:
查询 checkout-api 服务最近的 Trace查看事故:
列出当前打开的事故停止 Superlog:
停止 SuperlogAster 工具
插件会向 Aster 暴露这些工具。通常用户不需要手动输入工具名,直接用中文描述需求即可。
| 工具 | 作用 |
| --- | --- |
| superlog_start | 启动本地 Superlog API 和 Web 界面 |
| superlog_stop | 停止本地 Superlog 服务 |
| superlog_status | 查看插件状态、端口和 SQLite 路径 |
| superlog_url | 查看本地 Superlog 界面地址 |
| superlog_list_projects | 列出本地 Superlog 项目 |
| superlog_record_log | 写入一条本地日志 |
| superlog_query_logs | 查询本地日志 |
| superlog_query_traces | 查询 Trace 列表 |
| superlog_get_trace | 查看单条 Trace 明细 |
| superlog_query_metrics | 查询指标数据 |
| superlog_list_incidents | 列出事故 |
| superlog_get_incident | 查看事故详情 |
数据和端口
默认地址:
- Web:
http://127.0.0.1:5173 - API:
http://127.0.0.1:4100
数据默认保存到 Aster 分配给插件的本机数据目录下,文件名为:
superlog.sqlite插件只访问本机 127.0.0.1 和本机 SQLite。日志、Trace、指标、事故等数据不会因为使用这个插件而发送到外部服务。
常见问题
需要安装 Postgres 或 ClickHouse 吗?
不需要。这个插件使用 SQLite 作为本地存储。
需要配置 MCP 吗?
不需要。Aster 不通过 MCP 使用这个插件,而是直接调用插件工具。插件工具内部会访问本机 Superlog API。
新电脑上可以直接用吗?
可以。新电脑上先全局安装 aster-agent,再全局安装 @xhopcfine/aster-plugin-superlog,然后用 aster plugins install superlog --package @xhopcfine/aster-plugin-superlog --enabled 启用插件即可。首次启动时会自动创建本地 SQLite 数据库。
Web 界面打不开怎么办?
先在 Aster 里说:
查看 Superlog 状态确认 Web 和 API 是否已启动。如果端口被占用,可以在插件配置里调整端口,或者先停止占用 5173、4100 的其他程序。
