Merge pull request #326 from gliderlabs/master

release v3.2.3

Author: michaelshobbs

CHANGELOG.md

@@ -10,6 +10,14 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
+## [v3.2.3] - 2017-09-23
+### Added
+- @guigouz guigouz Add `RAW_FORMAT` to the documentation
+- @stevecalvert Allow docker log tail to be specified, default to 'all
+
+### Fixed
+- @jeanlouisboudart RawTerminal should be set to true if we want to collect tty logs
+- @michaelshobbs fix new golint lintballs
 
 ## [v3.2.2] - 2017-05-25
 ### Fixed
@@ -154,7 +162,9 @@ All notable changes to this project will be documented in this file.
 - Base container is now Alpine
 - Moved to gliderlabs organization
 
-[unreleased]: https://github.com/gliderlabs/logspout/compare/v3.2.1...HEAD
+[unreleased]: https://github.com/gliderlabs/logspout/compare/v3.2.3...HEAD
+[v3.2.3]: https://github.com/gliderlabs/logspout/compare/v3.2.3...v3.2.3
+[v3.2.2]: https://github.com/gliderlabs/logspout/compare/v3.2.1...v3.2.2
 [v3.2.1]: https://github.com/gliderlabs/logspout/compare/v3.2...v3.2.1
 [v3.2]: https://github.com/gliderlabs/logspout/compare/v3.1...v3.2
 [v3.1]: https://github.com/gliderlabs/logspout/compare/v3...v3.1

README.md

@@ -88,7 +88,7 @@ You can route to multiple destinations by comma-separating the URIs:
 		raw://192.168.10.10:5000?filter.name=*_db,syslog+tls://logs.papertrailapp.com:55555?filter.name=*_app
 
 #### Suppressing backlog tail
-You can tell logspout to only display log entries since container "start" or "restart" event by setting a `BACKLOG=false` environment variable (equivalent to `docker logs --tail=0`):
+You can tell logspout to only display log entries since container "start" or "restart" event by setting a `BACKLOG=false` environment variable (equivalent to `docker logs --since=0s`):
 
 	$ docker run -d --name="logspout" \
 		-e 'BACKLOG=false' \
@@ -99,6 +99,10 @@ The default behaviour is to output all logs since creation of the container (equ
 
 > NOTE: Use of this option **may** cause the first few lines of log output to be missed following a container being started, if the container starts outputting logs before logspout has a chance to see them. If consistent capture of *every* line of logs is critical to your application, you might want to test thorougly and/or avoid this option (at the expense of getting the entire backlog for every restarting container). This does not affect containers that are removed and recreated.
 
+
+#### Environment variable, TAIL
+Whilst BACKLOG=false restricts the tail by setting the Docker Logs.Options.Since to time.Now(), another mechanism to restrict the tail is to set TAIL=n.  Use of this mechanism avoids parsing the earlier content of the logfile which may have a speed advantage if the tail content is of no interest or has become corrupted.
+
 #### Inspect log streams using curl
 
 Using the [httpstream module](http://github.com/gliderlabs/logspout/blob/master/httpstream), you can connect with curl to see your local aggregated logs in realtime. You can do this without setting up a route URI.
@@ -135,10 +139,12 @@ Logspout relies on the Docker API to retrieve container logs. A failure in the A
 
 * `ALLOW_TTY` - include logs from containers started with `-t` or `--tty` (i.e. `Allocate a pseudo-TTY`)
 * `BACKLOG` - suppress container tail backlog
+* `TAIL` - specify the number of lines in the log tail to capture when logspout starts (default `all`)
 * `DEBUG` - emit debug logs
 * `EXCLUDE_LABEL` - exclude logs with a given label
 * `INACTIVITY_TIMEOUT` - detect hang in Docker API (default 0)
 * `PORT` or `HTTP_PORT` - configure which port to listen on (default 80)
+* `RAW_FORMAT` - log format for the raw adapter (default `{{.Data}}\n`)
 * `RETRY_COUNT` - how many times to retry a broken socket (default 10)
 * `ROUTESPATH` - path to routes (default `/mnt/routes`)
 * `SYSLOG_DATA` - datum for data field (default `{{.Data}}`)

VERSION

@@ -1 +1 @@
-v3.2.2
+v3.3-dev

router/persist.go

@@ -74,8 +74,5 @@ func marshal(obj interface{}) []byte {
 
 func unmarshal(input io.Reader, obj interface{}) error {
 	dec := json.NewDecoder(input)
-	if err := dec.Decode(obj); err != nil {
-		return err
-	}
-	return nil
+	return dec.Decode(obj)
 }

router/pump.go

@@ -195,6 +195,7 @@ func (p *LogsPump) pumpLogs(event *docker.APIEvents, backlog bool, inactivityTim
 		return
 	}
 
+	var tail = getopt("TAIL", "all")
 	var sinceTime time.Time
 	if backlog {
 		sinceTime = time.Unix(0, 0)
@@ -215,17 +216,18 @@ func (p *LogsPump) pumpLogs(event *docker.APIEvents, backlog bool, inactivityTim
 	p.update(event)
 	go func() {
 		for {
-			debug("pump.pumpLogs():", id, "started")
+			debug("pump.pumpLogs():", id, "started, tail:", tail)
 			err := p.client.Logs(docker.LogsOptions{
 				Container:         id,
 				OutputStream:      outwr,
 				ErrorStream:       errwr,
 				Stdout:            true,
 				Stderr:            true,
 				Follow:            true,
-				Tail:              "all",
+				Tail:              tail,
 				Since:             sinceTime.Unix(),
 				InactivityTimeout: inactivityTimeout,
+				RawTerminal:       allowTTY,
 			})
 			if err != nil {
 				debug("pump.pumpLogs():", id, "stopped with error:", err)

routesapi/routesapi.go

@@ -72,8 +72,5 @@ func marshal(obj interface{}) []byte {
 
 func unmarshal(input io.Reader, obj interface{}) error {
 	dec := json.NewDecoder(input)
-	if err := dec.Decode(obj); err != nil {
-		return err
-	}
-	return nil
+	return dec.Decode(obj)
 }