Adding upstream version 1.34.4.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
e393c3af3f
commit
4978089aab
GPG key ID:
FBB4F0E80A80222F
4963 changed files with 677545 additions and 0 deletions
183
internal/rotate/file_writer.go
Normal file
183
internal/rotate/file_writer.go
Normal file
|
|
@ -0,0 +1,183 @@
|
|||
package rotate
|
||||
|
||||
// Rotating things
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
// FilePerm defines the permissions that Writer will use for all
|
||||
// the files it creates.
|
||||
const (
|
||||
FilePerm = os.FileMode(0644)
|
||||
DateFormat = "2006-01-02"
|
||||
)
|
||||
|
||||
// FileWriter implements the io.Writer interface and writes to the
|
||||
// filename specified.
|
||||
// Will rotate at the specified interval and/or when the current file size exceeds maxSizeInBytes
|
||||
// At rotation time, current file is renamed and a new file is created.
|
||||
// If the number of archives exceeds maxArchives, older files are deleted.
|
||||
type FileWriter struct {
|
||||
filename string
|
||||
filenameRotationTemplate string
|
||||
current *os.File
|
||||
interval time.Duration
|
||||
maxSizeInBytes int64
|
||||
maxArchives int
|
||||
expireTime time.Time
|
||||
bytesWritten int64
|
||||
sync.Mutex
|
||||
}
|
||||
|
||||
// NewFileWriter creates a new file writer.
|
||||
func NewFileWriter(filename string, interval time.Duration, maxSizeInBytes int64, maxArchives int) (io.WriteCloser, error) {
|
||||
if interval == 0 && maxSizeInBytes <= 0 {
|
||||
// No rotation needed so a basic io.Writer will do the trick
|
||||
return openFile(filename)
|
||||
}
|
||||
|
||||
w := &FileWriter{
|
||||
filename: filename,
|
||||
interval: interval,
|
||||
maxSizeInBytes: maxSizeInBytes,
|
||||
maxArchives: maxArchives,
|
||||
filenameRotationTemplate: getFilenameRotationTemplate(filename),
|
||||
}
|
||||
|
||||
if err := w.openCurrent(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return w, nil
|
||||
}
|
||||
|
||||
func openFile(filename string) (*os.File, error) {
|
||||
return os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_APPEND, FilePerm)
|
||||
}
|
||||
|
||||
func getFilenameRotationTemplate(filename string) string {
|
||||
// Extract the file extension
|
||||
fileExt := filepath.Ext(filename)
|
||||
// Remove the file extension from the filename (if any)
|
||||
stem := strings.TrimSuffix(filename, fileExt)
|
||||
return stem + ".%s-%s" + fileExt
|
||||
}
|
||||
|
||||
// Write writes p to the current file, then checks to see if
|
||||
// rotation is necessary.
|
||||
func (w *FileWriter) Write(p []byte) (n int, err error) {
|
||||
w.Lock()
|
||||
defer w.Unlock()
|
||||
if n, err = w.current.Write(p); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
w.bytesWritten += int64(n)
|
||||
|
||||
if err := w.rotateIfNeeded(); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// Close closes the current file. Writer is unusable after this
|
||||
// is called.
|
||||
func (w *FileWriter) Close() (err error) {
|
||||
w.Lock()
|
||||
defer w.Unlock()
|
||||
|
||||
// Rotate before closing
|
||||
if err := w.rotateIfNeeded(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Close the file if we did not rotate
|
||||
if err := w.current.Close(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
w.current = nil
|
||||
return nil
|
||||
}
|
||||
|
||||
func (w *FileWriter) openCurrent() (err error) {
|
||||
// In case ModTime() fails, we use time.Now()
|
||||
w.expireTime = time.Now().Add(w.interval)
|
||||
w.bytesWritten = 0
|
||||
w.current, err = openFile(w.filename)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Goal here is to rotate old pre-existing files.
|
||||
// For that we use fileInfo.ModTime, instead of time.Now().
|
||||
// Example: telegraf is restarted every 23 hours and
|
||||
// the rotation interval is set to 24 hours.
|
||||
// With time.now() as a reference we'd never rotate the file.
|
||||
if fileInfo, err := w.current.Stat(); err == nil {
|
||||
w.expireTime = fileInfo.ModTime().Add(w.interval)
|
||||
w.bytesWritten = fileInfo.Size()
|
||||
}
|
||||
|
||||
return w.rotateIfNeeded()
|
||||
}
|
||||
|
||||
func (w *FileWriter) rotateIfNeeded() error {
|
||||
if (w.interval > 0 && time.Now().After(w.expireTime)) ||
|
||||
(w.maxSizeInBytes > 0 && w.bytesWritten >= w.maxSizeInBytes) {
|
||||
if err := w.rotate(); err != nil {
|
||||
// Ignore rotation errors and keep the log open
|
||||
fmt.Printf("unable to rotate the file %q, %s", w.filename, err.Error())
|
||||
}
|
||||
return w.openCurrent()
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (w *FileWriter) rotate() (err error) {
|
||||
if err := w.current.Close(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Use year-month-date for readability, unix time to make the file name unique with second precision
|
||||
now := time.Now()
|
||||
rotatedFilename := fmt.Sprintf(w.filenameRotationTemplate, now.Format(DateFormat), strconv.FormatInt(now.Unix(), 10))
|
||||
if err := os.Rename(w.filename, rotatedFilename); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return w.purgeArchivesIfNeeded()
|
||||
}
|
||||
|
||||
func (w *FileWriter) purgeArchivesIfNeeded() (err error) {
|
||||
if w.maxArchives == -1 {
|
||||
// Skip archiving
|
||||
return nil
|
||||
}
|
||||
|
||||
var matches []string
|
||||
if matches, err = filepath.Glob(fmt.Sprintf(w.filenameRotationTemplate, "*", "*")); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// if there are more archives than the configured maximum, then purge older files
|
||||
if len(matches) > w.maxArchives {
|
||||
// sort files alphanumerically to delete older files first
|
||||
sort.Strings(matches)
|
||||
for _, filename := range matches[:len(matches)-w.maxArchives] {
|
||||
if err := os.Remove(filename); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
150
internal/rotate/file_writer_test.go
Normal file
150
internal/rotate/file_writer_test.go
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
package rotate
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestFileWriter_NoRotation(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
writer, err := NewFileWriter(filepath.Join(tempDir, "test"), 0, 0, 0)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { require.NoError(t, writer.Close()) })
|
||||
|
||||
_, err = writer.Write([]byte("Hello World"))
|
||||
require.NoError(t, err)
|
||||
_, err = writer.Write([]byte("Hello World 2"))
|
||||
require.NoError(t, err)
|
||||
files, err := os.ReadDir(tempDir)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, files, 1)
|
||||
}
|
||||
|
||||
func TestFileWriter_TimeRotation(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
interval, err := time.ParseDuration("10ms")
|
||||
require.NoError(t, err)
|
||||
writer, err := NewFileWriter(filepath.Join(tempDir, "test"), interval, 0, -1)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { require.NoError(t, writer.Close()) })
|
||||
|
||||
_, err = writer.Write([]byte("Hello World"))
|
||||
require.NoError(t, err)
|
||||
time.Sleep(interval)
|
||||
_, err = writer.Write([]byte("Hello World 2"))
|
||||
require.NoError(t, err)
|
||||
files, err := os.ReadDir(tempDir)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, files, 2)
|
||||
}
|
||||
|
||||
func TestFileWriter_ReopenTimeRotation(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
interval, err := time.ParseDuration("10ms")
|
||||
require.NoError(t, err)
|
||||
filePath := filepath.Join(tempDir, "test.log")
|
||||
err = os.WriteFile(filePath, []byte("Hello World"), 0640)
|
||||
time.Sleep(interval)
|
||||
require.NoError(t, err)
|
||||
writer, err := NewFileWriter(filepath.Join(tempDir, "test.log"), interval, 0, -1)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { require.NoError(t, writer.Close()) })
|
||||
|
||||
files, err := os.ReadDir(tempDir)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, files, 2)
|
||||
}
|
||||
|
||||
func TestFileWriter_SizeRotation(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
maxSize := int64(9)
|
||||
writer, err := NewFileWriter(filepath.Join(tempDir, "test.log"), 0, maxSize, -1)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { require.NoError(t, writer.Close()) })
|
||||
|
||||
_, err = writer.Write([]byte("Hello World"))
|
||||
require.NoError(t, err)
|
||||
_, err = writer.Write([]byte("World 2"))
|
||||
require.NoError(t, err)
|
||||
files, err := os.ReadDir(tempDir)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, files, 2)
|
||||
}
|
||||
|
||||
func TestFileWriter_ReopenSizeRotation(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
maxSize := int64(12)
|
||||
filePath := filepath.Join(tempDir, "test.log")
|
||||
err := os.WriteFile(filePath, []byte("Hello World"), 0640)
|
||||
require.NoError(t, err)
|
||||
writer, err := NewFileWriter(filepath.Join(tempDir, "test.log"), 0, maxSize, -1)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { require.NoError(t, writer.Close()) })
|
||||
|
||||
_, err = writer.Write([]byte("Hello World Again"))
|
||||
require.NoError(t, err)
|
||||
files, err := os.ReadDir(tempDir)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, files, 2)
|
||||
}
|
||||
|
||||
func TestFileWriter_DeleteArchives(t *testing.T) {
|
||||
if testing.Short() {
|
||||
t.Skip("Skipping long test in short mode")
|
||||
}
|
||||
|
||||
tempDir := t.TempDir()
|
||||
maxSize := int64(5)
|
||||
writer, err := NewFileWriter(filepath.Join(tempDir, "test.log"), 0, maxSize, 2)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() { require.NoError(t, writer.Close()) })
|
||||
|
||||
_, err = writer.Write([]byte("First file"))
|
||||
require.NoError(t, err)
|
||||
// File names include the date with second precision
|
||||
// So, to force rotation with different file names
|
||||
// we need to wait
|
||||
time.Sleep(1 * time.Second)
|
||||
_, err = writer.Write([]byte("Second file"))
|
||||
require.NoError(t, err)
|
||||
time.Sleep(1 * time.Second)
|
||||
_, err = writer.Write([]byte("Third file"))
|
||||
require.NoError(t, err)
|
||||
|
||||
files, err := os.ReadDir(tempDir)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, files, 3)
|
||||
|
||||
for _, tempFile := range files {
|
||||
var bytes []byte
|
||||
var err error
|
||||
path := filepath.Join(tempDir, tempFile.Name())
|
||||
if bytes, err = os.ReadFile(path); err != nil {
|
||||
t.Error(err.Error())
|
||||
return
|
||||
}
|
||||
contents := string(bytes)
|
||||
|
||||
if contents != "" && contents != "Second file" && contents != "Third file" {
|
||||
t.Error("Should have deleted the eldest log file")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestFileWriter_CloseDoesNotRotate(t *testing.T) {
|
||||
tempDir := t.TempDir()
|
||||
maxSize := int64(9)
|
||||
writer, err := NewFileWriter(filepath.Join(tempDir, "test.log"), 0, maxSize, -1)
|
||||
require.NoError(t, err)
|
||||
require.NoError(t, writer.Close())
|
||||
|
||||
files, err := os.ReadDir(tempDir)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, files, 1)
|
||||
require.Regexp(t, "^test.log$", files[0].Name())
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue