log

type GetOptions struct {
	// LogNames are the names of the logs to fetch and merge, prefixes may
	// be specified. At least one name must be specified.
	//
	// Log lines from multiple logs are always merged in a deterministic
	// order by timestamp.
	LogNames []string
	// Start is the start time (inclusive) of the time range filter,
	// represented as a Unix timestamp in nanoseconds. Defaults to
	// unbounded unless DefaultTimeRangeOfFirstLog is set to true.
	Start *int64
	// End is the end time (inclusive) of the time range filter,
	// represented as a Unix timestamp in nanoseconds. Defaults to
	// unbounded unless DefaultTimeRangeOfFirstLog is set to true.
	End *int64
	// DefaultTimeRangeOfFirstLog defaults the start and end time of the
	// time range filter to the first and last timestamp, respectively, of
	// the first specified log in LogNames.
	DefaultTimeRangeOfFirstLog bool
	// LineLimit limits the number of lines read from the log. Ignored if
	// less than or equal to 0.
	LineLimit int
	// TailN is the number of lines to read from the tail of the log.
	// Ignored if less than or equal to 0.
	TailN int
}

type LineParser func(string) (LogLine, error)

type LogIterator interface {
	// Next returns true if the iterator has not yet been exhausted or
	// closed, false otherwise.
	Next() bool
	// Item returns the current log line held by the iterator.
	Item() LogLine
	// Exhausted returns true if the iterator has not yet been exhausted,
	// regardless if it has been closed or not.
	Exhausted() bool
	// Err returns any errors that are captured by the iterator.
	Err() error
	// Close closes the iterator. This function should be called once the
	// iterator is no longer needed.
	Close() error
}

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

type LogIteratorReaderOptions struct {
	// PrintTime, when true, prints the timestamp of each log line along
	// with the line in the following format:
	//		[2006/01/02 15:04:05.000] This is a log line.
	PrintTime bool
	// TimeZone is the time zone to use when printing the timestamp of each
	// each log line. Optional. Defaults to UTC.
	TimeZone *time.Location
	// PrintPriority, when true, prints the priority of each log line along
	// with the line in the following format:
	//		[P: 30] This is a log line.
	// If PrintTime is also set to true, priority will be printed first:
	//		[P:100] [2006/01/02 15:04:05.000] This is a log line.
	PrintPriority bool
	// SoftSizeLimit assists with pagination of long logs. When set the
	// reader will attempt to read as close to the limit as possible while
	// also reading every line for each timestamp reached. Optional.
	SoftSizeLimit int
}

type LogLine struct {
	LogName   string
	Priority  level.Priority
	Timestamp int64
	Data      string
}

type LogService interface {
	// Get returns a log iterator with the given options.
	Get(context.Context, GetOptions) (LogIterator, error)
	// Append appends given lines to the specified log.
	Append(context.Context, string, []LogLine) error
}

type SenderOptions struct {
	// LogName is the identifying name of the log to use when persisting
	// data.
	LogName string
	// Parse is the function for parsing raw log lines collected by the
	// sender.
	// The injectable line parser allows the sender to be agnostic to the
	// raw log line formats it ingests.
	// Defaults to a basic line parser that adds the raw string as the log
	// line data field.
	Parse LineParser
	// Local is the sender for "fallback" operations and to collect any
	// logger error output.
	Local send.Sender
	// MaxBufferSize is the maximum number of bytes to buffer before
	// persisting log data. Defaults to 10MB.
	MaxBufferSize int
	// FlushInterval is time interval at which to flush log lines,
	// regardless of whether the max buffer size has been reached. A flush
	// interval equal to 0 will disable timed flushes.
	FlushInterval time.Duration
}