progress

Documentation

Overview

Package progress provides CI-safe progress logging for crawler jobs.

Index

• func Completion(done, total int64) string
• func Percent(done, total int64) string
• type Options
• type Tracker
  • func New(logger *slog.Logger, opts Options) *Tracker
  • func (t *Tracker) Add(delta int64, attrs ...any)
  • func (t *Tracker) Finish(err error, attrs ...any)
  • func (t *Tracker) Set(done int64, attrs ...any)

Functions

func Completion

func Completion(done, total int64) string

func Percent

func Percent(done, total int64) string

Types

type Options

type Options struct {
	Name     string
	Unit     string
	Total    int64
	LogEvery time.Duration
	MinDelta int64
	Attrs    []any
	Now      func() time.Time
}

type Tracker

type Tracker struct {
	// contains filtered or unexported fields
}

func New

func New(logger *slog.Logger, opts Options) *Tracker

func (*Tracker) Add

func (t *Tracker) Add(delta int64, attrs ...any)

func (*Tracker) Finish

func (t *Tracker) Finish(err error, attrs ...any)

func (*Tracker) Set

func (t *Tracker) Set(done int64, attrs ...any)