Logdy-Core 开源项目教程
1. 项目介绍
Logdy-Core 是一个基于 Web 的实时日志查看器,能够将任何内容流式传输到 Web UI,并自动生成过滤器。它支持使用 TypeScript 解析任何格式的日志。Logdy-Core 是一个单二进制文件,可以像其他工具(如 grep
、awk
、sed
、jq
)一样添加到你的 PATH 中,无需安装、部署或编译。它可以在本地工作,因此也非常安全。
2. 项目快速启动
2.1 安装
使用脚本安装
curl https://logdy.dev/install.sh | sh
使用 Homebrew 安装(MacOS)
brew install logdy
下载预编译二进制文件
wget https://github.com/logdyhq/logdy-core/releases/download/v0.12.0/logdy_linux_amd64
mv logdy_linux_amd64 logdy
chmod +x logdy
2.2 快速启动
以下命令将输出内容转发到 Web UI:
node index.js | logdy
执行后,你应该会看到如下输出:
INFO[2024-02] WebUI started, visit http://localhost:8080 port=8080
打开浏览器访问 http://localhost:8080
,即可开始构建解析器、列和过滤器。
3. 应用案例和最佳实践
3.1 使用 Logdy 进行日志分析
假设你有一个日志文件 example.log
,你可以使用以下命令将日志内容实时流式传输到 Web UI:
tail -f example.log | logdy
3.2 嵌入到 Go 应用中
你还可以将 Logdy 嵌入到你的 Go 应用中,以下是一个简单的示例:
package main
import (
"github.com/logdyhq/logdy-core/logdy"
"context"
)
func main() {
logdyLogger := logdy.InitializeLogdy(logdy.Config{
ServerIp: "127.0.0.1",
ServerPort: "8080",
}, nil)
logdyLogger.LogString("Log message")
<-context.Background().Done()
}
4. 典型生态项目
4.1 Logdy-UI
Logdy-UI 是 Logdy-Core 的 Web 界面,提供了直观的日志查看和过滤功能。你可以通过以下方式运行 Logdy-UI:
go run main.go demo 1
4.2 Logdy-CLI
Logdy-CLI 是一个命令行工具,提供了多种命令来管理和查看日志,例如:
logdy follow example.log
4.3 Logdy-Docs
Logdy-Docs 是 Logdy 项目的官方文档,提供了详细的 API 参考和使用指南。你可以访问 Logdy 官方文档 获取更多信息。
通过以上模块的介绍,你可以快速上手并深入了解 Logdy-Core 开源项目。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考