Survey
暂无介绍...
目录导航
列出了该 package 下所有的函数及类型定义，可通过目录导航进行快捷跳转 ❤️
展开 / 折叠目录导航
包级函数定义
| 函数名称 | 描述 |
|---|---|
| NewFileFlusher | 创建一个文件刷新器 |
| WithFlushInterval | 设置日志文件刷新间隔 |
| Reg | 注册一个运营日志记录器 |
| Record | 记录一条运营日志 |
| RecordBytes | 记录一条运营日志 |
| Flush | 将运营日志记录器的缓冲区数据写入到文件 |
| Close | 关闭运营日志记录器 |
| Analyze | 分析特定文件的记录，当发生错误时，会发生 panic |
| AnalyzeMulti | 与 Analyze 类似，但是可以分析多个文件 |
| IncrementAnalyze | 增量分析，返回一个函数，每次调用该函数都会分析文件中新增的内容 |
类型定义
| 类型 | 名称 | 描述 |
|---|---|---|
STRUCT |
Analyzer | 分析器 |
INTERFACE |
Flusher | 用于刷新缓冲区的接口 |
STRUCT |
FileFlusher | 暂无描述... |
STRUCT |
Option | 选项 |
STRUCT |
Result | 暂无描述... |
STRUCT |
R | 记录器所记录的一条数据 |
STRUCT |
Report | 分析报告 |
详情信息
func NewFileFlusher(filePath string, layout ...string) *FileFlusher
创建一个文件刷新器
- layout 为日志文件名的时间戳格式 (默认为 time.DateOnly)
func WithFlushInterval(interval time.Duration) Option
设置日志文件刷新间隔
- 默认为 3s，当日志文件刷新间隔 <= 0 时，将会在每次写入日志时刷新日志文件
func Reg(name string, flusher Flusher, options ...Option)
注册一个运营日志记录器
func Record(name string, data map[string]any)
记录一条运营日志
func RecordBytes(name string, data []byte)
记录一条运营日志
func Flush(names ...string)
将运营日志记录器的缓冲区数据写入到文件
- name 为空时，将所有记录器的缓冲区数据写入到文件
func Close(names ...string)
关闭运营日志记录器
func Analyze(filePath string, handle func (analyzer *Analyzer, record R)) *Report
分析特定文件的记录，当发生错误时，会发生 panic
- handle 为并行执行的，需要自行处理并发安全
- 适用于外部进程对于日志文件的读取，但是需要注意的是，此时日志文件可能正在被写入，所以可能会读取到错误的数据
func AnalyzeMulti(filePaths []string, handle func (analyzer *Analyzer, record R)) *Report
与 Analyze 类似，但是可以分析多个文件
func IncrementAnalyze(filePath string, handle func (analyzer *Analyzer, record R)) func () ( *Report, error)
增量分析，返回一个函数，每次调用该函数都会分析文件中新增的内容
查看 / 收起单元测试
func TestIncrementAnalyze(t *testing.T) {
path := `./test/day.2023-09-06.log`
reader := survey.IncrementAnalyze(path, func(analyzer *survey.Analyzer, record survey.R) {
switch record.GetString("type") {
case "open_conn":
analyzer.IncreaseValueNonRepeat("开播人数", record, 1, "live_id")
case "report_rank":
analyzer.IncreaseValue("开始游戏次数", 1)
analyzer.Increase("开播时长", record, "game_time")
analyzer.Sub(record.GetString("live_id")).IncreaseValue("开始游戏次数", 1)
analyzer.Sub(record.GetString("live_id")).Increase("开播时长", record, "game_time")
case "statistics":
analyzer.IncreaseValueNonRepeat("活跃人数", record, 1, "active_player")
analyzer.IncreaseValueNonRepeat("评论人数", record, 1, "comment_player")
analyzer.IncreaseValueNonRepeat("点赞人数", record, 1, "like_player")
analyzer.Sub(record.GetString("live_id")).IncreaseValueNonRepeat("活跃人数", record, 1, "active_player")
analyzer.Sub(record.GetString("live_id")).IncreaseValueNonRepeat("评论人数", record, 1, "comment_player")
analyzer.Sub(record.GetString("live_id")).IncreaseValueNonRepeat("点赞人数", record, 1, "like_player")
giftId := record.GetString("gift.gift_id")
if len(giftId) > 0 {
giftPrice := record.GetFloat64("gift.price")
giftCount := record.GetFloat64("gift.count")
giftSender := record.GetString("gift.gift_senders")
analyzer.IncreaseValue("礼物总价值", giftPrice*giftCount)
analyzer.IncreaseValueNonRepeat(fmt.Sprintf("送礼人数_%s", giftId), record, 1, giftSender)
analyzer.IncreaseValue(fmt.Sprintf("礼物总数_%s", giftId), giftCount)
analyzer.Sub(record.GetString("live_id")).IncreaseValue("礼物总价值", giftPrice*giftCount)
analyzer.Sub(record.GetString("live_id")).IncreaseValueNonRepeat(fmt.Sprintf("送礼人数_%s", giftId), record, 1, giftSender)
analyzer.Sub(record.GetString("live_id")).IncreaseValue(fmt.Sprintf("礼物总数_%s", giftId), giftCount)
}
}
})
for i := 0; i < 10; i++ {
report, err := reader()
if err != nil {
t.Fatal(err)
}
fmt.Println(report.FilterSub("warzone0009"))
}
}
Analyzer STRUCT
分析器
type Analyzer struct {
v map[string]any
vc map[string]int64
repeat map[string]struct{}
subs map[string]*Analyzer
format map[string]func(v any) any
m sync.Mutex
}
func (*Analyzer) Sub(key string) *Analyzer
获取子分析器
func (*Analyzer) SetFormat(key string, format func (v any) any)
设置格式化函数
func (*Analyzer) SetValueIfGreaterThan(key string, value float64)
设置指定 key 的值，当新值大于旧值时
- 当已有值不为 float64 时，将会被忽略
func (*Analyzer) SetValueIfLessThan(key string, value float64)
设置指定 key 的值，当新值小于旧值时
- 当已有值不为 float64 时，将会被忽略
func (*Analyzer) SetValueIf(key string, expression bool, value float64)
当表达式满足的时候将设置指定 key 的值为 value
func (*Analyzer) SetValueStringIf(key string, expression bool, value string)
当表达式满足的时候将设置指定 key 的值为 value
func (*Analyzer) SetValue(key string, value float64)
设置指定 key 的值
func (*Analyzer) SetValueString(key string, value string)
设置指定 key 的值
func (*Analyzer) Increase(key string, record R, recordKey string)
在指定 key 现有值的基础上增加 recordKey 的值
- 当分析器已经记录过相同 key 的值时，会根据已有的值类型进行不同处理
处理方式：
- 当已有值类型为 string 时，将会使用新的值的 string 类型进行覆盖
- 当已有值类型为 float64 时，当新的值类型不为 float64 时，将会被忽略
func (*Analyzer) IncreaseValue(key string, value float64)
在指定 key 现有值的基础上增加 value
func (*Analyzer) IncreaseNonRepeat(key string, record R, recordKey string, dimension ...string)
在指定 key 现有值的基础上增加 recordKey 的值，但是当去重维度 dimension 相同时，不会增加
func (*Analyzer) IncreaseValueNonRepeat(key string, record R, value float64, dimension ...string)
在指定 key 现有值的基础上增加 value，但是当去重维度 dimension 相同时，不会增加
func (*Analyzer) GetValue(key string) float64
获取当前记录的值
func (*Analyzer) GetValueString(key string) string
获取当前记录的值
Flusher INTERFACE
用于刷新缓冲区的接口
type Flusher interface {
Flush(records []string)
Info() string
}
FileFlusher STRUCT
type FileFlusher struct {
dir string
fn string
fe string
layout string
layoutLen int
}
func (*FileFlusher) Flush(records []string)
func (*FileFlusher) Info() string
Option STRUCT
选项
type Option func(logger *logger)
Result STRUCT
type Result gjson.Result
R STRUCT
记录器所记录的一条数据
type R string
func (R) GetTime(layout string) time.Time
获取该记录的时间
func (R) Get(key string) Result
获取指定 key 的值
- 当 key 为嵌套 key 时，使用 . 进行分割，例如：a.b.c
- 更多用法参考：https://github.com/tidwall/gjson
func (R) Exist(key string) bool
判断指定 key 是否存在
func (R) GetString(key string) string
该函数为 Get(key).String() 的简写
func (R) GetInt64(key string) int64
该函数为 Get(key).Int() 的简写
func (R) GetInt(key string) int
该函数为 Get(key).Int() 的简写，但是返回值为 int 类型
func (R) GetFloat64(key string) float64
该函数为 Get(key).Float() 的简写
func (R) GetBool(key string) bool
该函数为 Get(key).Bool() 的简写
func (R) String() string
Report STRUCT
分析报告
type Report struct {
analyzer *Analyzer
Name string
Values map[string]any
Counter map[string]int64
Subs []*Report
}
func (*Report) Avg(key string) float64
计算平均值
func (*Report) Count(key string) int64
获取特定 key 的计数次数
func (*Report) Sum(keys ...string) float64
获取特定 key 的总和
func (*Report) Sub(name string) *Report
获取特定名称的子报告
func (*Report) ReserveSubByPrefix(prefix string) *Report
仅保留特定前缀的子报告
func (*Report) ReserveSub(names ...string) *Report
仅保留特定名称子报告
func (*Report) FilterSub(names ...string) *Report
将特定名称的子报告过滤掉