backup

Documentation

Index

• type Compression
• type CompressionLevel
• type CompressionWriterFactory
  • func NewCompressionWriterFactory(enabled bool, compression Compression, level CompressionLevel) CompressionWriterFactory
• type FileBackup
  • func NewFileBackup(archive IBackupSingle) (*FileBackup, error)
  • func (b *FileBackup) Flush()
  • func (b *FileBackup) SaveAsync(event *types.Event)
• type IBackup
  • func New(enabled bool, backupInterval time.Duration, baseDirectory string, ...) (IBackup, error)
• type IBackupSingle
• type NullBackup
  • func NewNullBackup() *NullBackup
  • func (*NullBackup) Flush()
  • func (*NullBackup) SaveAsync(_ *types.Event)
• type SingleFileBackup
  • func NewSingleFileBackup(backupInterval time.Duration, directory string, ...) *SingleFileBackup
  • func (b *SingleFileBackup) Compress()
  • func (b *SingleFileBackup) Flush()
  • func (b *SingleFileBackup) SaveAsync(event *types.Event)

Types

type Compression

type Compression string

Compression the type of compression

const (
	// NoneCompression no compression
	NoneCompression Compression = "NONE"
	// GZIPCompression gzip
	GZIPCompression Compression = "GZIP"
	// ZStandardCompression Zstandard
	ZStandardCompression Compression = "Zstandard"
)

type CompressionLevel

type CompressionLevel string

CompressionLevel the level of compression

const (
	// NoCompressionLevel no compression
	NoCompressionLevel CompressionLevel = "No"
	// BestSpeedCompressionLevel best speed
	BestSpeedCompressionLevel CompressionLevel = "BestSpeed"
	// DefaultCompressionLevel default compression
	DefaultCompressionLevel CompressionLevel = "Default"
	// BestCompressionCompressionLevel best compression
	BestCompressionCompressionLevel CompressionLevel = "BestCompression"
	// HuffmanOnlyCompressionLevel HuffmanOnly gzip specific compression
	HuffmanOnlyCompressionLevel CompressionLevel = "HuffmanOnly"
)

type CompressionWriterFactory

type CompressionWriterFactory interface {
	// Create returns a compression writer
	Create(io.Writer) (io.WriteCloser, error)
	// Filename returns the new filename based on the compression
	Filename(originalFilename string) string
}

CompressionWriterFactory is factory for compression writer

func NewCompressionWriterFactory

func NewCompressionWriterFactory(
	enabled bool,
	compression Compression,
	level CompressionLevel,
) CompressionWriterFactory

NewCompressionWriterFactory constructor of CompressionWriterFactory nolint: revive

type FileBackup

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

FileBackup saves the events on the file system

func NewFileBackup

func NewFileBackup(
	archive IBackupSingle,
) (*FileBackup, error)

NewFileBackup creates file system backup service nolint: revive

func (*FileBackup) Flush

func (b *FileBackup) Flush()

Flush is called before shutdown to force process of the last batch

func (*FileBackup) SaveAsync

func (b *FileBackup) SaveAsync(event *types.Event)

SaveAsync saves an event with default batcher

type IBackup

type IBackup interface {
	SaveAsync(event *types.Event)
	Flush()
}

IBackup interface for all backup sub directories

func New

func New(
	enabled bool,
	backupInterval time.Duration,
	baseDirectory string,
	compressionFactory CompressionWriterFactory,
) (IBackup, error)

New is factory for backup service nolint: revive

type IBackupSingle

type IBackupSingle interface {
	SaveAsync(event *types.Event)
	Flush()
	Compress()
}

IBackupSingle is single directory backup interface

type NullBackup

type NullBackup struct {
}

NullBackup is disabled backup implementation

func NewNullBackup

func NewNullBackup() *NullBackup

NewNullBackup creates disabled backup implementation

func (*NullBackup) Flush

func (*NullBackup) Flush()

Flush disabled implementation

func (*NullBackup) SaveAsync

func (*NullBackup) SaveAsync(_ *types.Event)

SaveAsync disabled implementation

type SingleFileBackup

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

SingleFileBackup saves the events on the file system

func NewSingleFileBackup

func NewSingleFileBackup(
	backupInterval time.Duration,
	directory string,
	compressionFactory CompressionWriterFactory,
) *SingleFileBackup

NewSingleFileBackup creates single file system backup service nolint: revive

func (*SingleFileBackup) Compress

func (b *SingleFileBackup) Compress()

Compress aggregates hourly files into daily summary with meta

func (*SingleFileBackup) Flush

func (b *SingleFileBackup) Flush()

Flush is called before shutdown to force process of the last batch

func (*SingleFileBackup) SaveAsync

func (b *SingleFileBackup) SaveAsync(event *types.Event)

SaveAsync saves an event with default batcher nolint: revive