Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kvz/logstreamer
Prefixes streams (e.g. stdout or stderr) in Go
https://github.com/kvz/logstreamer
go logging streams
Last synced: 28 days ago
JSON representation
Prefixes streams (e.g. stdout or stderr) in Go
- Host: GitHub
- URL: https://github.com/kvz/logstreamer
- Owner: kvz
- License: mit
- Created: 2013-07-02T11:43:48.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-10-24T07:54:23.000Z (about 2 years ago)
- Last Synced: 2024-10-16T02:41:07.652Z (about 2 months ago)
- Topics: go, logging, streams
- Language: Go
- Size: 16.6 KB
- Stars: 46
- Watchers: 3
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-golang-repositories - logstreamer
README
logstreamer [![Build Status][BuildStatusIMGURL]][BuildStatusURL]
===============
[BuildStatusIMGURL]: https://secure.travis-ci.org/kvz/logstreamer.png?branch=master
[BuildStatusURL]: //travis-ci.org/kvz/logstreamer "Build Status"
Prefixes streams (e.g. stdout or stderr) in Go.
If you are executing a lot of (remote) commands, you may want to indent all of their
output, prefix the loglines with hostnames, or mark anything that was thrown to stderr
red, so you can spot errors more easily.
For this purpose, Logstreamer was written.
You pass 3 arguments to `NewLogstreamer()`:
- Your `*log.Logger`
- Your desired prefix (`"stdout"` and `"stderr"` prefixed have special meaning)
- If the lines should be recorded `true` or `false`. This is useful if you want to retrieve any errors.
This returns an interface that you can point `exec.Command`'s `cmd.Stderr` and `cmd.Stdout` to.
All bytes that are written to it are split by newline and then prefixed to your specification.
**Don't forget to call `Flush()` or `Close()` if the last line of the log
might not end with a newline character!**
A typical usage pattern looks like this:
```go
// Create a logger (your app probably already has one)
logger := log.New(os.Stdout, "--> ", log.Ldate|log.Ltime)
// Setup a streamer that we'll pipe cmd.Stdout to
logStreamerOut := NewLogstreamer(logger, "stdout", false)
defer logStreamerOut.Close()
// Setup a streamer that we'll pipe cmd.Stderr to.
// We want to record/buffer anything that's written to this (3rd argument true)
logStreamerErr := NewLogstreamer(logger, "stderr", true)
defer logStreamerErr.Close()
// Execute something that succeeds
cmd := exec.Command(
"ls",
"-al",
)
cmd.Stderr = logStreamerErr
cmd.Stdout = logStreamerOut
// Reset any error we recorded
logStreamerErr.FlushRecord()
// Execute command
err := cmd.Start()
```
## Test
```bash
$ cd src/pkg/logstreamer/
$ go test
```
Here I issue two local commands, `ls -al` and `ls nonexisting`:
Over at [Transloadit](http://transloadit.com) we use it for streaming remote commands.
Servers stream command output over SSH back to me, and every line is prefixed with a date, their hostname & marked red in case they
wrote to stderr.
## License
This project is licensed under the MIT license, see `LICENSE.txt`.