Lottip 项目使用教程

Lottip 项目使用教程

lottipSimple MySQL proxy for query logging with web GUI项目地址:https://gitcode.com/gh_mirrors/lo/lottip

1. 项目的目录结构及介绍

Lottip 是一个简单的 MySQL 代理，用于查询日志记录，并提供 Web GUI。以下是项目的目录结构及其介绍：

lottip/
├── cmd/
│   └── lottip/
│       └── main.go  # 项目的主入口文件
├── web/
│   ├── css/        # 存放 CSS 文件
│   ├── js/         # 存放 JavaScript 文件
│   ├── html/       # 存放 HTML 文件
│   └── png/        # 存放图片文件
├── fs/
│   └── fs.go       # 文件系统相关代码
├── README.md      # 项目说明文档
├── LICENSE        # 项目许可证
└── go.mod         # Go 模块文件

目录结构介绍

• cmd/lottip/main.go: 项目的启动文件，包含主函数的入口。
• web/: 存放 Web GUI 相关的静态文件，包括 CSS、JavaScript、HTML 和图片。
• fs/fs.go: 文件系统相关的代码，用于处理静态文件的加载。
• README.md: 项目的说明文档，包含项目的基本信息和使用方法。
• LICENSE: 项目的许可证文件，表明项目的开源许可类型。
• go.mod: Go 模块文件，定义项目的依赖关系。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/lottip/main.go。该文件是整个项目的入口点，负责初始化和启动代理服务。

启动文件主要功能

• 初始化配置：读取配置文件并设置相关参数。
• 启动代理服务：监听指定端口，转发 MySQL 查询请求。
• 启动 Web GUI：提供 Web 界面，用于查看和操作查询日志。

启动文件代码示例

package main

import (
    "log"
    "net/http"
    "github.com/orderbynull/lottip/proxy"
    "github.com/orderbynull/lottip/web"
)

func main() {
    // 初始化代理服务
    proxy.Init()

    // 启动 Web GUI
    http.Handle("/", web.Handler())
    log.Println("Web GUI available at http://127.0.0.1:9999")
    go http.ListenAndServe(":9999", nil)

    // 启动代理服务
    log.Println("Forwarding queries from '127.0.0.1:4041' to '127.0.0.1:3306'")
    proxy.Run(":4041", ":3306")
}

3. 项目的配置文件介绍

Lottip 项目目前没有独立的配置文件，配置主要通过命令行参数和环境变量进行设置。

配置项

• MYSQL_HOST: MySQL 服务器的主机地址，默认为 127.0.0.1。
• MYSQL_PORT: MySQL 服务器的端口号，默认为 3306。
• PROXY_PORT: 代理服务器的监听端口，默认为 4041。
• WEB_PORT: Web GUI 的监听端口，默认为 9999。

配置示例

export MYSQL_HOST=127.0.0.1
export MYSQL_PORT=3306
export PROXY_PORT=4041
export WEB_PORT=9999
./lottip_linux_amd64

通过上述配置，可以灵活地设置 Lottip 的运行参数，以适应不同的部署环境。

---

以上是 Lottip 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用 Lottip 项目。

lottipSimple MySQL proxy for query logging with web GUI项目地址:https://gitcode.com/gh_mirrors/lo/lottip