shipper

Documentation

Index

• Constants
• func NewBoltDBShipperTableClient(objectClient chunk.ObjectClient, storageKeyPrefix string) chunk.TableClient
• func NewShipper(cfg Config, storageClient chunk.ObjectClient, registerer prometheus.Registerer) (chunk.IndexClient, error)
• type Config
  • func (cfg *Config) RegisterFlags(f *flag.FlagSet)
  • func (cfg *Config) Validate() error
• type GatewayClient
  • func NewGatewayClient(cfg IndexGatewayClientConfig, r prometheus.Registerer) (*GatewayClient, error)
  • func (s *GatewayClient) BatchWrite(ctx context.Context, batch chunk.WriteBatch) error
  • func (s *GatewayClient) NewWriteBatch() chunk.WriteBatch
  • func (s *GatewayClient) QueryPages(ctx context.Context, queries []chunk.IndexQuery, ...) error
  • func (s *GatewayClient) Stop()
• type IndexGatewayClientConfig
  • func (cfg *IndexGatewayClientConfig) RegisterFlags(f *flag.FlagSet)
  • func (cfg *IndexGatewayClientConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
• type Shipper
  • func (s *Shipper) BatchWrite(ctx context.Context, batch chunk.WriteBatch) error
  • func (s *Shipper) NewWriteBatch() chunk.WriteBatch
  • func (s *Shipper) QueryPages(ctx context.Context, queries []chunk.IndexQuery, ...) error
  • func (s *Shipper) Stop()

Constants

const (
	// ModeReadWrite is to allow both read and write
	ModeReadWrite = iota
	// ModeReadOnly is to allow only read operations
	ModeReadOnly
	// ModeWriteOnly is to allow only write operations
	ModeWriteOnly

	// BoltDBShipperType holds the index type for using boltdb with shipper which keeps flushing them to a shared storage
	BoltDBShipperType = "boltdb-shipper"

	// FilesystemObjectStoreType holds the periodic config type for the filesystem store
	FilesystemObjectStoreType = "filesystem"

	// UploadInterval defines interval for when we check if there are new index files to upload.
	// It's also used to snapshot the currently written index tables so the snapshots can be used for reads.
	UploadInterval = 1 * time.Minute
)

Functions

func NewBoltDBShipperTableClient

func NewBoltDBShipperTableClient(objectClient chunk.ObjectClient, storageKeyPrefix string) chunk.TableClient

func NewShipper

func NewShipper(cfg Config, storageClient chunk.ObjectClient, registerer prometheus.Registerer) (chunk.IndexClient, error)

NewShipper creates a shipper for syncing local objects with a store

Types

type Config

type Config struct {
	ActiveIndexDirectory     string                   `yaml:"active_index_directory"`
	SharedStoreType          string                   `yaml:"shared_store"`
	SharedStoreKeyPrefix     string                   `yaml:"shared_store_key_prefix"`
	CacheLocation            string                   `yaml:"cache_location"`
	CacheTTL                 time.Duration            `yaml:"cache_ttl"`
	ResyncInterval           time.Duration            `yaml:"resync_interval"`
	QueryReadyNumDays        int                      `yaml:"query_ready_num_days"`
	IndexGatewayClientConfig IndexGatewayClientConfig `yaml:"index_gateway_client"`
	BuildPerTenantIndex      bool                     `yaml:"build_per_tenant_index"`
	IngesterName             string                   `yaml:"-"`
	Mode                     int                      `yaml:"-"`
	IngesterDBRetainPeriod   time.Duration            `yaml:"-"`
}

func (*Config) RegisterFlags

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers flags.

func (*Config) Validate

func (cfg *Config) Validate() error

type GatewayClient

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

func NewGatewayClient

func NewGatewayClient(cfg IndexGatewayClientConfig, r prometheus.Registerer) (*GatewayClient, error)

func (*GatewayClient) BatchWrite

func (s *GatewayClient) BatchWrite(ctx context.Context, batch chunk.WriteBatch) error

func (*GatewayClient) NewWriteBatch

func (s *GatewayClient) NewWriteBatch() chunk.WriteBatch

func (*GatewayClient) QueryPages

func (s *GatewayClient) QueryPages(ctx context.Context, queries []chunk.IndexQuery, callback func(chunk.IndexQuery, chunk.ReadBatch) (shouldContinue bool)) error

func (*GatewayClient) Stop

func (s *GatewayClient) Stop()

type IndexGatewayClientConfig

type IndexGatewayClientConfig struct {
	Address          string            `yaml:"server_address,omitempty"`
	GRPCClientConfig grpcclient.Config `yaml:"grpc_client_config"`
}

func (*IndexGatewayClientConfig) RegisterFlags

func (cfg *IndexGatewayClientConfig) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers flags.

func (*IndexGatewayClientConfig) RegisterFlagsWithPrefix

func (cfg *IndexGatewayClientConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix registers flags with prefix.

type Shipper

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

func (*Shipper) BatchWrite

func (s *Shipper) BatchWrite(ctx context.Context, batch chunk.WriteBatch) error

func (*Shipper) NewWriteBatch

func (s *Shipper) NewWriteBatch() chunk.WriteBatch

func (*Shipper) QueryPages

func (s *Shipper) QueryPages(ctx context.Context, queries []chunk.IndexQuery, callback func(chunk.IndexQuery, chunk.ReadBatch) (shouldContinue bool)) error

func (*Shipper) Stop

func (s *Shipper) Stop()