Documentation
¶
Overview ¶
Package filerotate 提供多进程安全的文件轮转功能。
本文件实现 Leader 选举后的主循环逻辑:监控文件大小、触发轮转。
Package filerotate 提供多进程安全的文件轮转功能。
本文件定义 Locker 接口及工厂函数,用于创建分布式锁。 所有锁实现(文件锁、Valkey 锁)均通过此接口对外暴露, 具体实现位于 internal/locker 包中,外部不可见。
Package filerotate 提供多进程安全的文件轮转功能。
本文件定义 Notifier 接口及工厂函数,用于进程间轮转通知。 所有通知器实现(文件轮询、NATS、JetStream、Valkey)均通过此接口对外暴露, 具体实现位于 internal/notifier 包中,外部不可见。
Package filerotate 提供多进程安全的文件轮转功能。
本文件实现 Unix 平台的文件打开。
Package filerotate 提供多进程安全的文件轮转功能。
本文件包含文件轮转的核心操作:重命名、创建新文件、清理过期备份。
Package filerotate 提供多进程安全的文件轮转功能。
本文件实现 Writer 核心逻辑:Write、Close、doRotation 及标准模式(Leader 选举 + 通知器)。
Package filerotate 提供多进程安全的文件轮转功能。
本文件实现单机(Local)模式的自轮转循环和便捷构造函数, 使用内置轮询通知器 + 文件锁协调多进程。
Index ¶
Constants ¶
const (
// CmdRotate 是 Leader 通知客户端执行文件重开的命令。
CmdRotate = "ROTATE"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// FilePath 文件路径。所有并发进程必须使用相同的路径。
FilePath string
// MaxSizeMB 触发轮转的总文件大小(MB)。Leader 定期检查文件实际大小。
MaxSizeMB int
// MaxAgeDays 备份文件保留天数。0 表示永不删除。轮转时自动清理过期备份。
MaxAgeDays int
// CheckInterval 检查文件大小的间隔。默认值取决于模式:单机 1s,标准 5s。
CheckInterval time.Duration
// LockerFactory 自定义锁工厂函数。标准模式必须设置,单机模式忽略(始终用 LocalLocker)。
LockerFactory func(lockPath string) (Locker, error)
// NotifierFactory 自定义通知器工厂函数。若为 nil,使用基于文件轮询的默认通知器。
// 跨主机场景(NFS + 跨进程通知)时可注入 NATS / JetStream / Valkey 等通知器。
NotifierFactory func(errorHandler func(error)) (Notifier, error)
// ErrorHandler 当内部 goroutine 发生错误时调用。如果为 nil,错误将打印到 stderr。
ErrorHandler func(error)
}
Config Writer 配置,同时用于单机模式和标准模式。
type Locker ¶
type Locker interface {
// TryLock 非阻塞尝试获取锁,返回是否成功。
// 成功获取锁后,调用者应确保在操作完成后调用 Unlock。
TryLock() (bool, error)
// Unlock 释放锁。
Unlock() error
}
Locker 分布式锁接口,用于保护轮转操作。 单机模式内置文件锁,无需关心此接口。 仅在跨主机场景下才需要提供自定义实现(如 NewValkeyLocker)。
func NewValkeyLocker ¶
func NewValkeyLocker(option valkeylock.LockerOption, key string) (Locker, error)
NewValkeyLocker 创建一个基于 Valkey 的分布式锁。
使用 valkeylock 包的 Redlock 算法,支持多节点多数派共识、锁自动续期和客户端缓存失效通知。 用户可以通过 option 完全控制锁的行为,例如设置客户端配置、多数派数量、锁有效期等。
参数:
- option: valkeylock.LockerOption 配置,用于底层锁的创建。
- key: 锁键名称,所有竞争同一资源的进程必须使用相同的 key。
示例:
locker, err := filerotate.NewValkeyLocker(
valkeylock.LockerOption{
ClientOption: valkey.ClientOption{InitAddress: []string{"localhost:6379"}},
KeyMajority: 1,
KeyValidity: 30 * time.Second,
},
"my-lock-key",
)
type Notifier ¶
type Notifier interface {
// Serve 在 Leader 端启动服务,等待客户端连接。
// 对于无需服务端初始化的实现(如 NATS),可直接返回 nil。
Serve() error
// Connect 客户端连接到 Leader,返回一个接收命令的字符串通道。
// 通道中会收到 CmdRotate 等命令,当连接断开时通道关闭。
Connect() (<-chan string, error)
// Broadcast 向所有已连接的客户端发送命令。
// 应确保所有当前在线的客户端都能收到该命令。
Broadcast(cmd string) error
// Close 关闭通知器,释放资源。
Close() error
}
Notifier 定义进程间轮转通知的通信接口。 Leader 通过此接口向所有客户端广播轮转命令(CmdRotate)。 所有进程(包括 Leader 自己)都需要通过 Connect() 订阅命令, 以便在收到 ROTATE 命令时执行文件重开操作。
func NewJetStreamNotifier ¶
func NewJetStreamNotifier(js nats.JetStreamContext, subject string, errorHandler func(error)) Notifier
NewJetStreamNotifier 创建一个基于 NATS JetStream 的通知器。 使用临时消费者(Ephemeral Consumer),进程退出后自动清理,只接收新消息。 errorHandler 为错误处理回调,若为 nil 则默认打印到 stderr。
func NewNATSNotifier ¶
NewNATSNotifier 创建一个基于 NATS 核心 Pub/Sub 的通知器。 conn 为已建立的 NATS 连接,subject 为通信主题,所有进程必须使用相同的主题。 errorHandler 为错误处理回调,若为 nil 则默认打印到 stderr。
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
Writer 是多进程安全的文件写入器。
标准模式:通过 Leader 选举和进程间通知协调所有进程。 所有进程平等竞争 Leader,Leader 负责监控文件大小并广播轮转命令。
单机(Local)模式:无 Leader 选举,无进程间通信。每个进程通过内置的 polling goroutine 独立检查文件状态,通过分布式锁协调轮转操作。
Writer 实现了 io.WriteCloser,可直接与 log.Logger、fmt.Fprint 等配合使用。
func New ¶
New 创建一个 Writer。
根据 NotifierFactory 自动选择模式:
- NotifierFactory == nil:单机模式,使用内置 LocalNotifier 轮询 + 分布式锁协调多进程。 所有进程平等,无 Leader 选举。
- NotifierFactory != nil:标准模式,使用自定义 跨进程通知器 + Leader 选举协调多进程。
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
example
|
|
|
common
Package common 提供示例程序共享的辅助函数。
|
Package common 提供示例程序共享的辅助函数。 |
|
jetstream
command
JetStream 示例:使用 NATS JetStream 临时消费者进行进程间通信,模拟 3 个进程并发写入。
|
JetStream 示例:使用 NATS JetStream 临时消费者进行进程间通信,模拟 3 个进程并发写入。 |
|
local
command
Local 版示例:模拟 3 个进程并发写入,无进程间通信,通过内置轮询和分布式锁协调轮转。
|
Local 版示例:模拟 3 个进程并发写入,无进程间通信,通过内置轮询和分布式锁协调轮转。 |
|
nats
command
NATS 示例:使用 NATS 核心 Pub/Sub 进行进程间通信,模拟 3 个进程并发写入。
|
NATS 示例:使用 NATS 核心 Pub/Sub 进行进程间通信,模拟 3 个进程并发写入。 |
|
valkey
command
Valkey 示例:同时使用 Valkey Pub/Sub 通知器和 Valkey 分布式锁, 模拟 3 个进程并发写入,适用于跨主机 NFS 共享存储场景。
|
Valkey 示例:同时使用 Valkey Pub/Sub 通知器和 Valkey 分布式锁, 模拟 3 个进程并发写入,适用于跨主机 NFS 共享存储场景。 |
|
internal
|
|
|
locker
Package locker 提供分布式锁的内部实现。
|
Package locker 提供分布式锁的内部实现。 |
|
notifier
Package notifier 提供进程间通知的内部实现。
|
Package notifier 提供进程间通知的内部实现。 |