limits

type Key string

type LookbackLimit interface {
	// Options returns the current limit options.
	Options() LookbackLimitOptions
	// Inc increments the recent value for the limit.
	Inc(val int, source []byte) error
	// Update changes the lookback limit settings.
	Update(opts LookbackLimitOptions) error

	// Start begins background resetting of the lookback limit.
	Start()
	// Stop end background resetting of the lookback limit.
	Stop()
}

type LookbackLimitOptions struct {
	// Limit past which errors will be returned.
	// Zero disables the limit.
	Limit int64
	// Lookback is the period over which the limit is enforced.
	Lookback time.Duration
	// ForceExceeded, if true, makes all calls to the limit behave as though the limit is exceeded.
	ForceExceeded bool
	// ForceWaited, if true, makes all calls to the limit behave as though the caller waited for permits.
	ForceWaited bool
}

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

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

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

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

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

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

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

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

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

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

type Options interface {
	// Validate validates the options.
	Validate() error

	// SetInstrumentOptions sets the instrument options.
	SetInstrumentOptions(value instrument.Options) Options

	// InstrumentOptions returns the instrument options.
	InstrumentOptions() instrument.Options

	// SetDocsLimitOpts sets the doc limit options.
	SetDocsLimitOpts(value LookbackLimitOptions) Options

	// DocsLimitOpts returns the doc limit options.
	DocsLimitOpts() LookbackLimitOptions

	// SetBytesReadLimitOpts sets the byte read limit options.
	SetBytesReadLimitOpts(value LookbackLimitOptions) Options

	// BytesReadLimitOpts returns the byte read limit options.
	BytesReadLimitOpts() LookbackLimitOptions

	// SetAggregateDocsLimitOpts sets the aggregate doc limit options.
	SetAggregateDocsLimitOpts(LookbackLimitOptions) Options

	// AggregateDocsLimitOpts returns the aggregate doc limit options.
	AggregateDocsLimitOpts() LookbackLimitOptions

	// SetDiskSeriesReadLimitOpts sets the disk series read limit options.
	SetDiskSeriesReadLimitOpts(value LookbackLimitOptions) Options

	// DiskSeriesReadLimitOpts returns the disk series read limit options.
	DiskSeriesReadLimitOpts() LookbackLimitOptions

	// SetSourceLoggerBuilder sets the source logger.
	SetSourceLoggerBuilder(value SourceLoggerBuilder) Options

	// SourceLogger sets the source logger.
	SourceLoggerBuilder() SourceLoggerBuilder
}

type QueryLimits interface {
	// FetchDocsLimit limits queries by a global concurrent count of index docs matched.
	FetchDocsLimit() LookbackLimit
	// BytesReadLimit limits queries by a global concurrent count of bytes read from disk.
	BytesReadLimit() LookbackLimit
	// AnyFetchExceeded returns an error if any of the query limits are exceeded on
	// a fetch query.
	AnyFetchExceeded() error

	// AggregateDocsLimit limits aggregate queries by a global
	// concurrent count of index docs matched.
	AggregateDocsLimit() LookbackLimit

	// Start begins background resetting of the query limits.
	Start()
	// Stop end background resetting of the query limits.
	Stop()
}

type SourceLogger interface {
	// LogSourceValue attributes values that exceed a given size to the source.
	LogSourceValue(val int64, source []byte)
}

type SourceLoggerBuilder interface {
	// NewSourceLogger builds a source logger.
	NewSourceLogger(name string, opts instrument.Options) SourceLogger
}