api

type Batch ¶

type Batch interface {
	ForEach(func(interface{}) error) error
	Size() int
}

Batch represents a batch of logs.

type BatchOfOne ¶

type BatchOfOne struct {
	Inner interface{}
}

BatchOfOne is a wrapper for a single log that implements Batch.

func ToBatchOfOne(x interface{}) BatchOfOne

func (l BatchOfOne) ForEach(f func(interface{}) error) error

func (l BatchOfOne) Size() int

type BatchRequest ¶

type BatchRequest struct {
	Offset int
	Limit  int
	Follow bool
}

BatchRequest describes the parameters needed to target a subset of logs.

type BatchResult ¶

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

BatchResult contains either a batch or an error.

func ErrBatchResult(err error) BatchResult

func OkBatchResult(b Batch) BatchResult

func (r *BatchResult) Batch() Batch

func (r *BatchResult) Err() error

type BatchStreamProcessor ¶

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

BatchStreamProcessor is an actor that fetches batches and processes them. It handles common logic around limits, offsets and backpressure.

The type of batches produced by the FetchBatchFn must match those handled by the OnBatchFn or the actor will panic.

func NewBatchStreamProcessor(
	req BatchRequest,
	fetcher FetchBatchFn,
	terminateCheck TerminationCheckFn,
	alwaysCheckTermination bool,
	batchWaitTime *time.Duration,
	batchMissWaitTime *time.Duration,
) *BatchStreamProcessor

func (p *BatchStreamProcessor) Run(ctx context.Context, res chan BatchResult)

type FetchBatchFn ¶

type FetchBatchFn func(BatchRequest) (Batch, error)

FetchBatchFn fetches returns a batch.

type Filter ¶

type Filter struct {
	Field     string
	Operation FilterOperation
	Values    interface{}
}

Filter is a general representation for a filter provided to an API.

type FilterOperation ¶

type FilterOperation int

FilterOperation is an operation in a filter.

const (
	// FilterOperationIn checks set membership.
	FilterOperationIn FilterOperation = iota
	// FilterOperationInOrNull checks membership or a NULL option.
	FilterOperationInOrNull
	// FilterOperationGreaterThan checks if the field is greater than a value.
	FilterOperationGreaterThan
	// FilterOperationLessThanEqual checks if the field is less than or equal to a value.
	FilterOperationLessThanEqual
	// FilterOperationStringContainment checks if the field contains a value as a substring.
	FilterOperationStringContainment
)

type MaybeInt ¶

type MaybeInt struct {
	IsPresent bool
	Value     *int
}

MaybeInt allows JSON users to distinguish between absent and null values. It should be used as a non-pointer value in structs. After unmarshaling, IsPresent will be true if the corresponding key is present, whether or not the value is null; Value will be nil or not, depending on the value.

Based on: https://www.calhoun.io/how-to-determine-if-a-json-key-has-been-set-to-null-or-not-provided/

func (i *MaybeInt) UnmarshalJSON(data []byte) error

type OnBatchFn ¶

type OnBatchFn func(Batch) error

OnBatchFn is a callback called on each batch.

type Pagination ¶

type Pagination struct {
	StartIndex int // Inclusive
	EndIndex   int // Exclusive
}

Pagination contains resolved pagination indices.

func CalculatePagination(total, offset, limit int) (*Pagination, error)

type TerminationCheckFn ¶

type TerminationCheckFn func() (bool, error)

TerminationCheckFn checks whether the log processing should stop or not.