sharding

Documentation

Index

• Constants
• func FormatShardIDLabelValue(shardID, shardCount uint64) string
• func ParseShardIDLabelValue(val string) (index, shardCount uint64, _ error)
• type ShardSelector
  • func RemoveShardFromMatchers(matchers []*labels.Matcher) (shard *ShardSelector, filtered []*labels.Matcher, err error)
  • func ShardFromMatchers(matchers []*labels.Matcher) (shard *ShardSelector, idx int, err error)
  • func (shard ShardSelector) Label() labels.Label
  • func (shard ShardSelector) LabelValue() string
  • func (shard ShardSelector) Matcher() *labels.Matcher

Constants

const (
	// ShardLabel is a reserved label referencing a shard on read path.
	ShardLabel = "__query_shard__"
)

Functions

func FormatShardIDLabelValue

func FormatShardIDLabelValue(shardID, shardCount uint64) string

FormatShardIDLabelValue expects 0-based shardID, but uses 1-based shard in the output string.

func ParseShardIDLabelValue

func ParseShardIDLabelValue(val string) (index, shardCount uint64, _ error)

ParseShardIDLabelValue returns original (0-based) shard index and shard count parsed from formatted value.

Types

type ShardSelector

type ShardSelector struct {
	ShardIndex uint64
	ShardCount uint64
}

ShardSelector holds information about the configured query shard.

func RemoveShardFromMatchers

func RemoveShardFromMatchers(matchers []*labels.Matcher) (shard *ShardSelector, filtered []*labels.Matcher, err error)

RemoveShardFromMatchers returns the input matchers without the label matcher on the query shard (if any).

func ShardFromMatchers

func ShardFromMatchers(matchers []*labels.Matcher) (shard *ShardSelector, idx int, err error)

ShardFromMatchers extracts a ShardSelector and the index it was pulled from the matcher list.

func (ShardSelector) Label

func (shard ShardSelector) Label() labels.Label

Label generates the ShardSelector as a label.

func (ShardSelector) LabelValue

func (shard ShardSelector) LabelValue() string

LabelValue returns the label value to use to select this shard.

func (ShardSelector) Matcher

func (shard ShardSelector) Matcher() *labels.Matcher

Matcher converts ShardSelector to Matcher.