https://github.com/un000/tailor
Tailor, the library for tailing logs under logrotate, written in go.
https://github.com/un000/tailor
go golang log nginx tail
Last synced: 5 months ago
JSON representation
Tailor, the library for tailing logs under logrotate, written in go.
- Host: GitHub
- URL: https://github.com/un000/tailor
- Owner: un000
- License: mit
- Created: 2019-06-01T21:16:55.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-04T16:25:56.000Z (about 7 years ago)
- Last Synced: 2025-10-13T02:41:59.210Z (8 months ago)
- Topics: go, golang, log, nginx, tail
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 37
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Tailor, the library for tailing logs under logrotate
-----
[](https://godoc.org/github.com/un000/tailor)
[](https://sourcegraph.com/github.com/un000/tailor?badge)
[](https://goreportcard.com/report/github.com/un000/tailor)
Tailor provides the functionality of tailing for e. g. nginx logs under logrotate.
Tailor will follow a selected log file and reopen it if it's been rotated. Now, tailor doesn't require inotify, because it polls logs
with a tiny delay. So the library can achieve cross-platform.
There is no plan to implement truncate detection.
Currently this library is used in production, handling 5k of opened files with a load over 100k rps per instance,
without such overhead.
## Install
```Bash
go get github.com/un000/tailor
```
## Features
- Tail files from any offsets
- Reopening on logrotate
- Rate limiter + support custom rate limiters
- Leaky bucket
- Performant helpers to trim or convert bytes to string
- Lag monitoring
## Example
```Go
package main
import (
"context"
"fmt"
"io"
"time"
"github.com/un000/tailor"
)
func main() {
t := tailor.New(
"./github.com_access.log",
tailor.WithSeekOnStartup(0, io.SeekStart),
tailor.WithPollerTimeout(10*time.Millisecond),
)
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
err := t.Run(ctx)
if err != nil {
panic(err)
}
fmt.Println("Tailing file:", t.FileName())
for {
select {
case line, ok := <-t.Lines():
if !ok {
return
}
fmt.Println(line.StringTrimmed())
case err, ok := <-t.Errors():
if !ok {
return
}
panic(err)
}
}
}
```
## Contributions are appreciated, feel free ✌️