cron

package

v0.3.2 Latest Latest Go to latest Published: Aug 5, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Details

View Source

const (
	// ScopeName is the instrumentation scope name.
	ScopeName = "github.com/rushteam/beauty/pkg/service/cron/trace.go"
)

This section is empty.

This section is empty.

type Cron struct {
	*cron.Cron
	// contains filtered or unexported fields
}

func New(opts ...CronOptions) *Cron

func (s *Cron) Start(ctx context.Context) error

func (s *Cron) String() string

type CronHandlerOptions func(cfg *cronHandlerCfg)

func HandlerName(name string) CronHandlerOptions

type CronOptions func(c *Cron)

func WithCronHandler(spec string, handler func(ctx context.Context) error, opts ...CronHandlerOptions) CronOptions

func WithLeaderElector(elector dlock.Elector, key string) CronOptions

WithLeaderElector 让整个 Cron 只在选主(leader election)当选期间跑任务, 解决"多实例部署下每个实例都各跑一遍定时任务"的重复执行问题。

key 是参选的选举标识(同一组要互斥的多个实例须用同一个 key,通常按服务名定,如 "myservice-cron")。elector 通常传 pkg/infra/etcd 的 DLock(生产, 跨实例)或 pkg/dlock.NewMemory()(单实例/测试)。

语义:未当选时不注册/不运行任何任务(Start 阻塞在选举上);当选后启动全部任务,失去 leader 身份(网络分区/进程崩溃/主动放弃)时立即停止全部任务并重新参选。不配置此项时行为不变(直接 Start,不经过选举)。

func WithMeterProvider(m metric.MeterProvider) CronOptions

func WithRecover(recoverHandler func(r any)) CronOptions

func WithTraceProvider(t trace.TracerProvider) CronOptions