internal

Documentation

Index

• Constants
• Variables
• func CreateFile(filename string, fi os.FileInfo) (*os.File, error)
• func Fileinfo(fi os.FileInfo) (uid, gid int)
• func Hexdump(data []byte) string
• func LimitReadCloser(r io.ReadCloser, n int64) io.ReadCloser
• func MkdirAll(path string, fi os.FileInfo) error
• func NewLZ4Reader(r io.ReadCloser) io.ReadCloser
• func ReplaceAttr(groups []string, a slog.Attr) slog.Attr
• type LZ4ReadCloser
  • func (r *LZ4ReadCloser) Close() error
• type LimitedReadCloser
  • func (l *LimitedReadCloser) Close() error
  • func (l *LimitedReadCloser) Read(p []byte) (n int, err error)
• type ReadCloser
  • func NewReadCloser(r io.Reader, c io.Closer) *ReadCloser
  • func (r *ReadCloser) Close() error
  • func (r *ReadCloser) Read(p []byte) (n int, err error)
• type ReadCounter
  • func NewReadCounter(r io.Reader) *ReadCounter
  • func (r *ReadCounter) N() int64
  • func (r *ReadCounter) Read(p []byte) (int, error)

Constants

const LevelTrace = slog.LevelDebug - 4

Variables

var (
	OperationTotalCounterVec = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "litestream_replica_operation_total",
		Help: "The number of replica operations performed",
	}, []string{"replica_type", "operation"})

	OperationBytesCounterVec = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "litestream_replica_operation_bytes",
		Help: "The number of bytes used by replica operations",
	}, []string{"replica_type", "operation"})

	OperationDurationHistogramVec = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name:    "litestream_replica_operation_duration_seconds",
		Help:    "Duration of replica operations by type and operation",
		Buckets: []float64{0.01, 0.05, 0.1, 0.5, 1, 5, 10, 30, 60},
	}, []string{"replica_type", "operation"})

	OperationErrorCounterVec = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "litestream_replica_operation_errors_total",
		Help: "Number of replica operation errors by type, operation, and error code",
	}, []string{"replica_type", "operation", "code"})

	L0RetentionGaugeVec = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Name: "litestream_l0_retention_files_total",
		Help: "Number of L0 files by status during retention enforcement",
	}, []string{"db", "status"})
)

Shared replica metrics.

Functions

func CreateFile

func CreateFile(filename string, fi os.FileInfo) (*os.File, error)

CreateFile creates the file and matches the mode & uid/gid of fi.

func Fileinfo

func Fileinfo(fi os.FileInfo) (uid, gid int)

Fileinfo returns syscall fields from a FileInfo object.

func Hexdump

func Hexdump(data []byte) string

func LimitReadCloser

func LimitReadCloser(r io.ReadCloser, n int64) io.ReadCloser

Copied from the io package to implement io.Closer.

func MkdirAll

func MkdirAll(path string, fi os.FileInfo) error

MkdirAll is a copy of os.MkdirAll() except that it attempts to set the mode/uid/gid to match fi for each created directory.

func NewLZ4Reader

func NewLZ4Reader(r io.ReadCloser) io.ReadCloser

NewLZ4Reader creates an LZ4 decompressing reader that wraps the source. Closing the returned reader also closes the underlying source.

func ReplaceAttr

func ReplaceAttr(groups []string, a slog.Attr) slog.Attr

Types

type LZ4ReadCloser

type LZ4ReadCloser struct {
	*lz4.Reader
	// contains filtered or unexported fields
}

LZ4ReadCloser wraps an LZ4 reader with the underlying source for proper closing.

func (*LZ4ReadCloser) Close

func (r *LZ4ReadCloser) Close() error

type LimitedReadCloser

type LimitedReadCloser struct {
	R io.ReadCloser // underlying reader
	N int64         // max bytes remaining
}

func (*LimitedReadCloser) Close

func (l *LimitedReadCloser) Close() error

func (*LimitedReadCloser) Read

func (l *LimitedReadCloser) Read(p []byte) (n int, err error)

type ReadCloser

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

ReadCloser wraps a reader to also attach a separate closer.

func NewReadCloser

func NewReadCloser(r io.Reader, c io.Closer) *ReadCloser

NewReadCloser returns a new instance of ReadCloser.

func (*ReadCloser) Close

func (r *ReadCloser) Close() error

Close closes the reader (if implementing io.ReadCloser) and the Closer.

func (*ReadCloser) Read

func (r *ReadCloser) Read(p []byte) (n int, err error)

Read reads bytes into the underlying reader.

type ReadCounter

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

ReadCounter wraps an io.Reader and counts the total number of bytes read.

func NewReadCounter

func NewReadCounter(r io.Reader) *ReadCounter

NewReadCounter returns a new instance of ReadCounter that wraps r.

func (*ReadCounter) N

func (r *ReadCounter) N() int64

N returns the total number of bytes read.

func (*ReadCounter) Read

func (r *ReadCounter) Read(p []byte) (int, error)

Read reads from the underlying reader into p and adds the bytes read to the counter.