options

Documentation

Index

• Constants
• func WithCatalogGCInterval(internal time.Duration) func(*Options)
• func WithCheckpointGlobalMinCount(count int64) func(*Options)
• func WithCheckpointIncrementaInterval(interval time.Duration) func(*Options)
• func WithCheckpointMinCount(count int64) func(*Options)
• func WithCheckpointScanInterval(interval time.Duration) func(*Options)
• func WithDisableGCCatalog() func(*Options)
• func WithDisableGCCheckpoint() func(*Options)
• func WithFlushInterval(interval time.Duration) func(*Options)
• func WithGCCheckpointInterval(interval time.Duration) func(*Options)
• func WithGlobalVersionInterval(interval time.Duration) func(*Options)
• func WithReserveWALEntryCount(count uint64) func(*Options)
• func WithTransferTableTTL(ttl time.Duration) func(*Options)
• type CatalogCfg
• type CheckpointCfg
• type GCCfg
• type LogstoreType
• type LogtailCfg
• type LogtailServerCfg
  • func NewDefaultLogtailServerCfg() *LogtailServerCfg
  • func (l *LogtailServerCfg) Validate()
• type MergeConfig
• type Options
  • func (o *Options) FillDefaults(dirname string) *Options
• type SchedulerCfg
• type StorageCfg

Constants

const (
	DefaultIndexCacheSize = 256 * mpool.MB

	DefaultBlockMaxRows    = uint32(8192)
	DefaultBlocksPerObject = uint16(256)

	DefaultObjectPerSegment = uint16(512)

	DefaultScannerInterval              = time.Second * 5
	DefaultCheckpointFlushInterval      = time.Minute
	DefaultCheckpointMinCount           = int64(100)
	DefaultCheckpointIncremetalInterval = time.Minute
	DefaultCheckpointGlobalMinCount     = 10
	DefaultGlobalVersionInterval        = time.Hour
	DefaultGCCheckpointInterval         = time.Minute
	DefaultOverallFlushMemControl       = common.Const1GBytes

	DefaultScanGCInterval = time.Minute * 30
	DefaultGCTTL          = time.Hour

	DefaultCatalogGCInterval = time.Minute * 30

	DefaultIOWorkers    = int(16)
	DefaultAsyncWorkers = int(16)

	DefaultLogtailTxnPageSize = 256

	DefaultLogstoreType = LogstoreBatchStore
)

Functions

func WithCatalogGCInterval

func WithCatalogGCInterval(internal time.Duration) func(*Options)

func WithCheckpointGlobalMinCount

func WithCheckpointGlobalMinCount(count int64) func(*Options)

func WithCheckpointIncrementaInterval

func WithCheckpointIncrementaInterval(interval time.Duration) func(*Options)

func WithCheckpointMinCount

func WithCheckpointMinCount(count int64) func(*Options)

func WithCheckpointScanInterval

func WithCheckpointScanInterval(interval time.Duration) func(*Options)

func WithDisableGCCatalog

func WithDisableGCCatalog() func(*Options)

func WithDisableGCCheckpoint

func WithDisableGCCheckpoint() func(*Options)

func WithFlushInterval

func WithFlushInterval(interval time.Duration) func(*Options)

func WithGCCheckpointInterval

func WithGCCheckpointInterval(interval time.Duration) func(*Options)

func WithGlobalVersionInterval

func WithGlobalVersionInterval(interval time.Duration) func(*Options)

func WithReserveWALEntryCount

func WithReserveWALEntryCount(count uint64) func(*Options)

func WithTransferTableTTL

func WithTransferTableTTL(ttl time.Duration) func(*Options)

Types

type CatalogCfg

type CatalogCfg struct {
	GCInterval time.Duration
	DisableGC  bool
}

type CheckpointCfg

type CheckpointCfg struct {
	FlushInterval             time.Duration `toml:"flush-inerterval"`
	MinCount                  int64         `toml:"checkpoint-min-count"`
	ScanInterval              time.Duration `toml:"scan-interval"`
	IncrementalInterval       time.Duration `toml:"checkpoint-incremental-interval"`
	GlobalMinCount            int64         `toml:"checkpoint-global-interval"`
	OverallFlushMemControl    uint64        `toml:"overall-flush-mem-control"`
	ForceUpdateGlobalInterval bool
	GlobalVersionInterval     time.Duration
	GCCheckpointInterval      time.Duration
	DisableGCCheckpoint       bool
	ReservedWALEntryCount     uint64
	StartupLatency            time.Duration

	// only for test
	// it is used to control the block rows of the checkpoint
	BlockRows int
	Size      int
}

type GCCfg

type GCCfg struct {
	GCTTL          time.Duration `toml:"gc-ttl"`
	ScanGCInterval time.Duration `toml:"scan-gc-interval"`
	DisableGC      bool          `toml:"disable-gc"`
	CheckGC        bool          `toml:"check-gc"`
}

type LogstoreType

type LogstoreType string

const (
	LogstoreBatchStore LogstoreType = "batchstore"
	LogstoreLogservice LogstoreType = "logservice"
)

type LogtailCfg

type LogtailCfg struct {
	PageSize int32 `toml:"page-size"`
}

type LogtailServerCfg

type LogtailServerCfg struct {
	RpcMaxMessageSize      int64
	RpcEnableChecksum      bool
	RPCStreamPoisonTime    time.Duration
	LogtailCollectInterval time.Duration
	ResponseSendTimeout    time.Duration
	// PullWorkerPoolSize is the size of the pull worker pool.
	// Means there are x pull workers working at most.
	// Default value is defaultPullWorkerPoolSize=50.
	PullWorkerPoolSize int64
}

func NewDefaultLogtailServerCfg

func NewDefaultLogtailServerCfg() *LogtailServerCfg

func (*LogtailServerCfg) Validate

func (l *LogtailServerCfg) Validate()

type MergeConfig

type MergeConfig struct {
	CNMergeMemControlHint uint64
	CNTakeOverAll         bool
	CNTakeOverExceed      uint64
	CNStandaloneTake      bool
}

type Options

type Options struct {
	StorageCfg    *StorageCfg    `toml:"storage-cfg"`
	CheckpointCfg *CheckpointCfg `toml:"checkpoint-cfg"`
	SchedulerCfg  *SchedulerCfg  `toml:"scheduler-cfg"`
	GCCfg         *GCCfg         `toml:"gc-cfg"`
	LogtailCfg    *LogtailCfg
	MergeCfg      *MergeConfig
	CatalogCfg    *CatalogCfg

	// MaxMessageSize is the size of max message which is sent to log-service.
	MaxMessageSize   uint64
	TransferTableTTL time.Duration
	IncrementalDedup bool
	IsStandalone     bool
	LogStoreT        LogstoreType

	Fs                fileservice.FileService                  `toml:"-"`
	Lc                logservicedriver.LogServiceClientFactory `toml:"-"`
	Ctx               context.Context                          `toml:"-"`
	Shard             metadata.TNShard                         `toml:"-"`
	Clock             clock.Clock                              `toml:"-"`
	TaskServiceGetter taskservice.Getter                       `toml:"-"`
}

func (*Options) FillDefaults

func (o *Options) FillDefaults(dirname string) *Options

type SchedulerCfg

type SchedulerCfg struct {
	IOWorkers    int `toml:"io-workers"`
	AsyncWorkers int `toml:"async-workers"`
}

type StorageCfg

type StorageCfg struct {
	BlockMaxRows    uint32 `toml:"block-max-rows"`
	ObjectMaxBlocks uint16 `toml:"object-max-blocks"`
}