fix(log): 生产日志默认不再带源文件位置

## 现象

生产日志每行都带 `file.go:NNN`:

    2026/10/31 18:47:03 bootstrap.go:320: [homed] shutting down...
    2026/10/31 18:47:03 builtin_skill.go:163: [plugin] seq: removed skill ...
    2026/10/31 18:47:03 sidecar.go:419: [clawhubadapter] sidecar manager stopped

来源是 `cmd/homed/bootstrap.go` 里无条件 `log.SetFlags(... | log.Lshortfile)`。

## 判断:生产确实不需要

- 多数日志**本身带模块前缀**(`[homed]` / `[plugin]` / `[kbtree]` / `[skillmgr]`),
  去掉行号后定位能力并不缺
- `Lshortfile` 在**每一次** log 调用里做一次 `runtime.Caller`,不为零
- 它还不能真的消歧:它只打基名,26 个插件里有多个 `plugin.go`,
  `plugin.go:104` 反而指不出是哪一个 —— 真正的消歧靠的是消息里的 `[插件名]` 前缀

## 改法

`logFlags()` 抽出来,默认 `Ldate|Ltime`;`HOMED_LOG_SOURCE=1`(或 true/yes/on)
时追加 `Lshortfile`。

保留开关而不是删掉:排查插件/装配问题时行号仍有用,部署方临时开一下即可。
用法写进 `docs/zh/deploy-runbook.md` §3.0。

## 判据

- `TestLogFlagsNoSourceByDefault`:默认不得有 Lshortfile,且日期时间必须保留
- `TestLogFlagsSourceOptIn`:开关的六种正向写法生效、四种关闭写法不误开

## 验证

    go build ./...             ✓
    go vet ./cmd/homed/        ✓
    go test ./cmd/homed/       ✓(含新增两条)
This commit is contained in:
JianFeeeee
2026-10-31 18:49:36 +08:00
parent 3da59bc92f
commit 0cb20fb7f5
3 changed files with 104 additions and 2 deletions

View File

@ -29,12 +29,36 @@ import (
"github.com/JianFeeeee/HologramAgent/pkg/types"
)
// setupLogging 初始化日志:行号前缀 + 同时输出到控制台与 <data>/log/ 下的本次启动文件。
// logSourceEnv 是「日志带源文件位置」的开关环境变量。
//
// 为什么默认关:生产日志要紧凑可读。加了 `file.go:NNN` 之后每行前面多出一截
// 内部实现信息,而**大多数日志本身已经带了模块前缀**(`[kbtree]`、`[plugin]`、
// `[agent]`),定位能力并不缺。
//
// 而它也不便宜:`log.Lshortfile` 在**每一次** log 调用里做一次 runtime.Caller。
//
// 为什么保留开关而不是删掉:排查插件/装配问题时,同名文件(多个插件都有自己的
// plugin.go)靠行号才能区分。部署方临时 `HOMED_LOG_SOURCE=1` 重启即可。
const logSourceEnv = "HOMED_LOG_SOURCE"
// logFlags 返回日志前缀标志位(抽出来便于判据直接验,不必真去建目录/开文件)。
func logFlags() int {
flags := log.Ldate | log.Ltime
switch strings.ToLower(strings.TrimSpace(os.Getenv(logSourceEnv))) {
case "1", "true", "yes", "on":
flags |= log.Lshortfile
}
return flags
}
// setupLogging 初始化日志:时间前缀 + 同时输出到控制台与 <data>/log/ 下的本次启动文件。
//
// 源文件位置默认不带,见 logSourceEnv。
//
// 本函数体是 main() 里对应启动阶段的整块平移:语句、日志文本、错误语义不变,
// 只把「*dataDir」变成参数、把 defer 变成由调用点注册的 cleanup。
func setupLogging(dataDir string) string {
log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
log.SetFlags(logFlags())
// 文件日志:同时输出到控制台和 data/log/ 目录
logDir := filepath.Join(dataDir, "log")