Categorygithub.com/getlantern/rotator
modulepackage
0.0.0-20160829164113-013d4f8e36a2
Repository: https://github.com/getlantern/rotator.git
Documentation: pkg.go.dev

# README

rotator

Build Status Coverage License

Rotator is a file writer which rotates by date and size. Rotator can be used any kind of files since it implments io.Writer.

go get github.com/dozenzaka/rotator

Size rotations

Size based rotator will rotate target file when the size of the file is exceeded. Default size for the rotation is 10MiB. When file is rotated, it will find available id for the file such as rotated.log.5 and rename it.

package main

import(
  "github.com/dogenzaka/rotator"
)

func main() {
  file := rotator.NewSizeRotator("/var/log/rotated.log")
  defer file.Close()
  file.Write([]byte("FIRST TEXT"))
  file.Write([]byte("SECOND TEXT"))
  file.WriteString("THIRD STRING")
}

To configure rotations, set properties of rotator instances.

file := rotator.NewSizeRotator("/var/log/rotated.log")
file.MaxRotation = 999 // Maximum counts of the file rotation. Default is 999
file.RotationSize = int64(1024*1024*10) // Size threashold which cause rotation. Default is 10MiB

Daily rotations

Daily based rotator will rotate target file when the date is changed. When file is rotated, it will rename the file to rotated name such as rotated.log.2014-10-12.

package main

import (
  "github.com/dogenzaka/rotator"
)

func main() {
  file := rotator.NewDailyRotator("/var/log/rotated.log")
  defer file.Close()
  file.Write([]byte("FIRST TEXT"))
  file.Write([]byte("SECOND TEXT"))
  file.WriteString("THIRD STRING")
}

License

rotator is licensed under MIT

# Functions

NewDailyRotator creates rotator which writes to the file.
NewSizeRotator creates new writer of the file.

# Structs

DailyRotator is writer which rotates file by date.
SizeRotator is file writer which rotates files by size.

# Interfaces

Rotator interface.