Documentation
¶
Overview ¶
Package stats 通过 Xray gRPC StatsService 采集用户流量,并支持 HandlerService 动态更新用户。 实现模型对照《xray-api-探索.md》§4(3x-ui GetTraffic 轮询模式): QueryStats 全量拉取 → 维护 last 基线 → 差值 = 本周期增量(xray 重启归零视为 0)。
Index ¶
- type Collector
- func (c *Collector) Close()
- func (c *Collector) CloseOnline()
- func (c *Collector) Collect(ctx context.Context) ([]Entry, error)
- func (c *Collector) OnlineForHeartbeat(xrayRunning bool) (int, []OnlineUser)
- func (c *Collector) RefreshOnlineOnce()
- func (c *Collector) SeedUsers(configJSON []byte) error
- func (c *Collector) SeedUsersFromFile(path string) error
- func (c *Collector) SyncUsers(ctx context.Context, targetUsers map[string][]protocol.User) error
- type Entry
- type OnlineUser
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Collector ¶
type Collector struct {
// contains filtered or unexported fields
}
Collector 采集 Xray stats 并通过 HandlerService 动态同步用户。
func (*Collector) CloseOnline ¶ added in v0.1.19
func (c *Collector) CloseOnline()
CloseOnline 关闭在线拉取专用连接(拉取循环退出时调用)。
func (*Collector) Collect ¶
Collect 拉取全量计数器并返回自上次以来的流量增量(用户维度 + 入站维度两个计数器族)。 若 xray 未运行/连接失败返回 error,由调用方决定重连。
func (*Collector) OnlineForHeartbeat ¶ added in v0.1.19
func (c *Collector) OnlineForHeartbeat(xrayRunning bool) (int, []OnlineUser)
OnlineForHeartbeat 心跳帧的在线快照读取:只读内存,不做任何 gRPC。 快照由后台拉取循环(RefreshOnlineOnce,随心跳周期节拍)持续刷新并原子发布; 心跳读内存 = 零 RPC、零阻塞,xray API 慢不再拖住心跳发送,也不会与计费采集/ 用户同步抢 Collector.mu(锁内 gRPC 曾把消息循环最长卡住 8–13s)。
容错链:xray 未运行 → OnlineMap 随进程消失必为空,发布空快照并直接返回; 无任何成功快照 → 返回空;快照距上次成功刷新超过 maxOnlineStale(xray 卡死、 拉取持续失败)→ 返回空,防止心跳无限携带冻结的旧名单。 返回的切片是已发布不可变快照的一部分,调用方只读、不得修改。
func (*Collector) RefreshOnlineOnce ¶ added in v0.1.19
func (c *Collector) RefreshOnlineOnce()
RefreshOnlineOnce 拉取一次 GetUsersStats 并原子发布新快照(由后台拉取循环按心跳周期调用)。 成功 → 发布新快照;失败 → 沿用旧快照(瞬时抖动不让在线数闪跳为 0),限频记日志。 只允许单个后台 goroutine 串行调用(专用连接无并发保护)。
func (*Collector) SeedUsers ¶ added in v0.1.17
SeedUsers 按一份 xray 配置重建内存用户缓存(不变量 I5:缓存恒等于运行中 xray 的用户集)。
为什么是「重建」而不是「清空」:缓存是移除操作的唯一依据(SyncUsers 的移除分支只遍历它), 而 xray 每次从磁盘配置启动(冷更 / 回滚 / 崩溃自愈 / 慢探底 / 开机 / 手动重启)都会换掉 自己的用户集。旧实现只清空缓存,于是紧随其后的第一次同步一个都摘不掉;更糟的是添加分支 会把 payload 回填进缓存,分歧从此对后续每一次同步都不可见(被删 / 被封 / 超量 / 过期的 用户能一直用到下一次冷更,最长 1h)。见 docs/architecture/配置下发-热更冷更与状态机.md §1.2。
解析失败时保留原缓存并返回错误:清空正是要修的那个 bug,宁可沿用旧视图也不能留空。
func (*Collector) SeedUsersFromFile ¶ added in v0.1.17
SeedUsersFromFile 读取配置并重建缓存(xray 已按该文件启动时使用)。