Documentation
¶
Overview ¶
Package oplog 提供异步操作日志队列: 请求/业务动作日志先入内存队列,由后台消费者批量写入 Sink, 不阻塞请求链路(go-admin 内存队列思路)。
Index ¶
- func Count(ctx context.Context, client *redis.Client, key string) (int64, error)
- func QueryHandler(client *redis.Client, key string) iris.Handler
- func Register(app *iris.Application, prefix string, client *redis.Client, key string, ...) iris.Party
- type Config
- type Entry
- type Queue
- type RedisListSink
- type Sink
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func QueryHandler ¶ added in v1.70.0
QueryHandler 返回审计日志查询 HTTP 处理器。 参数:offset(默认 0)、count(默认 20);响应 {code,message,data:{list,total}}。 配合 RedisListSink 使用;挂载位置与鉴权中间件由业务决定, 建议限制仅管理角色可访问(如叠加 web.Auth + rbac.RequireRole)。
func Register ¶ added in v1.89.0
func Register(app *iris.Application, prefix string, client *redis.Client, key string, config Config) iris.Party
Register 注册审计查询页与数据接口:
GET <prefix> 审计查询页(HTML,自包含,10s 自动刷新) GET <prefix>/api/audit 审计数据 JSON(挂 Auth + 限流)
prefix 建议 /ops/audit。返回注册后的 party。
oplog.Register(app, "/ops/audit", client, "ops:audit", oplog.Config{
Auth: webiris.Auth(webiris.AuthConfig{Whitelist: []string{"/ops/audit"}}),
})
Types ¶
type Config ¶ added in v1.89.0
type Config struct {
// Auth 数据接口的身份校验中间件(推荐 webiris.Auth,白名单放行页面)。
// 为 nil 时不校验(仅限内网/Admin 端口场景)。
Auth iris.Handler
// RatePerSecond 数据接口每 IP 限流速率;非正数时默认 5 QPS。
RatePerSecond float64
// Burst 突发容量;非正数时取 RatePerSecond。
Burst int
}
Config 审计查询页配置。
type Entry ¶
type Entry struct {
Time time.Time `json:"time"`
UserID int64 `json:"user_id"`
UserEmail string `json:"user_email"`
Method string `json:"method"`
Path string `json:"path"`
Status int `json:"status"`
Duration time.Duration `json:"duration"`
RequestID string `json:"request_id"`
Action string `json:"action"`
Detail string `json:"detail"`
}
Entry 是单条操作日志。
type Queue ¶
type Queue struct {
// contains filtered or unexported fields
}
Queue 是异步操作日志队列。 Enqueue 非阻塞:队列满时丢弃新条目并计数,保证请求链路不被日志拖慢。
func (*Queue) Middleware ¶
Middleware 返回 Iris 操作日志中间件,把请求信息入队。 注册顺序建议在 Auth 之后(可读取用户身份)。
type RedisListSink ¶ added in v1.68.0
type RedisListSink struct {
// contains filtered or unexported fields
}
RedisListSink 把审计日志写入 Redis List(LPUSH 头部插入,倒序保留最近 limit 条)。 多实例共享存储,零配置审计落地;配合 Query 提供最近操作日志查询。 大数据量/复杂检索场景请改用 ES 或数据库 Sink。
func NewRedisListSink ¶ added in v1.68.0
func NewRedisListSink(client *redis.Client, key string, limit int64) *RedisListSink
NewRedisListSink 创建 Redis 审计存储。 key 为存储键(多应用隔离用不同 key);limit 为保留条数(<=0 表示不限制,注意内存占用)。