encoding

Documentation

Index

• func ValidateConfig(b *BlockConfig) error
• type BackendBlock
  • func NewBackendBlock(meta *backend.BlockMeta, r backend.Reader) (*BackendBlock, error)
  • func (b *BackendBlock) Find(ctx context.Context, id common.ID) ([]byte, error)
  • func (b *BackendBlock) Iterator(chunkSizeBytes uint32) (common.Iterator, error)
• type BlockConfig
• type CompactorBlock
  • func NewCompactorBlock(cfg *BlockConfig, id uuid.UUID, tenantID string, metas []*backend.BlockMeta, ...) (*CompactorBlock, error)
  • func (c *CompactorBlock) AddObject(id common.ID, object []byte) error
  • func (c *CompactorBlock) BlockMeta() *backend.BlockMeta
  • func (c *CompactorBlock) Complete(ctx context.Context, tracker backend.AppendTracker, w backend.Writer) (int, error)
  • func (c *CompactorBlock) CurrentBufferLength() int
  • func (c *CompactorBlock) CurrentBufferedObjects() int
  • func (c *CompactorBlock) FlushBuffer(ctx context.Context, tracker backend.AppendTracker, w backend.Writer) (backend.AppendTracker, int, error)
  • func (c *CompactorBlock) Length() int
• type CompleteBlock
  • func NewCompleteBlock(cfg *BlockConfig, originatingMeta *backend.BlockMeta, iterator common.Iterator, ...) (*CompleteBlock, error)
  • func (c *CompleteBlock) BlockMeta() *backend.BlockMeta
  • func (c *CompleteBlock) Clear() error
  • func (c *CompleteBlock) Find(id common.ID, combiner common.ObjectCombiner) ([]byte, error)
  • func (c *CompleteBlock) FlushedTime() time.Time
  • func (c *CompleteBlock) Write(ctx context.Context, w backend.Writer) error

Functions

func ValidateConfig

func ValidateConfig(b *BlockConfig) error

ValidateConfig returns true if the config is valid

Types

type BackendBlock

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

BackendBlock represents a block already in the backend.

func NewBackendBlock

func NewBackendBlock(meta *backend.BlockMeta, r backend.Reader) (*BackendBlock, error)

NewBackendBlock returns a BackendBlock for the given backend.BlockMeta

It is version aware.

func (*BackendBlock) Find

func (b *BackendBlock) Find(ctx context.Context, id common.ID) ([]byte, error)

Find searches a block for the ID and returns an object if found.

func (*BackendBlock) Iterator

func (b *BackendBlock) Iterator(chunkSizeBytes uint32) (common.Iterator, error)

Iterator returns an Iterator that iterates over the objects in the block from the backend

type BlockConfig

type BlockConfig struct {
	IndexDownsampleBytes int              `yaml:"index_downsample_bytes"`
	BloomFP              float64          `yaml:"bloom_filter_false_positive"`
	Encoding             backend.Encoding `yaml:"encoding"`
}

BlockConfig holds configuration options for newly created blocks

type CompactorBlock

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

func NewCompactorBlock

func NewCompactorBlock(cfg *BlockConfig, id uuid.UUID, tenantID string, metas []*backend.BlockMeta, estimatedObjects int) (*CompactorBlock, error)

NewCompactorBlock creates a ... new compactor block!

func (*CompactorBlock) AddObject

func (c *CompactorBlock) AddObject(id common.ID, object []byte) error

func (*CompactorBlock) BlockMeta

func (c *CompactorBlock) BlockMeta() *backend.BlockMeta

func (*CompactorBlock) Complete

func (c *CompactorBlock) Complete(ctx context.Context, tracker backend.AppendTracker, w backend.Writer) (int, error)

Complete finishes writes the compactor metadata and closes all buffers and appenders

func (*CompactorBlock) CurrentBufferLength

func (c *CompactorBlock) CurrentBufferLength() int

func (*CompactorBlock) CurrentBufferedObjects

func (c *CompactorBlock) CurrentBufferedObjects() int

func (*CompactorBlock) FlushBuffer

func (c *CompactorBlock) FlushBuffer(ctx context.Context, tracker backend.AppendTracker, w backend.Writer) (backend.AppendTracker, int, error)

FlushBuffer flushes any existing objects to the backend

func (*CompactorBlock) Length

func (c *CompactorBlock) Length() int

type CompleteBlock

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

CompleteBlock represent a block that has been "cut", is ready to be flushed and is not appendable. A CompleteBlock also knows the filepath of the append wal file it was cut from. It is responsible for cleaning this block up once it has been flushed to the backend.

func NewCompleteBlock

func NewCompleteBlock(cfg *BlockConfig, originatingMeta *backend.BlockMeta, iterator common.Iterator, estimatedObjects int, filepath string, walFilename string) (*CompleteBlock, error)

NewCompleteBlock creates a new block and takes _ALL_ the parameters necessary to build the ordered, deduped file on disk

func (*CompleteBlock) BlockMeta

func (c *CompleteBlock) BlockMeta() *backend.BlockMeta

BlockMeta returns a pointer to this blocks meta

func (*CompleteBlock) Clear

func (c *CompleteBlock) Clear() error

Clear removes the backing file.

func (*CompleteBlock) Find

func (c *CompleteBlock) Find(id common.ID, combiner common.ObjectCombiner) ([]byte, error)

Find searches the for the provided trace id. A CompleteBlock should never

have multiples of a single id so not sure why this uses a DedupingFinder.

func (*CompleteBlock) FlushedTime

func (c *CompleteBlock) FlushedTime() time.Time

FlushedTime returns the time the block was flushed. Will return 0

if the block was never flushed

func (*CompleteBlock) Write

func (c *CompleteBlock) Write(ctx context.Context, w backend.Writer) error

Write implements WriteableBlock