Skip to content
Go library for a file that rotates daily
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
daily_rotate_file.go
daily_rotate_file_test.go

README.md

dailyrotate

When logging to a file, you often want to rotate files daily i.e. create a new log file for each new day.

This Go package makes it easy. You specify the pattern for file name and the rest is handled by the library.

Usage

pathFormat := filepath.Join("dir", "2006-01-02.txt")
func onClose(path string, didRotate bool) {
  fmt.Printf("we just closed a file '%s', didRotate: %v\n", path, didRotate)
  if !didRotate {
    return
  }
  // process just closed file e.g. upload to backblaze storage for backup
  go func() {
    // if processing takes a long time, do it in a background goroutine
  }()
}

w, err := dailyrotate.NewFile(pathFormat, onClose)
panicIfErr(err)

_, err = io.WriteString(w, "hello\n")
panicIfErr(err)

err = w.Close()
panicIfErr(err)

Given that files are rotated daily, you need to provide a file name format which will be passed to time.Now().UTC().Format() function. It should produce a unique file name each day e.g. 2006-01-02.log

You can also provide onClose function which will be called when the file is closed (either because of rotation or calling Close()).

You can use that to e.g. backup the just rotated file to backblaze.

You can’t perform that action at this time.