docs(agent): 统一中文注释并补充部署文档

将代码与测试注释改为中文以符合仓库规范;新增中文部署指南、
示例配置,并完善构建脚本对 VERSION 注入的说明。

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
codex
2026-05-19 02:30:49 +00:00
parent 89d5e27874
commit 877e4cf41d
28 changed files with 608 additions and 226 deletions

View File

@@ -20,9 +20,9 @@ import (
"mfd-monitor-agent/internal/snapshot"
)
const version = "0.1.0"
var version = "0.1.0"
// main runs the CLI and exits non-zero when a command fails.
// main 运行 CLI,命令失败时以非零状态退出。
func main() {
if err := runCLI(os.Args[1:]); err != nil {
_, _ = fmt.Fprintln(os.Stderr, err)
@@ -30,7 +30,7 @@ func main() {
}
}
// runCLI dispatches agent subcommands and loads config before invoking command handlers.
// runCLI 分发 agent 子命令,并在调用处理函数前加载配置。
func runCLI(args []string) error {
if len(args) == 0 {
args = []string{"run"}
@@ -38,7 +38,7 @@ func runCLI(args []string) error {
switch args[0] {
case "run":
fs := flag.NewFlagSet("run", flag.ExitOnError)
configPath := fs.String("config", "", "path to JSON config file")
configPath := fs.String("config", "", "JSON 配置文件路径")
if err := fs.Parse(args[1:]); err != nil {
return err
}
@@ -79,11 +79,11 @@ func runCLI(args []string) error {
}
}
// commandConfig parses service command flags and resolves the executable path.
// commandConfig 解析服务相关子命令的标志并解析可执行文件路径。
func commandConfig(args []string) (config.Config, string, string, error) {
fs := flag.NewFlagSet("service", flag.ExitOnError)
configPath := fs.String("config", "", "path to JSON config file")
executableFlag := fs.String("exe", "", "path to agent executable")
configPath := fs.String("config", "", "JSON 配置文件路径")
executableFlag := fs.String("exe", "", "agent 可执行文件路径(默认当前二进制)")
if err := fs.Parse(args); err != nil {
return config.Config{}, "", "", err
}
@@ -101,7 +101,7 @@ func commandConfig(args []string) (config.Config, string, string, error) {
return cfg, executable, *configPath, nil
}
// runAgent starts collection, optional reporting, and the local HTTP API until signaled.
// runAgent 启动采集、可选上报与本地 HTTP API,直至收到退出信号。
func runAgent(cfg config.Config) error {
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)