cleaner

Documentation

Index

• Constants
• Variables
• type CleanSignal
• type Cleaner
  • func NewCleaner(conf conf.MapConf, meta *reader.Meta, cleanChan chan<- CleanSignal, ...) (*Cleaner, error)
  • func (c *Cleaner) Clean() (err error)
  • func (c *Cleaner) Close()
  • func (c *Cleaner) LogDir() string
  • func (c *Cleaner) Name() string
  • func (c *Cleaner) Run()

Constants

const (
	KeyCleanEnable       = "delete_enable"
	KeyCleanInterval     = "delete_interval"
	KeyReserveFileNumber = "reserve_file_number"
	KeyReserveFileSize   = "reserve_file_size"
)

Variables

var (
	OptionDeleteEnable = Option{
		KeyName:       KeyCleanEnable,
		Element:       Checkbox,
		ChooseOnly:    true,
		ChooseOptions: []interface{}{"true", "false"},
		Default:       "false",
		DefaultNoUse:  false,
		Description:   "开启日志删除功能(delete_enable)",
		Advance:       false,
		ToolTip:       `删除控制功能，默认不开启，当为true时开启。开启后，对于已经读取完毕的数据，cleaner会负责通知删除。带通配符的日志读取请使用自动删除读取完毕的过期文件功能。`,
	}

	OptionCleanInterval = Option{
		KeyName:      KeyCleanInterval,
		ChooseOnly:   false,
		Default:      "300",
		DefaultNoUse: false,
		Description:  "执行周期,单位为秒(s)(delete_interval)",
		Advance:      true,
		ToolTip:      `在每个周期检查是否符合删除的条件。"`,
	}

	OptionReserveFileNumber = Option{
		KeyName:      KeyReserveFileNumber,
		ChooseOnly:   false,
		Default:      "10",
		DefaultNoUse: false,
		Description:  "最大保留的已读取文件数(reserve_file_number)",
		Advance:      true,
		ToolTip:      `当已读文件数超过最大保留文件数时，即使文件总大小没到最大保留已读文件总大小的限制，也会删除。`,
	}

	OptionReserveFileSize = Option{
		KeyName:      KeyReserveFileSize,
		ChooseOnly:   false,
		Default:      "2048",
		DefaultNoUse: false,
		Description:  "最大保留已读文件总大小,单位为MB(reserve_file_size)",
		Advance:      true,
		ToolTip:      `当已读文件的总大小超过这个值时，会把最老的那部分删掉，直到剩下的文件总大小在范围内，还有数据写入的文件不会被删除，默认保留2GB，单位为MB。`,
	}
)

var ModeKeyOptions = []Option{
	OptionDeleteEnable,
	OptionCleanInterval,
	OptionReserveFileNumber,
	OptionReserveFileSize,
}

Types

type CleanSignal

type CleanSignal struct {
	Logdir   string
	Filename string
	Cleaner  string
	ReadMode string
}

type Cleaner

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

func NewCleaner

func NewCleaner(conf conf.MapConf, meta *reader.Meta, cleanChan chan<- CleanSignal, logdir string) (*Cleaner, error)

删除文件时遍历全部 删除时生成filedeleted文件

func (*Cleaner) Clean

func (c *Cleaner) Clean() (err error)

func (*Cleaner) Close

func (c *Cleaner) Close()

func (*Cleaner) LogDir

func (c *Cleaner) LogDir() string

func (*Cleaner) Name

func (c *Cleaner) Name() string

func (*Cleaner) Run

func (c *Cleaner) Run()