queue

Documentation

Index

• Variables
• type InjuredSegment
• type InsertBuffer
  • func NewInsertBuffer(queue RepairQueue, batchSize int) *InsertBuffer
  • func (r *InsertBuffer) Flush(ctx context.Context) (err error)
  • func (r *InsertBuffer) Insert(ctx context.Context, segment *InjuredSegment, newInsertCallback func()) (err error)
• type MockRepairQueue
  • func (m *MockRepairQueue) Clean(ctx context.Context, before time.Time) (deleted int64, err error)
  • func (m *MockRepairQueue) Count(ctx context.Context) (count int, err error)
  • func (m *MockRepairQueue) Delete(ctx context.Context, s InjuredSegment) error
  • func (m *MockRepairQueue) Insert(ctx context.Context, s *InjuredSegment) (alreadyInserted bool, err error)
  • func (m *MockRepairQueue) InsertBatch(ctx context.Context, segments []*InjuredSegment) (newlyInsertedSegments []*InjuredSegment, err error)
  • func (m *MockRepairQueue) Select(context.Context, int, []storj.PlacementConstraint, []storj.PlacementConstraint) ([]InjuredSegment, error)
  • func (m *MockRepairQueue) SelectN(ctx context.Context, limit int) ([]InjuredSegment, error)
  • func (m *MockRepairQueue) Stat(ctx context.Context) ([]Stat, error)
  • func (m *MockRepairQueue) TestingSetAttemptedTime(ctx context.Context, streamID uuid.UUID, position metabase.SegmentPosition, ...) (rowsAffected int64, err error)
• type RepairQueue
• type Stat

Variables

var ErrEmpty = errs.Class("empty queue")

ErrEmpty is returned when attempting to Dequeue from an empty queue.

var Error = errs.Class("repair queue")

Error is a standard error class for this package.

Types

type InjuredSegment

type InjuredSegment struct {
	StreamID uuid.UUID
	Position metabase.SegmentPosition

	SegmentHealth float64
	AttemptedAt   *time.Time
	UpdatedAt     time.Time
	InsertedAt    time.Time

	Placement storj.PlacementConstraint
}

InjuredSegment contains information about segment which should be repaired.

type InsertBuffer

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

InsertBuffer exposes a synchronous API to buffer a batch of segments and insert them at once. Not threadsafe. Call Flush() before discarding.

func NewInsertBuffer

func NewInsertBuffer(
	queue RepairQueue,
	batchSize int,
) *InsertBuffer

NewInsertBuffer wraps a RepairQueue with buffer logic.

func (*InsertBuffer) Flush

func (r *InsertBuffer) Flush(ctx context.Context) (err error)

Flush inserts the remaining segments into the database.

func (*InsertBuffer) Insert

func (r *InsertBuffer) Insert(
	ctx context.Context,
	segment *InjuredSegment,
	newInsertCallback func(),
) (err error)

Insert adds a segment to the batch of the next insert, and does a synchronous database insert when the batch size is reached. When it is determined that this segment is newly queued, firstInsertCallback is called. for the purpose of metrics.

type MockRepairQueue

type MockRepairQueue struct {
	Segments []*InjuredSegment
}

MockRepairQueue helps testing RepairQueue.

func (*MockRepairQueue) Clean

func (m *MockRepairQueue) Clean(ctx context.Context, before time.Time) (deleted int64, err error)

Clean implements RepairQueue.

func (*MockRepairQueue) Count

func (m *MockRepairQueue) Count(ctx context.Context) (count int, err error)

Count implements RepairQueue.

func (*MockRepairQueue) Delete

func (m *MockRepairQueue) Delete(ctx context.Context, s InjuredSegment) error

Delete implements RepairQueue.

func (*MockRepairQueue) Insert

func (m *MockRepairQueue) Insert(ctx context.Context, s *InjuredSegment) (alreadyInserted bool, err error)

Insert implements RepairQueue.

func (*MockRepairQueue) InsertBatch

func (m *MockRepairQueue) InsertBatch(ctx context.Context, segments []*InjuredSegment) (newlyInsertedSegments []*InjuredSegment, err error)

InsertBatch implements RepairQueue.

func (*MockRepairQueue) Select

func (m *MockRepairQueue) Select(context.Context, int, []storj.PlacementConstraint, []storj.PlacementConstraint) ([]InjuredSegment, error)

Select implements RepairQueue.

func (*MockRepairQueue) SelectN

func (m *MockRepairQueue) SelectN(ctx context.Context, limit int) ([]InjuredSegment, error)

SelectN implements RepairQueue.

func (*MockRepairQueue) Stat

func (m *MockRepairQueue) Stat(ctx context.Context) ([]Stat, error)

Stat implements RepairQueue.

func (*MockRepairQueue) TestingSetAttemptedTime

func (m *MockRepairQueue) TestingSetAttemptedTime(ctx context.Context, streamID uuid.UUID, position metabase.SegmentPosition, t time.Time) (rowsAffected int64, err error)

TestingSetAttemptedTime implements RepairQueue.

type RepairQueue

type RepairQueue interface {
	// Insert adds an injured segment.
	Insert(ctx context.Context, s *InjuredSegment) (alreadyInserted bool, err error)
	// InsertBatch adds multiple injured segments
	InsertBatch(ctx context.Context, segments []*InjuredSegment) (newlyInsertedSegments []*InjuredSegment, err error)
	// Select gets an injured segments.
	Select(ctx context.Context, limit int, includedPlacements []storj.PlacementConstraint, excludedPlacements []storj.PlacementConstraint) ([]InjuredSegment, error)
	// Delete removes an injured segment.
	Delete(ctx context.Context, s InjuredSegment) error
	// Clean removes all segments last updated before a certain time
	Clean(ctx context.Context, before time.Time) (deleted int64, err error)
	// SelectN lists limit amount of injured segments.
	SelectN(ctx context.Context, limit int) ([]InjuredSegment, error)
	// Count counts the number of segments in the repair queue.
	Count(ctx context.Context) (count int, err error)

	// Stat returns stat of the current queue state.
	Stat(ctx context.Context) ([]Stat, error)

	// TestingSetAttemptedTime sets attempted time for a segment.
	TestingSetAttemptedTime(ctx context.Context, streamID uuid.UUID, position metabase.SegmentPosition, t time.Time) (rowsAffected int64, err error)
}

RepairQueue implements queueing for segments that need repairing. Implementation can be found at satellite/satellitedb/repairqueue.go.

architecture: Database

type Stat

type Stat struct {
	Count            int
	Placement        storj.PlacementConstraint
	MaxInsertedAt    time.Time
	MinInsertedAt    time.Time
	MaxAttemptedAt   *time.Time
	MinAttemptedAt   *time.Time
	MinSegmentHealth float64
	MaxSegmentHealth float64
}

Stat contains information about a segment of repair queue.