checkpoint

Documentation

Index

• Variables
• func HasCheckPoint() bool
• func NewContext(ctx context.Context) context.Context
• func SetCheckPoint(file string) error
• type CheckField
  • func Field(name string, eq func(any, any) bool) CheckField
• type CheckPoint
  • func NewCheckPoint(r io.Reader) (*CheckPoint, error)
• type FieldSet
  • func Register(fields ...CheckField) FieldSet
  • func (fs *FieldSet) Slice() []CheckField
• type Point
  • func Acquire(ctx context.Context, fs FieldSet, point map[string]any) *Point
  • func (p *Point) Hit() map[string]any
  • func (p *Point) Release(err error, fields ...zapcore.Field)

Variables

var (

	// DebugCheckpoint is a switch used to debug if:
	// - The context passed to checkpoint is generated by checkpoint.NewContext
	// - multilple context acquire applied to the same context belone to the sampe goroutine
	DebugCheckpoint = os.Getenv("DEBUG_CHECKPOINT") == "1"
)

Functions

func HasCheckPoint

func HasCheckPoint() bool

HasCheckPoint returns if SetCheckPoint has been called

func NewContext

func NewContext(ctx context.Context) context.Context

NewContext wraps given context with value needed by checkpoint

func SetCheckPoint

func SetCheckPoint(file string) error

SetCheckPoint set global checkpoint for replay

Types

type CheckField

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

CheckField is a field that should be checked

func Field

func Field(name string, eq func(any, any) bool) CheckField

Field returns new CheckField

type CheckPoint

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

CheckPoint provides the ability to recover from a failed command at the failpoint

func NewCheckPoint

func NewCheckPoint(r io.Reader) (*CheckPoint, error)

NewCheckPoint returns a CheckPoint by given audit file

type FieldSet

type FieldSet struct {
	set.AnySet
}

FieldSet is an ordered set stores fields and comparators, it's []CheckField

func Register

func Register(fields ...CheckField) FieldSet

Register register FieldSet to global for latter comparing If there are two fields with the same name, the first one will be used

func (*FieldSet) Slice

func (fs *FieldSet) Slice() []CheckField

Slice returns CheckField slice for iteration

type Point

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

Point is a point of checkpoint

func Acquire

func Acquire(ctx context.Context, fs FieldSet, point map[string]any) *Point

Acquire wraps CheckPoint.Acquire

func (*Point) Hit

func (p *Point) Hit() map[string]any

Hit returns value of the point, it will be nil if not hit.

func (*Point) Release

func (p *Point) Release(err error, fields ...zapcore.Field)

Release write checkpoint into log file