README
¶
NOTE: This is a fork of https://github.com/grafana/tail, which is a fork of https://github.com/hpcloud/tail.
The grafana/tail repo is no longer mainained because the Loki team has deprecated the Promtail project.
It is easier for the Alloy team to maintain this tail package inside the Alloy repo than to have a separate repository for it.
Use outside of that context is not tested or supported.
Go package for tail-ing files
A Go package striving to emulate the features of the BSD tail program.
t, err := tail.TailFile("/var/log/nginx.log", tail.Config{Follow: true})
for line := range t.Lines {
fmt.Println(line.Text)
}
See API documentation.
Log rotation
Tail comes with full support for truncation/move detection as it is designed to work with log rotation tools.
Installing
go get github.com/hpcloud/tail/...
Windows support
This package needs assistance for full Windows support.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrStop = errors.New("tail should now stop")
)
Functions ¶
Types ¶
type Config ¶
type Config struct {
Logger log.Logger
// Seek to this location before tailing
Location *SeekInfo
PollOptions watch.PollingFileWatcherOptions
// Change the decoder if the file is not UTF-8.
// If the tailer doesn't use the right decoding, the output text may be gibberish.
// For example, if the file is "UTF-16 LE" encoded, the tailer would not separate
// the new lines properly and the output could come out as chinese characters.
Decoder *encoding.Decoder
}
Config is used to specify how a file must be tailed.
type Tail ¶
type Tail struct {
Filename string
Lines chan *Line
Config
tomb.Tomb // provides: Done, Kill, Dying
// contains filtered or unexported fields
}
func TailFile ¶
TailFile begins tailing the file. Output stream is made available via the `Tail.Lines` channel. To handle errors during tailing, invoke the `Wait` or `Err` method after finishing reading from the `Lines` channel.
Source Files
Directories