README
¶
logspout-logstash
A minimalistic adapter for github.com/gliderlabs/logspout to write to Logstash TCP. Supports
- multi-line log grouping
- udacity metadata
Log lines identified as JSON preserve the app-specific fields when shipped to Logstash.
Follow the instructions in https://github.com/gliderlabs/logspout/tree/master/custom on how to build your own Logspout container with custom modules. Basically just copy the contents of the custom folder and include:
import (
_ "github.com/udacity/logspout-logstash"
_ "github.com/gliderlabs/logspout/transports/udp"
)
in modules.go.
Use by setting ROUTE_URIS=logstash://host:port to the Logstash host and port for TCP.
In your logstash config, set the input codec to json e.g:
input {
tcp {
port => 5000
codec => json
}
}
Developing
### See Makefile
### All build artifacts have make-style dependencies defined
# install build dependencies
make deps
# test
make test
# view coverage report in your browser
make view-coverage
# submit a coveralls report
# must configure COVERALLS_TOKEN env var, should be run from CI only
make coveralls
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewLogstashAdapter ¶
func NewLogstashAdapter(route *router.Route) (router.LogAdapter, error)
NewLogstashAdapter creates a LogstashAdapter with TCP as the default transport.
Types ¶
type ComponentInfo ¶
type DockerInfo ¶
type JavaException ¶
type LogstashAdapter ¶
type LogstashAdapter struct {
// contains filtered or unexported fields
}
LogstashAdapter is an adapter that streams TCP JSON to Logstash.
func (*LogstashAdapter) Stream ¶
func (a *LogstashAdapter) Stream(logstream chan *router.Message)
Stream implements the router.LogAdapter interface.
type LogstashMessage ¶
type LogstashMessage struct {
Message string `json:"message"`
Stream string `json:"stream"`
Docker DockerInfo `json:"docker"`
Component ComponentInfo `json:"component"`
JavaLog *JavaLog `json:"javaLog,omitempty"`
}
LogstashMessage is a simple JSON input to Logstash.
Source Files
Directories