Logdy-Core 项目使用教程

Logdy-Core 项目使用教程

logdy-core Web based real-time log viewer. Stream ANY content to a web UI with autogenerated filters. Parse any format with TypeScript. 项目地址: https://gitcode.com/gh_mirrors/lo/logdy-core

1. 项目目录结构及介绍

logdy-core/
├── example-app/
├── http/
├── logdy/
├── models/
├── modes/
├── ring/
├── utils/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── build_across
├── go.mod
├── go.sum
├── main.go
├── release
└── test-cmd

目录结构介绍

• example-app/: 包含示例应用程序的代码。
• http/: 包含与HTTP相关的代码。
• logdy/: 包含Logdy核心功能的代码。
• models/: 包含项目中使用的数据模型。
• modes/: 包含不同的运行模式代码。
• ring/: 包含环形缓冲区相关的代码。
• utils/: 包含各种实用工具函数。
• .gitattributes: Git属性配置文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• build_across: 构建跨平台二进制文件的脚本。
• go.mod: Go模块依赖管理文件。
• go.sum: Go模块依赖校验文件。
• main.go: 项目的主入口文件。
• release: 发布相关文件。
• test-cmd: 测试命令相关文件。

2. 项目启动文件介绍

main.go

main.go 是 Logdy-Core 项目的主入口文件。它负责初始化项目并启动服务。以下是 main.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()
}

启动步骤

1. 初始化配置: 使用 logdy.Config 结构体初始化 Logdy 的配置。
2. 启动服务: 调用 logdy.InitializeLogdy 函数启动 Logdy 服务。
3. 记录日志: 使用 logdyLogger.LogString 方法记录日志信息。
4. 等待结束: 使用 context.Background().Done() 等待程序结束。

3. 项目配置文件介绍

logdy.Config

logdy.Config 是 Logdy-Core 项目的配置结构体，定义了项目启动时所需的配置参数。以下是 logdy.Config 的主要字段：

type Config struct {
    ServerIp   string // 服务器IP地址
    ServerPort string // 服务器端口号
}

配置示例

logdy.Config{
    ServerIp:   "127.0.0.1",
    ServerPort: "8080",
}

配置说明

• ServerIp: 指定 Logdy 服务器的 IP 地址，默认为 127.0.0.1。
• ServerPort: 指定 Logdy 服务器的端口号，默认为 8080。

通过以上配置，可以灵活地调整 Logdy 服务的运行参数，以适应不同的部署环境。

logdy-core Web based real-time log viewer. Stream ANY content to a web UI with autogenerated filters. Parse any format with TypeScript. 项目地址: https://gitcode.com/gh_mirrors/lo/logdy-core