Documentation
¶
Index ¶
- Constants
- Variables
- func DeleteIndex(ctx context.Context, bkt objstore.Bucket, userID string, ...) error
- func WriteIndex(ctx context.Context, bkt objstore.Bucket, userID string, ...) error
- type Block
- type BlockDeletionMark
- type BlockDeletionMarks
- type Blocks
- type Index
- type Loader
- type LoaderConfig
- type Updater
Constants ¶
const ( IndexFilename = "bucket-index.json" IndexCompressedFilename = IndexFilename + ".gz" IndexVersion1 = 1 IndexVersion2 = 2 // Added CompactorShardID field. SegmentsFormatUnknown = "" // SegmentsFormat1Based6Digits defined segments numbered with 6 digits numbers in a sequence starting from number 1 // eg. (000001, 000002, 000003). SegmentsFormat1Based6Digits = "1b6d" )
Variables ¶
var ( ErrIndexNotFound = errors.New("bucket index not found") ErrIndexCorrupted = errors.New("bucket index corrupted") )
var ( ErrBlockMetaNotFound = block.ErrorSyncMetaNotFound ErrBlockMetaCorrupted = block.ErrorSyncMetaCorrupted ErrBlockDeletionMarkNotFound = errors.New("block deletion mark not found") ErrBlockDeletionMarkCorrupted = errors.New("block deletion mark corrupted") )
Functions ¶
func DeleteIndex ¶
func DeleteIndex(ctx context.Context, bkt objstore.Bucket, userID string, cfgProvider bucket.TenantConfigProvider) error
DeleteIndex deletes the bucket index from the storage. No error is returned if the index does not exist.
Types ¶
type Block ¶
type Block struct {
// Block ID.
ID ulid.ULID `json:"block_id"`
// MinTime and MaxTime specify the time range all samples in the block are in (millis precision).
MinTime int64 `json:"min_time"`
MaxTime int64 `json:"max_time"`
// SegmentsFormat and SegmentsNum stores the format and number of chunks segments
// in the block, if they match a known pattern. We don't store the full segments
// files list in order to keep the index small. SegmentsFormat is empty if segments
// are unknown or don't match a known format.
SegmentsFormat string `json:"segments_format,omitempty"`
SegmentsNum int `json:"segments_num,omitempty"`
// UploadedAt is a unix timestamp (seconds precision) of when the block has been completed to be uploaded
// to the storage.
UploadedAt int64 `json:"uploaded_at"`
// Block's compactor shard ID, copied from tsdb.CompactorShardIDExternalLabel label.
CompactorShardID string `json:"compactor_shard_id,omitempty"`
// Source is the real upload source of the block
Source string `json:"source,omitempty"`
CompactionLevel int `json:"compaction_level,omitempty"`
// Whether the block was from out of order samples
OutOfOrder bool `json:"out_of_order,omitempty"`
// Labels contains the external labels from the block's metadata.
Labels map[string]string `json:"labels,omitempty"`
}
Block holds the information about a block in the index.
func BlockFromThanosMeta ¶
func (*Block) GetUploadedAt ¶
func (*Block) ThanosMeta ¶
ThanosMeta returns a block meta based on the known information in the index. The returned meta doesn't include all original meta.json data but only a subset of it.
type BlockDeletionMark ¶
type BlockDeletionMark struct {
// Block ID.
ID ulid.ULID `json:"block_id"`
// DeletionTime is a unix timestamp (seconds precision) of when the block was marked to be deleted.
DeletionTime int64 `json:"deletion_time"`
}
BlockDeletionMark holds the information about a block's deletion mark in the index.
func BlockDeletionMarkFromThanosMarker ¶
func BlockDeletionMarkFromThanosMarker(mark *block.DeletionMark) *BlockDeletionMark
func (*BlockDeletionMark) GetDeletionTime ¶
func (m *BlockDeletionMark) GetDeletionTime() time.Time
func (*BlockDeletionMark) ThanosDeletionMark ¶
func (m *BlockDeletionMark) ThanosDeletionMark() *block.DeletionMark
ThanosDeletionMark returns the Thanos deletion mark.
type BlockDeletionMarks ¶
type BlockDeletionMarks []*BlockDeletionMark
BlockDeletionMarks holds a set of block deletion marks in the index. No ordering guaranteed.
func (BlockDeletionMarks) Clone ¶
func (s BlockDeletionMarks) Clone() BlockDeletionMarks
func (BlockDeletionMarks) GetULIDs ¶
func (s BlockDeletionMarks) GetULIDs() []ulid.ULID
type Blocks ¶
type Blocks []*Block
Blocks holds a set of blocks in the index. No ordering guaranteed.
type Index ¶
type Index struct {
// Version of the index format.
Version int `json:"version"`
// List of complete blocks (partial blocks are excluded from the index).
Blocks Blocks `json:"blocks"`
// List of block deletion marks.
BlockDeletionMarks BlockDeletionMarks `json:"block_deletion_marks"`
// UpdatedAt is a unix timestamp (seconds precision) of when the index has been updated
// (written in the storage) the last time.
UpdatedAt int64 `json:"updated_at"`
}
Index contains all known blocks and markers of a tenant.
func ReadIndex ¶
func ReadIndex(ctx context.Context, bkt objstore.Bucket, userID string, cfgProvider bucket.TenantConfigProvider, logger log.Logger) (*Index, error)
ReadIndex reads, parses and returns a bucket index from the bucket. ReadIndex has a one-minute timeout for completing the read against the bucket. One minute is hard-coded to a reasonably high value to protect against operations that can take unbounded time.
func (*Index) GetUpdatedAt ¶
func (*Index) RemoveBlock ¶
RemoveBlock removes block and its deletion mark (if any) from index.
type Loader ¶
Loader is responsible to lazy load bucket indexes and, once loaded for the first time, keep them updated in background. Loaded indexes are automatically offloaded once the idle timeout expires.
func NewLoader ¶
func NewLoader(cfg LoaderConfig, bucketClient objstore.Bucket, cfgProvider bucket.TenantConfigProvider, logger log.Logger, reg prometheus.Registerer) *Loader
NewLoader makes a new Loader.
type LoaderConfig ¶
type Updater ¶
type Updater struct {
// contains filtered or unexported fields
}
Updater is responsible to generate an update in-memory bucket index.
func NewUpdater ¶
func (*Updater) UpdateIndex ¶
UpdateIndex generates the bucket index and returns it, without storing it to the storage. If the old index is not passed in input, then the bucket index will be generated from scratch.
Source Files