survey

Documentation

Index

• func All(name string, t time.Time, handle func(record R) bool)
• func AllWithPath(filePath string, handle func(record R) bool)
• func Close(names ...string)
• func Flush(names ...string)
• func Record(name string, data map[string]any)
• func Reg(name, filePath string, options ...Option)
• type Option
  • func WithFlushInterval(interval time.Duration) Option
  • func WithLayout(layout string) Option
• type R
  • func (slf R) Exist(key string) bool
  • func (slf R) Get(key string) Result
  • func (slf R) GetBool(key string) bool
  • func (slf R) GetFloat64(key string) float64
  • func (slf R) GetInt(key string) int
  • func (slf R) GetInt64(key string) int64
  • func (slf R) GetString(key string) string
  • func (slf R) String() string
• type Result

Functions

func All

func All(name string, t time.Time, handle func(record R) bool)

All 处理特定记录器特定日期的所有记录，当发生错误时，会发生 panic

• handle 为并行执行的，需要自行处理并发安全

func AllWithPath

func AllWithPath(filePath string, handle func(record R) bool)

AllWithPath 处理特定记录器特定日期的所有记录，当发生错误时，会发生 panic

• handle 为并行执行的，需要自行处理并发安全
• 适用于外部进程对于日志文件的读取，但是需要注意的是，此时日志文件可能正在被写入，所以可能会读取到错误的数据

func Close

func Close(names ...string)

Close 关闭运营日志记录器

func Flush

func Flush(names ...string)

Flush 将运营日志记录器的缓冲区数据写入到文件

• name 为空时，将所有记录器的缓冲区数据写入到文件

func Record

func Record(name string, data map[string]any)

Record 记录一条运营日志

func Reg

func Reg(name, filePath string, options ...Option)

Reg 注册一个运营日志记录器

Types

type Option

type Option func(logger *logger)

Option 选项

func WithFlushInterval

func WithFlushInterval(interval time.Duration) Option

WithFlushInterval 设置日志文件刷新间隔

• 默认为 3s，当日志文件刷新间隔 <= 0 时，将会在每次写入日志时刷新日志文件

func WithLayout

func WithLayout(layout string) Option

WithLayout 设置日志文件名的时间戳格式

• 默认为 time.DateOnly

type R

type R string

R 记录器所记录的一条数据

func (R) Exist

func (slf R) Exist(key string) bool

Exist 判断指定 key 是否存在

func (R) Get

func (slf R) Get(key string) Result

Get 获取指定 key 的值

• 当 key 为嵌套 key 时，使用 . 进行分割，例如：a.b.c
• 更多用法参考：https://github.com/tidwall/gjson

func (R) GetBool

func (slf R) GetBool(key string) bool

GetBool 该函数为 Get(key).Bool() 的简写

func (R) GetFloat64

func (slf R) GetFloat64(key string) float64

GetFloat64 该函数为 Get(key).Float() 的简写

func (R) GetInt

func (slf R) GetInt(key string) int

GetInt 该函数为 Get(key).Int() 的简写，但是返回值为 int 类型

func (R) GetInt64

func (slf R) GetInt64(key string) int64

GetInt64 该函数为 Get(key).Int() 的简写

func (R) GetString

func (slf R) GetString(key string) string

GetString 该函数为 Get(key).String() 的简写

func (R) String

func (slf R) String() string

type Result

type Result = gjson.Result