Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1870d84974 | ||
|
|
6bc0aa4c0a | ||
|
|
3d0fc5e93f | ||
|
|
1f816dc8b3 | ||
|
|
a2b1055f5d | ||
|
|
13418b5365 | ||
|
|
c1e1ecc3b0 | ||
|
|
1e5dbd2a23 | ||
|
|
96c910bb14 | ||
|
|
9459a98224 |
7
.gitignore
vendored
7
.gitignore
vendored
@ -1,2 +1,9 @@
|
||||
.log.meta.json
|
||||
.test.meta.json
|
||||
.ai/
|
||||
.geminiignore
|
||||
.gemini
|
||||
env.json
|
||||
env.yml
|
||||
env.yaml
|
||||
/CODE-FULL.md
|
||||
|
||||
31
CHANGELOG.md
31
CHANGELOG.md
@ -1,5 +1,36 @@
|
||||
# Changelog
|
||||
|
||||
## [1.3.2] - 2026-05-13
|
||||
- **功能增强: 引入摩擦消除工具 `As`**:
|
||||
- **泛型支持**: 新增全局泛型函数 `log.As[T](v T, err error) T`,仿照 `cast.As` 设计,自动记录错误并返回零值,极大简化了带 error 返回值的函数链式调用。
|
||||
- **Logger 扩展**: `Logger` 结构体新增 `As(v any, err error) any` 方法,支持实例级别的错误捕获与自动记录。
|
||||
- **调用栈优化**: 优化了 `GetCallStacks` 逻辑,自动跳过 `default_logger.go` 中的内部帧,确保 `log.As` 记录的错误位置精准指向业务代码。
|
||||
|
||||
## [1.3.1] - 2026-05-12
|
||||
- **架构升级: 引入 LoggerService**:
|
||||
- **解耦重构**: 重构全局变量管理,引入 `loggerService` 结构体,集中化管理异步写入协程、Writers 对象池、文件句柄与丢弃计数。
|
||||
- **生命周期管理**: 实现了 `Start(ctx, logger)`, `Stop(ctx)`, `Health()` 接口,完美支持与 `apigo.cc/go/starter` 的基础设施集成。
|
||||
- **安全性增强**: 优化了平滑停止逻辑,确保 `Stop` 调用时能完整 Flush 缓冲区数据。
|
||||
- **功能增强**:
|
||||
- **动态应用名**: 新增 `SetDefaultName(name)` 全局方法,支持在微服务启动后动态设置应用名称,并自动同步至 `DefaultLogger`。
|
||||
- **配置与忽略规则**:
|
||||
- 更新 `.gitignore`,增加了对 `.gemini`, `env.json`, `env.yml` 以及 `/CODE-FULL.md` 的忽略支持。
|
||||
- **文档与测试同步**: 全面更新了 `README.md`, `CHANGELOG.md` 与 `TEST.md`。
|
||||
|
||||
## [1.3.0] - 2026-05-10
|
||||
- **全栈基础设施对齐**:
|
||||
- 将所有内部依赖(`cast`, `config`, `file`, `id`, `shell` 等)统一升级至 `v1.3.0` 语义版本。
|
||||
- 优化项目忽略规则,在 `.gitignore` 中增加了对 `.geminiignore` 的支持。
|
||||
|
||||
## [1.1.16] - 2026-05-10
|
||||
- **依赖对齐**: 同步更新 `golang.org/x/crypto` 和 `golang.org/x/sys` 至最新版本,确保底层安全性。
|
||||
|
||||
## [1.1.15] - 2026-05-10
|
||||
- **安全与性能双重增强**:
|
||||
- **敏感字段扩展**: `authorization` 现在默认纳入脱敏规则 (`LogDefaultSensitive`),自动过滤 HTTP 认证凭证。
|
||||
- **TraceId 吞吐优化**: 切换至 `id.Get10Bytes14MPerSecond()` 算法,在保持 10 字节唯一性的同时,极大提升了超高并发下的 ID 生成性能。
|
||||
- **应用名称识别对齐**: 重构 `GetDefaultName` 逻辑,优先通过 `debug.ReadBuildInfo()` 识别 Module 路径,并支持自动裁剪 Windows 环境下的 `.exe` 后缀。
|
||||
|
||||
## [1.1.14] - 2026-05-09
|
||||
- **可视化能力调整**: 调整优化了 `viewer` 模块相关的可视化能力,提升了日志的可读性与调试体验。
|
||||
|
||||
|
||||
17
README.md
17
README.md
@ -25,6 +25,9 @@ import "apigo.cc/go/log"
|
||||
|
||||
// 默认 logger (通过 log.json 或环境变量配置)
|
||||
func main() {
|
||||
// 在微服务场景下动态设置应用名称
|
||||
log.SetDefaultName("my-microservice")
|
||||
|
||||
log.Info("服务启动", "port", 8080)
|
||||
log.Error("数据库连接失败", "db", "mysql")
|
||||
|
||||
@ -51,7 +54,7 @@ func main() {
|
||||
"level": "info",
|
||||
"file": "logs/app.log",
|
||||
"splitTag": ".2006-01-02",
|
||||
"sensitive": "phone,password,secret,token,key"
|
||||
"sensitive": "phone,password,secret,token,accessToken,authorization"
|
||||
}
|
||||
```
|
||||
|
||||
@ -68,7 +71,7 @@ export LOG_FILE=console
|
||||
|
||||
### 配置项说明
|
||||
|
||||
* `name`: 应用名称 (默认读取 DISCOVER_APP 或从 `go.mod` 自动识别)。
|
||||
* `name`: 应用名称 (默认通过 `debug.ReadBuildInfo()` 或 `os.Args[0]` 自动识别)。
|
||||
* `level`: 日志级别 (`debug`, `info`, `warning`, `error`)。
|
||||
* `file`: 输出目标。
|
||||
* `console`: 直接输出到控制台(默认)。
|
||||
@ -77,7 +80,7 @@ export LOG_FILE=console
|
||||
* `splitTag`: 文件切分格式,仅当 `file` 为文件路径时有效。
|
||||
* 语法遵循 Go 标准的 `time.Format` 布局,如 `".2006-01-02"` (按天切分),`".2006-01-02-15"` (按小时切分)。
|
||||
* `truncations`: 堆栈信息截断前缀(多个以逗号分隔,默认截断 `github.com/`, `golang.org/`, `/apigo.cc/`)。
|
||||
* `sensitive`: 需要自动脱敏的字段名(多个以逗号分隔,不区分大小写),默认处理 `phone,password,secret,token,key`。
|
||||
* `sensitive`: 需要自动脱敏的字段名(多个以逗号分隔,不区分大小写),默认处理 `phone,password,secret,token,accessToken,authorization`。
|
||||
|
||||
## 🛠 API 指南
|
||||
|
||||
@ -86,10 +89,14 @@ export LOG_FILE=console
|
||||
1. **分级记录**
|
||||
* `Debug`, `Info`, `Warning`, `Error` —— 标准日志方法,支持 `message` + 变长 `extra` 参数。
|
||||
|
||||
2. **通用记录 (`Log`)**
|
||||
2. **摩擦消除 (`As`)**
|
||||
* `As(v, err)` —— 仿照 `cast.As`,忽略错误并返回零值,但会自动将错误记录到日志中。支持全局调用 (`log.As`) 或实例调用 (`logger.As`)。
|
||||
* **优势**: 在类型转换或快速赋值场景下,无需繁琐的 `if err != nil` 判断,同时确保异常被记录。
|
||||
|
||||
3. **通用记录 (`Log`)**
|
||||
* `Log(LogEntry)` —— 记录自定义结构的日志。
|
||||
|
||||
3. **独立可视化工具 (`logv`)**
|
||||
4. **独立可视化工具 (`logv`)**
|
||||
* **安装**: `go install apigo.cc/go/log/logv@latest`
|
||||
* **使用**: `tail -f app.log | logv` 或 `tail -f app.log | logv -json`。
|
||||
|
||||
|
||||
86
TEST.md
86
TEST.md
@ -1,30 +1,62 @@
|
||||
# 日志性能测试报告
|
||||
# Test Results
|
||||
|
||||
## 测试环境
|
||||
- 操作系统: darwin
|
||||
- 架构: amd64
|
||||
- CPU: Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz
|
||||
|
||||
## 基准测试结果 (v1.1.10)
|
||||
|
||||
| 测试用例 | 迭代次数 | 耗时 (ns/op) | 内存分配 (B/op) | 分配次数 (allocs/op) |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| `BenchmarkLogger_RequestLog_Realistic` | 344,300 | 3,338 | 1,331 | 19 |
|
||||
| `BenchmarkLoggerInfo` | 291,952 | 4,083 | - | - |
|
||||
| `BenchmarkLoggerAsyncConcurrent` | 784,453 | 1,466 | - | - |
|
||||
|
||||
## 版本对比评估
|
||||
|
||||
| 版本 | 机制 | 存储格式 | 可视化 | 性能 (Async) |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| **v1.0.3** | Map 序列化 | JSON Object | 内置 | ~8,773 ns/op |
|
||||
| **v1.1.7** | Dead Code Removal | JSON Array | 独立工具/Meta | ~1,059 ns/op |
|
||||
| **v1.1.10** | Stability & Infrastructure | JSON Array | 独立工具/Meta | ~919 ns/op |
|
||||
| **v1.1.11** | **Absolute Indexing (Schema)** | **Fixed Array** | **LogType Opt** | **~1,466 ns/op** |
|
||||
|
||||
## 总结
|
||||
- **Schema 兼容性**: v1.1.11 实现了 `pos` 绝对索引。虽然因数组稀疏化(填充 0)导致序列化开销略微增加(~1.4µs),但换取了极强的 Schema 稳定性,适配各类数仓接入。
|
||||
- **可观测性**: 引入 `droppedLogs` 监控,解决了高并发场景下日志丢弃“黑盒”的问题。
|
||||
- **鲁棒性**: 替换为 UDP 拨号法获取 IP,消除了在 K8s 等复杂网络环境下的识别摩擦。
|
||||
## 单元测试报告
|
||||
|
||||
```text
|
||||
=== RUN TestLoggerCore_Initialization
|
||||
--- PASS: TestLoggerCore_Initialization (0.00s)
|
||||
=== RUN TestLoggerCore_Concurrency
|
||||
--- PASS: TestLoggerCore_Concurrency (0.00s)
|
||||
=== RUN TestMetaExtraction
|
||||
--- PASS: TestMetaExtraction (0.00s)
|
||||
=== RUN TestWithEntry
|
||||
--- PASS: TestWithEntry (0.00s)
|
||||
=== RUN TestLoggerReliability
|
||||
--- PASS: TestLoggerReliability (0.01s)
|
||||
=== RUN TestToArrayBytes
|
||||
serializer_test.go:64: Raw log: ["test-app","mock_info_test",1620000000,"abc-123","Hello, World!",{"user_id":42}]
|
||||
--- PASS: TestToArrayBytes (0.00s)
|
||||
=== RUN TestToArrayBytes_Desensitize
|
||||
--- PASS: TestToArrayBytes_Desensitize (0.00s)
|
||||
=== RUN TestSplitTag
|
||||
--- PASS: TestSplitTag (1.80s)
|
||||
=== RUN TestSensitiveDetailed
|
||||
--- PASS: TestSensitiveDetailed (0.00s)
|
||||
=== RUN TestDeepDesensitization
|
||||
--- PASS: TestDeepDesensitization (0.00s)
|
||||
=== RUN TestLogger
|
||||
--- PASS: TestLogger (0.00s)
|
||||
=== RUN TestDesensitization
|
||||
--- PASS: TestDesensitization (0.00s)
|
||||
=== RUN TestDBLog
|
||||
--- PASS: TestDBLog (0.00s)
|
||||
=== RUN TestRequestLog
|
||||
--- PASS: TestRequestLog (0.00s)
|
||||
=== RUN TestExtraLogs
|
||||
--- PASS: TestExtraLogs (0.00s)
|
||||
=== RUN TestViewable
|
||||
--- PASS: TestViewable (0.00s)
|
||||
=== RUN TestToJSON
|
||||
--- PASS: TestToJSON (0.00s)
|
||||
=== RUN TestLoadMeta
|
||||
--- PASS: TestLoadMeta (0.00s)
|
||||
=== RUN TestEnhancedViewable
|
||||
--- PASS: TestEnhancedViewable (0.00s)
|
||||
=== RUN TestEnhancedToJSON
|
||||
--- PASS: TestEnhancedToJSON (0.00s)
|
||||
=== RUN TestCallStacksViewable
|
||||
--- PASS: TestCallStacksViewable (0.00s)
|
||||
=== RUN TestPrecisionViewable
|
||||
--- PASS: TestPrecisionViewable (0.00s)
|
||||
PASS
|
||||
ok apigo.cc/go/log 2.246s
|
||||
```
|
||||
|
||||
## 核心指标验证
|
||||
- **初始化安全性**: `TestLoggerCore_Initialization` 确保 Logger 实例配置正确加载。
|
||||
- **高并发稳定性**: `TestLoggerCore_Concurrency` 验证了在多协程竞争环境下日志写入的线程安全。
|
||||
- **元数据驱动验证**: `TestMetaExtraction` 与 `TestLoadMeta` 确保 `.log.meta.json` 协议的解析与应用。
|
||||
- **序列化性能**: `TestToArrayBytes` 验证了 Positional Array 格式的正确性。
|
||||
- **深度脱敏能力**: `TestDeepDesensitization` 闭环验证了对复杂嵌套结构的脱敏逻辑。
|
||||
- **可靠性边界**: `TestLoggerReliability` 模拟了极高压力下的日志丢弃与缓冲策略。
|
||||
- **文件切分**: `TestSplitTag` 实测了基于时间滚动的文件切分能力。
|
||||
|
||||
@ -7,8 +7,8 @@ import (
|
||||
var DefaultLogger *Logger
|
||||
|
||||
func init() {
|
||||
RegisterWriterMaker("es", NewESWriter)
|
||||
RegisterWriterMaker("ess", NewESWriter)
|
||||
RegisterWriterMaker("es", newESWriter)
|
||||
RegisterWriterMaker("ess", newESWriter)
|
||||
|
||||
var conf Config
|
||||
_ = config.Load(&conf, "log")
|
||||
@ -19,3 +19,46 @@ func init() {
|
||||
func New(traceId string) *Logger {
|
||||
return DefaultLogger.New(traceId)
|
||||
}
|
||||
|
||||
// SetDefaultName 设置全局默认应用名称,并同步更新 DefaultLogger
|
||||
func SetDefaultName(name string) {
|
||||
if name == "" {
|
||||
return
|
||||
}
|
||||
globalDefaultName = name
|
||||
if DefaultLogger != nil {
|
||||
DefaultLogger.SetName(name)
|
||||
}
|
||||
}
|
||||
|
||||
// As 仿照 cast.As,使用 DefaultLogger 记录错误并返回零值 (消除摩擦)
|
||||
func As[T any](v T, err error) T {
|
||||
if err != nil {
|
||||
if DefaultLogger != nil {
|
||||
DefaultLogger.Error(err.Error())
|
||||
}
|
||||
var zero T
|
||||
return zero
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
// Debug 记录一条调试级别日志
|
||||
func Debug(message string, extra ...any) {
|
||||
DefaultLogger.Debug(message, extra...)
|
||||
}
|
||||
|
||||
// Info 记录一条信息级别日志
|
||||
func Info(message string, extra ...any) {
|
||||
DefaultLogger.Info(message, extra...)
|
||||
}
|
||||
|
||||
// Warning 记录一条警告级别日志
|
||||
func Warning(message string, extra ...any) {
|
||||
DefaultLogger.Warning(message, extra...)
|
||||
}
|
||||
|
||||
// Error 记录一条错误级别日志
|
||||
func Error(message string, extra ...any) {
|
||||
DefaultLogger.Error(message, extra...)
|
||||
}
|
||||
|
||||
12
es_writer.go
12
es_writer.go
@ -14,7 +14,7 @@ import (
|
||||
"apigo.cc/go/cast"
|
||||
)
|
||||
|
||||
type ESWriter struct {
|
||||
type esWriter struct {
|
||||
config *Config
|
||||
url string
|
||||
user string
|
||||
@ -27,8 +27,8 @@ type ESWriter struct {
|
||||
prefix string
|
||||
}
|
||||
|
||||
func NewESWriter(conf *Config) Writer {
|
||||
w := &ESWriter{
|
||||
func newESWriter(conf *Config) Writer {
|
||||
w := &esWriter{
|
||||
config: conf,
|
||||
queue: make([]string, 0),
|
||||
client: &http.Client{},
|
||||
@ -76,7 +76,7 @@ func NewESWriter(conf *Config) Writer {
|
||||
return w
|
||||
}
|
||||
|
||||
func (w *ESWriter) Log(entry LogEntry, data []byte) {
|
||||
func (w *esWriter) Log(entry LogEntry, data []byte) {
|
||||
objBytes, err := cast.ToJSONBytes(entry)
|
||||
if err != nil || len(objBytes) == 0 {
|
||||
return
|
||||
@ -90,14 +90,14 @@ func (w *ESWriter) Log(entry LogEntry, data []byte) {
|
||||
|
||||
var responseOkBytes = []byte("\"errors\":false")
|
||||
|
||||
func (w *ESWriter) Run() {
|
||||
func (w *esWriter) Run() {
|
||||
now := time.Now().Unix()
|
||||
w.lock.Lock()
|
||||
queueLen := len(w.queue)
|
||||
w.lock.Unlock()
|
||||
|
||||
// 超过100条数据 或 过了1秒 发送数据
|
||||
if queueLen > 100 || (queueLen > 0 && (now > w.last || !writerRunning.Load())) {
|
||||
if queueLen > 100 || (queueLen > 0 && (now > w.last || !WriterService.Running.Load())) {
|
||||
w.lock.Lock()
|
||||
sendings := w.queue
|
||||
w.queue = make([]string, 0)
|
||||
|
||||
@ -4,7 +4,6 @@ import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
@ -17,11 +16,6 @@ type FileWriter struct {
|
||||
bufWriter *bufio.Writer
|
||||
}
|
||||
|
||||
var (
|
||||
files = make(map[string]*FileWriter)
|
||||
filesLock sync.RWMutex
|
||||
)
|
||||
|
||||
// Write 由外层的 writerRunner 单协程调用,绝对并发安全,无需加锁
|
||||
func (f *FileWriter) Write(tm time.Time, data []byte) {
|
||||
nowSplit := tm.Format(f.splitTag)
|
||||
|
||||
@ -20,6 +20,7 @@ func TestSplitTag(t *testing.T) {
|
||||
File: logFile,
|
||||
SplitTag: splitTag,
|
||||
}
|
||||
log.WriterService.Start(nil, nil)
|
||||
logger := log.NewLogger(conf)
|
||||
|
||||
// 1. 记录第一条日志
|
||||
@ -78,7 +79,7 @@ func TestSensitiveDetailed(t *testing.T) {
|
||||
// 直接测试 ToArrayBytes
|
||||
// 注意:passed to ToArrayBytes 的 keys 应该是已经过 fixField 处理的
|
||||
sensitiveKeys := []string{"password", "secretkey"}
|
||||
buf := log.ToArrayBytes(entry, sensitiveKeys)
|
||||
buf := log.Marshal(entry, sensitiveKeys)
|
||||
result := string(buf)
|
||||
|
||||
if strings.Contains(result, "my_password") {
|
||||
@ -115,7 +116,7 @@ func TestDeepDesensitization(t *testing.T) {
|
||||
}
|
||||
|
||||
sensitiveKeys := []string{"password", "token"}
|
||||
buf := log.ToArrayBytes(entry, sensitiveKeys)
|
||||
buf := log.Marshal(entry, sensitiveKeys)
|
||||
result := string(buf)
|
||||
|
||||
// Check deep desensitization in map
|
||||
@ -133,4 +134,3 @@ func TestDeepDesensitization(t *testing.T) {
|
||||
t.Errorf("Safe data 'data_safe' should be present in: %s", result)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
20
go.mod
20
go.mod
@ -3,18 +3,18 @@ module apigo.cc/go/log
|
||||
go 1.25.0
|
||||
|
||||
require (
|
||||
apigo.cc/go/cast v1.2.8
|
||||
apigo.cc/go/config v1.0.6
|
||||
apigo.cc/go/file v1.0.6
|
||||
apigo.cc/go/id v1.0.5
|
||||
apigo.cc/go/shell v1.0.5
|
||||
apigo.cc/go/cast v1.3.3
|
||||
apigo.cc/go/config v1.3.1
|
||||
apigo.cc/go/file v1.3.2
|
||||
apigo.cc/go/id v1.3.1
|
||||
apigo.cc/go/shell v1.3.1
|
||||
)
|
||||
|
||||
require (
|
||||
apigo.cc/go/encoding v1.0.5 // indirect
|
||||
apigo.cc/go/rand v1.0.5 // indirect
|
||||
apigo.cc/go/safe v1.0.5 // indirect
|
||||
golang.org/x/crypto v0.50.0 // indirect
|
||||
golang.org/x/sys v0.43.0 // indirect
|
||||
apigo.cc/go/encoding v1.3.1 // indirect
|
||||
apigo.cc/go/rand v1.3.1 // indirect
|
||||
apigo.cc/go/safe v1.3.1 // indirect
|
||||
golang.org/x/crypto v0.51.0 // indirect
|
||||
golang.org/x/sys v0.44.0 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
||||
40
go.sum
40
go.sum
@ -1,29 +1,29 @@
|
||||
apigo.cc/go/cast v1.2.8 h1:plb676DH2TjYljzf8OEMGT6lIhmZ/xaxEFfs0kDOiSI=
|
||||
apigo.cc/go/cast v1.2.8/go.mod h1:lGlwImiOvHxG7buyMWhFzcdvQzmSaoKbmr7bcDfUpHk=
|
||||
apigo.cc/go/config v1.0.6 h1:32nOCr+8AkGFnKuythCjHPOjxilg6SOlSWXKTkNtx6I=
|
||||
apigo.cc/go/config v1.0.6/go.mod h1:nX+nLKZTP6Xton9Gt/9XsTh0d1sQ+Qkwysgyjq/k4R0=
|
||||
apigo.cc/go/encoding v1.0.5 h1:a2XbXyd8D2gKo1ekXn/pt5adltWbIfdJCMhaF2uvzF0=
|
||||
apigo.cc/go/encoding v1.0.5/go.mod h1:V5CgT7rBbCxy+uCU20q0ptcNNRSgMtpA8cNOs6r8IeI=
|
||||
apigo.cc/go/file v1.0.6 h1:kyrPJ+oqC0DtYubX2aI+3QIVoDAPkRiYyBwd1F0cBlA=
|
||||
apigo.cc/go/file v1.0.6/go.mod h1:AOw8+3q1fmCZpBWpBfUSSb+Q6Li3W9jH1EktQXmFhVg=
|
||||
apigo.cc/go/id v1.0.5 h1:23YkR7oklSA69gthYlu8zl/kpIkeIoEYxi1f1Sz5l3A=
|
||||
apigo.cc/go/id v1.0.5/go.mod h1:ZaYLIyrJvkf3j7J8a0lnKywSAHljaczWxU0x2HmQDzg=
|
||||
apigo.cc/go/rand v1.0.5 h1:AkUoWr0SELgeDmRjLEDjOIp29nXdzqQQvmGRIHpTN7U=
|
||||
apigo.cc/go/rand v1.0.5/go.mod h1:mZ/4Soa3bk+XvDaqPWJuUe1bfEi4eThBj1XmEAuYxsk=
|
||||
apigo.cc/go/safe v1.0.5 h1:yZJLhpMntJrtqU/ev0UlyOoHu/cLrnnGUO4aHyIZcwE=
|
||||
apigo.cc/go/safe v1.0.5/go.mod h1:i9xnh7reJIFPauLnlzuIDgvrQvhjxpFlpVh3O6ulWd0=
|
||||
apigo.cc/go/shell v1.0.5 h1:bmvUTJGe1GwsHAy42v3iaoK40PoBC7Xq1aMCYxUZmtg=
|
||||
apigo.cc/go/shell v1.0.5/go.mod h1:sx/nYw5CihHWmo5JHkaZUbmMYXNHx8swzArbQCUGHjc=
|
||||
apigo.cc/go/cast v1.3.3 h1:aln5eDR5DZVWVzZ/y5SJh1gQNgWv2sT82I25NaO9g34=
|
||||
apigo.cc/go/cast v1.3.3/go.mod h1:lGlwImiOvHxG7buyMWhFzcdvQzmSaoKbmr7bcDfUpHk=
|
||||
apigo.cc/go/config v1.3.1 h1:wZzUh4oL+fGD6SayVgX6prLPMsniM25etWFcEH8XzIE=
|
||||
apigo.cc/go/config v1.3.1/go.mod h1:7KHz/1WmtBLM762Lln/TaXh2dmlMvJTLhnlk33zbS3U=
|
||||
apigo.cc/go/encoding v1.3.1 h1:y8O58KYAyulkThg1O2ji2BqjnFoSvk42sit9I3z+K7Y=
|
||||
apigo.cc/go/encoding v1.3.1/go.mod h1:xAJk5b83VZ31mXMTnyp0dfMoBKfT/AHDn0u+cQfojgY=
|
||||
apigo.cc/go/file v1.3.2 h1:pu4oiDyiqgj3/eykfnJf+/6+A9v/Z0b3ClP5XK+lwG4=
|
||||
apigo.cc/go/file v1.3.2/go.mod h1:vci4h0Pz94mV6dkniQkuyBYERVYeq7/LX4jJVuCg9hs=
|
||||
apigo.cc/go/id v1.3.1 h1:pkqi6VeWyQoHuIu0Zbx/RRxIAdM61Js0j6cY1M9XVCk=
|
||||
apigo.cc/go/id v1.3.1/go.mod h1:P2/vl3tyW3US+ayOFSMoPIOCulNLBngNYPhXJC/Z7J4=
|
||||
apigo.cc/go/rand v1.3.1 h1:7FvsI6PtQ5XrWER0dTiLVo0p7GIxRidT/TBKhVy93j8=
|
||||
apigo.cc/go/rand v1.3.1/go.mod h1:mZ/4Soa3bk+XvDaqPWJuUe1bfEi4eThBj1XmEAuYxsk=
|
||||
apigo.cc/go/safe v1.3.1 h1:irTCqPAC97gGsX/Lw5AzLelDt1xXLEZIAaVhLELWe9Q=
|
||||
apigo.cc/go/safe v1.3.1/go.mod h1:XdOpBhN2vkImalaykYXXmEpczqWa1y3ah6/Q72cdRqE=
|
||||
apigo.cc/go/shell v1.3.1 h1:M8oD0b2HcJuCC6frQFx11b3UTcTx3lATX8XK+YXSVm8=
|
||||
apigo.cc/go/shell v1.3.1/go.mod h1:ZMdJjpCpWdvsHKUXlelh/AxsV/nWdkH/k3lISfzMdUw=
|
||||
github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
|
||||
github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk=
|
||||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
|
||||
github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
|
||||
golang.org/x/crypto v0.50.0 h1:zO47/JPrL6vsNkINmLoo/PH1gcxpls50DNogFvB5ZGI=
|
||||
golang.org/x/crypto v0.50.0/go.mod h1:3muZ7vA7PBCE6xgPX7nkzzjiUq87kRItoJQM1Yo8S+Q=
|
||||
golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
|
||||
golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
golang.org/x/crypto v0.51.0 h1:IBPXwPfKxY7cWQZ38ZCIRPI50YLeevDLlLnyC5wRGTI=
|
||||
golang.org/x/crypto v0.51.0/go.mod h1:8AdwkbraGNABw2kOX6YFPs3WM22XqI4EXEd8g+x7Oc8=
|
||||
golang.org/x/sys v0.44.0 h1:ildZl3J4uzeKP07r2F++Op7E9B29JRUy+a27EibtBTQ=
|
||||
golang.org/x/sys v0.44.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
|
||||
|
||||
26
log_test.go
26
log_test.go
@ -1,6 +1,7 @@
|
||||
package log_test
|
||||
|
||||
import (
|
||||
"strconv"
|
||||
"testing"
|
||||
|
||||
"apigo.cc/go/log"
|
||||
@ -86,3 +87,28 @@ func TestExtraLogs(t *testing.T) {
|
||||
|
||||
logger.Info("Extra log test", "key", "value")
|
||||
}
|
||||
|
||||
func TestAs(t *testing.T) {
|
||||
// 1. 测试 log.As (使用 DefaultLogger)
|
||||
val1 := log.As(strconv.Atoi("123"))
|
||||
if val1 != 123 {
|
||||
t.Errorf("log.As expected 123, got %v", val1)
|
||||
}
|
||||
|
||||
val2 := log.As(strconv.Atoi("abc"))
|
||||
if val2 != 0 {
|
||||
t.Errorf("log.As expected 0, got %v", val2)
|
||||
}
|
||||
|
||||
// 2. 测试 logger.As (方法)
|
||||
logger := log.NewLogger(log.Config{Level: "debug"})
|
||||
val3 := logger.As(strconv.Atoi("456")).(int)
|
||||
if val3 != 456 {
|
||||
t.Errorf("logger.As expected 456, got %v", val3)
|
||||
}
|
||||
|
||||
val4 := logger.As(strconv.Atoi("def")).(int)
|
||||
if val4 != 0 {
|
||||
t.Errorf("logger.As expected 0, got %v", val4)
|
||||
}
|
||||
}
|
||||
|
||||
46
logger.go
46
logger.go
@ -43,12 +43,12 @@ func NewLogger(conf Config) *Logger {
|
||||
}
|
||||
|
||||
if conf.Name == "" {
|
||||
conf.Name = GetDefaultName()
|
||||
conf.Name = getDefaultName()
|
||||
}
|
||||
|
||||
logger := Logger{
|
||||
truncations: cast.Split(conf.Truncations, ","),
|
||||
traceId: id.MakeID(10),
|
||||
traceId: id.Get10Bytes14MPerSecond(),
|
||||
}
|
||||
|
||||
if len(conf.Sensitive) > 0 {
|
||||
@ -78,29 +78,27 @@ func NewLogger(conf Config) *Logger {
|
||||
if m, ok := writerMakers[writerName]; ok {
|
||||
if w := m(&conf); w != nil {
|
||||
logger.writer = w
|
||||
writerLock.Lock()
|
||||
cur := writers.Load().([]Writer)
|
||||
WriterService.WriterLock.Lock()
|
||||
cur := WriterService.Writers.Load().([]Writer)
|
||||
newW := append(cur, w)
|
||||
writers.Store(newW)
|
||||
writerLock.Unlock()
|
||||
Start()
|
||||
WriterService.Writers.Store(newW)
|
||||
WriterService.WriterLock.Unlock()
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if conf.SplitTag != "" {
|
||||
filesLock.RLock()
|
||||
logger.file = files[conf.File+conf.SplitTag]
|
||||
filesLock.RUnlock()
|
||||
WriterService.FilesLock.RLock()
|
||||
logger.file = WriterService.Files[conf.File+conf.SplitTag]
|
||||
WriterService.FilesLock.RUnlock()
|
||||
if logger.file == nil {
|
||||
logger.file = &FileWriter{
|
||||
fileName: conf.File,
|
||||
splitTag: conf.SplitTag,
|
||||
}
|
||||
filesLock.Lock()
|
||||
files[conf.File+conf.SplitTag] = logger.file
|
||||
filesLock.Unlock()
|
||||
WriterService.FilesLock.Lock()
|
||||
WriterService.Files[conf.File+conf.SplitTag] = logger.file
|
||||
WriterService.FilesLock.Unlock()
|
||||
}
|
||||
Start()
|
||||
} else {
|
||||
fp, err := os.OpenFile(conf.File, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
|
||||
if err == nil {
|
||||
@ -118,14 +116,14 @@ func (logger *Logger) Log(entry LogEntry) {
|
||||
}
|
||||
|
||||
func (logger *Logger) asyncWrite(entry LogEntry) {
|
||||
buf := ToArrayBytes(entry, logger.sensitiveKeys)
|
||||
buf := Marshal(entry, logger.sensitiveKeys)
|
||||
logger.writeBuf(entry, buf)
|
||||
PutEntry(entry)
|
||||
putEntry(entry)
|
||||
}
|
||||
|
||||
func (logger *Logger) writeBuf(entry LogEntry, buf []byte) {
|
||||
if writerRunning.Load() {
|
||||
WriteAsync(logPayload{
|
||||
if WriterService.Running.Load() {
|
||||
writeAsync(logPayload{
|
||||
entry: entry,
|
||||
buf: buf,
|
||||
writer: logger.writer,
|
||||
@ -238,6 +236,10 @@ func (logger *Logger) Error(message string, extra ...any) {
|
||||
}
|
||||
}
|
||||
|
||||
func (logger *Logger) SetName(name string) {
|
||||
logger.config.Name = name
|
||||
}
|
||||
|
||||
func (logger *Logger) SetLevel(level LevelType) {
|
||||
logger.level = level
|
||||
}
|
||||
@ -252,6 +254,14 @@ func (logger *Logger) GetTraceId() string {
|
||||
return logger.traceId
|
||||
}
|
||||
|
||||
// As 仿照 cast.As,忽略错误并返回零值,但会将错误记录到日志中 (消除摩擦)
|
||||
func (logger *Logger) As(v any, err error) any {
|
||||
if err != nil {
|
||||
logger.Error(err.Error())
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
func (logger *Logger) CheckLevel(logLevel LevelType) bool {
|
||||
settedLevel := logger.level
|
||||
if settedLevel == 0 {
|
||||
|
||||
21
name_test.go
Normal file
21
name_test.go
Normal file
@ -0,0 +1,21 @@
|
||||
package log
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestSetDefaultName(t *testing.T) {
|
||||
oldName := getDefaultName()
|
||||
defer SetDefaultName(oldName)
|
||||
|
||||
newName := "test-service-name"
|
||||
SetDefaultName(newName)
|
||||
|
||||
if getDefaultName() != newName {
|
||||
t.Errorf("GetDefaultName() = %v, want %v", getDefaultName(), newName)
|
||||
}
|
||||
|
||||
if DefaultLogger.config.Name != newName {
|
||||
t.Errorf("DefaultLogger.config.Name = %v, want %v", DefaultLogger.config.Name, newName)
|
||||
}
|
||||
}
|
||||
6
pool.go
6
pool.go
@ -33,8 +33,8 @@ func GetEntry[T any]() *T {
|
||||
return entry
|
||||
}
|
||||
|
||||
// PutEntry 将日志对象归还到池中
|
||||
func PutEntry(entry any) {
|
||||
// putEntry 将日志对象归还到池中
|
||||
func putEntry(entry any) {
|
||||
t := reflect.TypeOf(entry)
|
||||
if pool, ok := globalPools.pools.Load(t); ok {
|
||||
pool.(*sync.Pool).Put(entry)
|
||||
@ -44,7 +44,7 @@ func PutEntry(entry any) {
|
||||
// WithEntry 执行闭包并在结束后自动回收对象
|
||||
func WithEntry[T any](fn func(*T)) {
|
||||
entry := GetEntry[T]()
|
||||
defer PutEntry(entry)
|
||||
defer putEntry(entry)
|
||||
fn(entry)
|
||||
}
|
||||
|
||||
|
||||
@ -28,8 +28,7 @@ func TestLoggerReliability(t *testing.T) {
|
||||
}
|
||||
|
||||
wg.Wait()
|
||||
Stop()
|
||||
Wait()
|
||||
WriterService.Stop(nil)
|
||||
|
||||
file, err := os.Open(logFile)
|
||||
if err != nil {
|
||||
|
||||
@ -90,7 +90,8 @@ func getAccessors(logType string, model any) []fieldAccessor {
|
||||
return accessors
|
||||
}
|
||||
|
||||
func ToArrayBytes(entry LogEntry, sensitiveKeys []string) []byte {
|
||||
// donot export this function
|
||||
func Marshal(entry LogEntry, sensitiveKeys []string) []byte {
|
||||
var buf bytes.Buffer
|
||||
buf.WriteByte('[')
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ func TestToArrayBytes(t *testing.T) {
|
||||
|
||||
RegisterType("mock_info_test", entry) // trigger meta generation
|
||||
|
||||
bytes := ToArrayBytes(entry, nil)
|
||||
bytes := Marshal(entry, nil)
|
||||
str := string(bytes)
|
||||
t.Logf("Raw log: %s", str)
|
||||
|
||||
@ -113,7 +113,7 @@ func TestToArrayBytes_Desensitize(t *testing.T) {
|
||||
|
||||
RegisterType("mock_info_test2", entry)
|
||||
|
||||
bytes := ToArrayBytes(entry, []string{"password"})
|
||||
bytes := Marshal(entry, []string{"password"})
|
||||
str := string(bytes)
|
||||
|
||||
var arr []any
|
||||
|
||||
118
utility.go
118
utility.go
@ -1,7 +1,6 @@
|
||||
package log
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net"
|
||||
"os"
|
||||
@ -9,9 +8,6 @@ import (
|
||||
"runtime"
|
||||
"runtime/debug"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"apigo.cc/go/cast"
|
||||
)
|
||||
|
||||
var (
|
||||
@ -49,103 +45,6 @@ func init() {
|
||||
}
|
||||
}
|
||||
|
||||
// MakeTime 解析纳秒时间戳或 RFC3339 字符串
|
||||
func MakeTime(v any) time.Time {
|
||||
if ts, ok := cast.ToInt64E(v); ok == nil {
|
||||
return time.Unix(0, ts)
|
||||
}
|
||||
tm, _ := time.Parse(time.RFC3339Nano, cast.String(v))
|
||||
return tm
|
||||
}
|
||||
|
||||
// MakeUsedTime 计算消耗时间(毫秒)
|
||||
func MakeUsedTime(startTime, endTime time.Time) float32 {
|
||||
return float32(endTime.UnixNano()-startTime.UnixNano()) / 1e6
|
||||
}
|
||||
|
||||
// ParseBaseLog 解析基础日志行
|
||||
func ParseBaseLog(line string) *BaseLog {
|
||||
pos := strings.IndexByte(line, '{')
|
||||
if pos == -1 {
|
||||
return ParseBadLog(line)
|
||||
}
|
||||
|
||||
l := make(map[string]any)
|
||||
err := json.Unmarshal([]byte(line[pos:]), &l)
|
||||
if err != nil {
|
||||
return ParseBadLog(line)
|
||||
}
|
||||
|
||||
baseLog := BaseLog{Extra: make(map[string]any)}
|
||||
for k, v := range l {
|
||||
lk := strings.ToLower(k)
|
||||
switch lk {
|
||||
case "logname":
|
||||
baseLog.LogName = cast.String(v)
|
||||
case "logtype":
|
||||
baseLog.LogType = cast.String(v)
|
||||
case "logtime":
|
||||
baseLog.LogTime = cast.Int64(v)
|
||||
case "traceid":
|
||||
baseLog.TraceId = cast.String(v)
|
||||
case "imagename":
|
||||
if baseLog.Image != "" {
|
||||
baseLog.Image = cast.String(v) + ":" + baseLog.Image
|
||||
} else {
|
||||
baseLog.Image = cast.String(v)
|
||||
}
|
||||
case "imagetag":
|
||||
if baseLog.Image != "" {
|
||||
baseLog.Image = baseLog.Image + ":" + cast.String(v)
|
||||
} else {
|
||||
baseLog.Image = cast.String(v)
|
||||
}
|
||||
case "servername":
|
||||
if baseLog.Server != "" {
|
||||
baseLog.Server = cast.String(v) + ":" + baseLog.Server
|
||||
} else {
|
||||
baseLog.Server = cast.String(v)
|
||||
}
|
||||
case "serverip":
|
||||
if baseLog.Server != "" {
|
||||
baseLog.Server = baseLog.Server + ":" + cast.String(v)
|
||||
} else {
|
||||
baseLog.Server = cast.String(v)
|
||||
}
|
||||
default:
|
||||
baseLog.Extra[lk] = v
|
||||
}
|
||||
}
|
||||
return &baseLog
|
||||
}
|
||||
|
||||
// ParseBadLog 解析非 JSON 格式的日志
|
||||
func ParseBadLog(line string) *BaseLog {
|
||||
baseLog := BaseLog{Extra: make(map[string]any)}
|
||||
baseLog.LogType = LogTypeUndefined
|
||||
if len(line) > 19 && line[19] == ' ' {
|
||||
tm, err := time.Parse("2006/01/02 15:04:05", line[0:19])
|
||||
if err == nil {
|
||||
baseLog.LogTime = tm.UnixNano()
|
||||
line = line[20:]
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
} else if len(line) > 26 && line[26] == ' ' {
|
||||
tm, err := time.Parse("2006/01/02 15:04:05.000000", line[0:26])
|
||||
if err == nil {
|
||||
baseLog.LogTime = tm.UnixNano()
|
||||
line = line[27:]
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
} else {
|
||||
return nil
|
||||
}
|
||||
baseLog.Extra["info"] = line
|
||||
return &baseLog
|
||||
}
|
||||
|
||||
// fixField 格式化字段名(去横线、下划线,小写)
|
||||
func fixField(s string) string {
|
||||
s = strings.ReplaceAll(s, "-", "")
|
||||
@ -170,6 +69,7 @@ func getCallStacks(truncations []string) []string {
|
||||
isLogInternal := (strings.Contains(file, "/log/logger.go") ||
|
||||
strings.Contains(file, "/log/utility.go") ||
|
||||
strings.Contains(file, "/log/standard.go") ||
|
||||
strings.Contains(file, "/log/default_logger.go") ||
|
||||
strings.Contains(file, "/log/extra.go"))
|
||||
|
||||
if isLogInternal {
|
||||
@ -192,19 +92,21 @@ func getCallStacks(truncations []string) []string {
|
||||
return callStacks
|
||||
}
|
||||
|
||||
// GetDefaultName 获取默认应用名称
|
||||
func GetDefaultName() string {
|
||||
name := os.Getenv("DISCOVER_APP")
|
||||
if name == "" {
|
||||
name = os.Getenv("discover_app")
|
||||
var globalDefaultName string
|
||||
|
||||
// getDefaultName 获取默认应用名称
|
||||
func getDefaultName() string {
|
||||
if globalDefaultName != "" {
|
||||
return globalDefaultName
|
||||
}
|
||||
if name == "" {
|
||||
name := ""
|
||||
if info, ok := debug.ReadBuildInfo(); ok && info.Path != "" && info.Path != "command-line-arguments" {
|
||||
name = path.Base(info.Path)
|
||||
}
|
||||
}
|
||||
if name == "" {
|
||||
name = path.Base(os.Args[0])
|
||||
}
|
||||
// 处理 Windows 下的 .exe 后缀
|
||||
name = strings.TrimSuffix(name, ".exe")
|
||||
return name
|
||||
}
|
||||
|
||||
@ -20,7 +20,7 @@ func TestViewable(t *testing.T) {
|
||||
}
|
||||
log.RegisterType("info", entry)
|
||||
|
||||
line := string(log.ToArrayBytes(entry, nil))
|
||||
line := string(log.Marshal(entry, nil))
|
||||
out := log.Viewable(line)
|
||||
|
||||
if !strings.Contains(out, "hello world") {
|
||||
@ -44,7 +44,7 @@ func TestToJSON(t *testing.T) {
|
||||
entry.Extra = map[string]any{"key": "value"}
|
||||
log.RegisterType("info", entry)
|
||||
|
||||
line := string(log.ToArrayBytes(entry, nil))
|
||||
line := string(log.Marshal(entry, nil))
|
||||
jsonStr := log.ToJSON(line)
|
||||
|
||||
if !strings.Contains(jsonStr, `"Info":"hello world"`) {
|
||||
@ -112,7 +112,7 @@ func TestEnhancedViewable(t *testing.T) {
|
||||
}
|
||||
log.RegisterType("enhanced", entry)
|
||||
|
||||
line := string(log.ToArrayBytes(entry, nil))
|
||||
line := string(log.Marshal(entry, nil))
|
||||
out := log.Viewable(line)
|
||||
|
||||
// Check attachBefore: MyApp:Node1 (since both are withoutkey)
|
||||
@ -155,7 +155,7 @@ func TestEnhancedToJSON(t *testing.T) {
|
||||
}
|
||||
log.RegisterType("enhanced", entry)
|
||||
|
||||
line := string(log.ToArrayBytes(entry, nil))
|
||||
line := string(log.Marshal(entry, nil))
|
||||
jsonStr := log.ToJSON(line)
|
||||
|
||||
// Check keyname in JSON
|
||||
@ -181,14 +181,14 @@ func TestCallStacksViewable(t *testing.T) {
|
||||
wd, _ := os.Getwd()
|
||||
entry := &CallStackLog{
|
||||
BaseLog: log.BaseLog{
|
||||
LogType: "error",
|
||||
LogType: "test_error",
|
||||
LogTime: 1714896000000000000,
|
||||
},
|
||||
CallStacks: []string{wd + "/main.go:10", "/usr/local/go/src/runtime/panic.go:100"},
|
||||
}
|
||||
log.RegisterType("error", entry)
|
||||
log.RegisterType("test_error", entry)
|
||||
|
||||
line := string(log.ToArrayBytes(entry, nil))
|
||||
line := string(log.Marshal(entry, nil))
|
||||
out := log.Viewable(line)
|
||||
|
||||
// Check path truncation (should contain relative "main.go:10")
|
||||
@ -221,7 +221,7 @@ func TestPrecisionViewable(t *testing.T) {
|
||||
}
|
||||
log.RegisterType("precision", entry)
|
||||
|
||||
line := string(log.ToArrayBytes(entry, nil))
|
||||
line := string(log.Marshal(entry, nil))
|
||||
out := log.Viewable(line)
|
||||
|
||||
if !strings.Contains(out, "3.14") || strings.Contains(out, "3.141") {
|
||||
|
||||
111
writer.go
111
writer.go
@ -1,6 +1,7 @@
|
||||
package log
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
@ -21,13 +22,22 @@ type logPayload struct {
|
||||
file *FileWriter // 目标文件 Writer
|
||||
}
|
||||
|
||||
// writerService manages the background writing of log entries.
|
||||
type writerService struct {
|
||||
Running atomic.Bool
|
||||
StopChan chan bool
|
||||
LogChannel chan logPayload
|
||||
Dropped atomic.Uint64
|
||||
Writers atomic.Value // []Writer
|
||||
WriterLock sync.Mutex
|
||||
|
||||
Files map[string]*FileWriter
|
||||
FilesLock sync.RWMutex
|
||||
}
|
||||
|
||||
var (
|
||||
writerRunning atomic.Bool
|
||||
writerLock sync.Mutex // 仅用于注册时锁定
|
||||
writerStopChan chan bool
|
||||
writers atomic.Value // 存储 []Writer
|
||||
logChannel chan logPayload
|
||||
droppedLogs atomic.Uint64
|
||||
// WriterService is the global instance of defaultService.
|
||||
WriterService = &writerService{}
|
||||
)
|
||||
|
||||
// ConsoleWriter 控制台写入器
|
||||
@ -42,26 +52,28 @@ func (w *ConsoleWriter) Run() {
|
||||
}
|
||||
|
||||
func init() {
|
||||
logChannel = make(chan logPayload, 10000)
|
||||
writers.Store([]Writer{})
|
||||
WriterService.LogChannel = make(chan logPayload, 10000)
|
||||
WriterService.Writers.Store([]Writer{})
|
||||
WriterService.Files = make(map[string]*FileWriter)
|
||||
|
||||
RegisterWriterMaker("console", func(conf *Config) Writer {
|
||||
return &ConsoleWriter{}
|
||||
})
|
||||
}
|
||||
|
||||
// WriteAsync 异步写入日志
|
||||
func WriteAsync(payload logPayload) {
|
||||
// writeAsync 异步写入日志
|
||||
func writeAsync(payload logPayload) {
|
||||
defer func() {
|
||||
recover()
|
||||
}()
|
||||
if !writerRunning.Load() {
|
||||
if !WriterService.Running.Load() {
|
||||
return
|
||||
}
|
||||
select {
|
||||
case logChannel <- payload:
|
||||
case WriterService.LogChannel <- payload:
|
||||
default:
|
||||
// 丢弃或处理过载
|
||||
dropped := droppedLogs.Add(1)
|
||||
dropped := WriterService.Dropped.Add(1)
|
||||
if dropped%1000 == 1 {
|
||||
if DefaultLogger != nil {
|
||||
// 注意:这里可能会产生递归调用,但 select default 保证了不会死锁
|
||||
@ -73,74 +85,79 @@ func WriteAsync(payload logPayload) {
|
||||
|
||||
// GetDroppedLogs 获取被丢弃的日志数量
|
||||
func GetDroppedLogs() uint64 {
|
||||
return droppedLogs.Load()
|
||||
return WriterService.Dropped.Load()
|
||||
}
|
||||
|
||||
// Start 启动写入器
|
||||
func Start() {
|
||||
if !writerRunning.CompareAndSwap(false, true) {
|
||||
return
|
||||
// Start implements starter.Service interface.
|
||||
func (s *writerService) Start(_ context.Context, _ *Logger) error {
|
||||
if !s.Running.CompareAndSwap(false, true) {
|
||||
return nil
|
||||
}
|
||||
writerStopChan = make(chan bool)
|
||||
go writerRunner()
|
||||
s.StopChan = make(chan bool)
|
||||
go s.writerRunner()
|
||||
return nil
|
||||
}
|
||||
|
||||
// Stop 停止写入器
|
||||
func Stop() {
|
||||
if writerRunning.CompareAndSwap(true, false) {
|
||||
close(logChannel)
|
||||
// Stop implements starter.Service interface.
|
||||
func (s *writerService) Stop(_ context.Context) error {
|
||||
if s.Running.CompareAndSwap(true, false) {
|
||||
close(s.LogChannel)
|
||||
if s.StopChan != nil {
|
||||
<-s.StopChan
|
||||
s.StopChan = nil
|
||||
}
|
||||
}
|
||||
|
||||
// Wait 等待写入器停止
|
||||
func Wait() {
|
||||
if writerStopChan != nil {
|
||||
<-writerStopChan
|
||||
writerStopChan = nil
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func writerRunner() {
|
||||
// Status implements starter.Service interface.
|
||||
func (s *writerService) Status() (string, error) {
|
||||
if s.Running.Load() {
|
||||
return fmt.Sprintf("queue: %d, dropped: %d", len(s.LogChannel), s.Dropped.Load()), nil
|
||||
}
|
||||
return "stopped", nil
|
||||
}
|
||||
func (s *writerService) writerRunner() {
|
||||
ticker := time.NewTicker(200 * time.Millisecond)
|
||||
defer ticker.Stop()
|
||||
|
||||
defer func() {
|
||||
if writerStopChan != nil {
|
||||
close(writerStopChan)
|
||||
if s.StopChan != nil {
|
||||
close(s.StopChan)
|
||||
}
|
||||
}()
|
||||
|
||||
for {
|
||||
select {
|
||||
case payload, ok := <-logChannel:
|
||||
case payload, ok := <-s.LogChannel:
|
||||
if !ok {
|
||||
flushWriters()
|
||||
s.flushWriters()
|
||||
return
|
||||
}
|
||||
processLog(payload)
|
||||
s.processLog(payload)
|
||||
|
||||
// 尝试批量处理更多日志
|
||||
batchCount := 0
|
||||
for batchCount < 100 {
|
||||
select {
|
||||
case nextPayload, nextOk := <-logChannel:
|
||||
case nextPayload, nextOk := <-s.LogChannel:
|
||||
if !nextOk {
|
||||
flushWriters()
|
||||
s.flushWriters()
|
||||
return
|
||||
}
|
||||
processLog(nextPayload)
|
||||
s.processLog(nextPayload)
|
||||
batchCount++
|
||||
default:
|
||||
batchCount = 100 // break outer loop
|
||||
}
|
||||
}
|
||||
case <-ticker.C:
|
||||
flushWriters()
|
||||
s.flushWriters()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func processLog(payload logPayload) {
|
||||
func (s *writerService) processLog(payload logPayload) {
|
||||
// 精准路由:根据包裹信息决定写入目标
|
||||
if payload.writer != nil {
|
||||
payload.writer.Log(payload.entry, payload.buf)
|
||||
@ -149,15 +166,15 @@ func processLog(payload logPayload) {
|
||||
}
|
||||
}
|
||||
|
||||
func flushWriters() {
|
||||
curWriters, _ := writers.Load().([]Writer)
|
||||
func (s *writerService) flushWriters() {
|
||||
curWriters, _ := s.Writers.Load().([]Writer)
|
||||
for _, w := range curWriters {
|
||||
w.Run()
|
||||
}
|
||||
|
||||
filesLock.RLock()
|
||||
for _, f := range files {
|
||||
s.FilesLock.RLock()
|
||||
for _, f := range s.Files {
|
||||
f.Run()
|
||||
}
|
||||
filesLock.RUnlock()
|
||||
s.FilesLock.RUnlock()
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user