README
¶
This Project is replaced with https://github.com/mictsi/logspout-gelf-tls
Graylog GELF Module for logspout
This module allows logspout to send Docker logs in the GELF format to Graylog via UDP, TCP or TLS.
Unlike other logspout GELF modules, this module uses Logspout's built-in transports (UDP, TCP and TLS) so all of logspout's configuration for those transports applies. This is particularly important for TLS (see below for configuration examples).
Why
This module is based on Rick Alm's module, which is based on Micha Hausler's initial module for logspout. This module contains additional features including:
- TCP support (part of Rick Alm's module)
- Retry when TCP connection fails
- Swarm hostname support
- Null-terminated GELF messages
This module attempts to copy the logging format used by the Docker gelf log driver and Micha Hausler's logspout module.
Build
To build, you'll need to fork Logspout, add the following code to modules.go
_ "github.com/karlvr/logspout-gelf"
and run docker build -t $(whoami)/logspout:gelf .
Alternatively you can use my prebuilt Docker image karlvr/logspout-gelf.
Run
docker run \
-v /var/run/docker.sock:/var/run/docker.sock \
$(whoami)/logspout:gelf \
gelf://<graylog_host>:12201
Hostname
The contents of /etc/host_hostname is used to set the hostname reported to Graylog, if available. This follows
the behaviour of the syslog module.
e.g.
docker run \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /etc/hostname:/etc/host_hostname:ro \
$(whoami)/logspout:gelf \
gelf://<graylog_host>:12201
Otherwise the GELF_HOSTNAME environment variable is used, if available.
License
MIT. See License
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewGelfAdapter ¶
func NewGelfAdapter(route *router.Route) (router.LogAdapter, error)
NewGelfAdapter creates a GelfAdapter with UDP as the default transport.
Types ¶
type GelfAdapter ¶
type GelfAdapter struct {
// contains filtered or unexported fields
}
GelfAdapter is an adapter that streams UDP JSON to Graylog
func (*GelfAdapter) Stream ¶
func (a *GelfAdapter) Stream(logstream chan *router.Message)
Stream implements the router.LogAdapter interface.
type GelfMessage ¶
type GelfMessage struct {
Version string `json:"version"`
Host string `json:"host,omitempty"`
ShortMessage string `json:"short_message"`
FullMessage string `json:"full_message,omitempty"`
Timestamp float64 `json:"timestamp,omitempty"`
Level int32 `json:"level,omitempty"`
ImageId string `json:"_image_id,omitempty"`
ImageName string `json:"_image_name,omitempty"`
ContainerId string `json:"_container_id,omitempty"`
ContainerName string `json:"_container_name,omitempty"`
ContainerCmd string `json:"_command,omitempty"`
Created string `json:"_created,omitempty"`
}
Source Files