From 76a63815164a4c86678dfffb17b5a3ca566aa3df Mon Sep 17 00:00:00 2001 From: Blallo Date: Wed, 1 May 2019 15:55:41 +0200 Subject: [PATCH 1/2] Add flag to set syslog format. --- cmd/circologd/main.go | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/cmd/circologd/main.go b/cmd/circologd/main.go index f0a2de2..435f412 100644 --- a/cmd/circologd/main.go +++ b/cmd/circologd/main.go @@ -22,6 +22,20 @@ func cleanSocket(socket string) { } } +func setSyslogFormat(server *syslog.Server, format string) { + switch { + case format == "auto": + server.SetFormat(syslog.Automatic) + case format == "rfc3164": + server.SetFormat(syslog.RFC3164) + case format == "rfc5424": + server.SetFormat(syslog.RFC5424) + } + // TODO: propose a patch to mcuadros/go-syslog.v2 + // to get the format from the server itself. + log.Printf("Syslog format set to: %s\n", format) +} + func main() { var err error syslogSocketPath := flag.String("syslogd-socket", "", "The socket to listen to syslog addresses") @@ -31,6 +45,7 @@ func main() { queryAddr := flag.String("query-addr", "127.0.0.1:9080", "Address:port where to bind the query service") querySocket := flag.String("query-socket", "", "Path to a unix domain socket for the HTTP server; recommended for security reasons!") ctlSocket := flag.String("ctl-socket", "/tmp/circologd-ctl.sock", "Path to a unix domain socket for the control server; leave empty to disable") + logFmt := flag.String("log-fmt", "auto", "Log messages format. If not set, defaults to automatic choice. Allowed values: rfc3164, rfc5424.") verbose := flag.Bool("verbose", false, "Print more output executing the daemon") debug := flag.Bool("debug", false, "Print debugging info executing the daemon") flag.Parse() @@ -43,7 +58,7 @@ func main() { go hub.Run() server := syslog.NewServer() - server.SetFormat(syslog.Automatic) + setSyslogFormat(server, *logFmt) server.SetHandler(handler) if *syslogSocketPath != "" { if err = server.ListenUnixgram(*syslogSocketPath); err != nil { From 0e6b078ad6267f579c028793fed2e2104744bb68 Mon Sep 17 00:00:00 2001 From: Blallo Date: Thu, 2 May 2019 11:20:08 +0200 Subject: [PATCH 2/2] Refactor log-fmt as flag.Value. Move in formatter pkg. --- cmd/circologd/main.go | 21 ++++---------- formatter/rfc.go | 67 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 16 deletions(-) create mode 100644 formatter/rfc.go diff --git a/cmd/circologd/main.go b/cmd/circologd/main.go index 435f412..a2d76cb 100644 --- a/cmd/circologd/main.go +++ b/cmd/circologd/main.go @@ -12,6 +12,7 @@ import ( "time" "git.lattuga.net/boyska/circolog" + "git.lattuga.net/boyska/circolog/formatter" "github.com/coreos/go-systemd/daemon" syslog "gopkg.in/mcuadros/go-syslog.v2" ) @@ -22,22 +23,10 @@ func cleanSocket(socket string) { } } -func setSyslogFormat(server *syslog.Server, format string) { - switch { - case format == "auto": - server.SetFormat(syslog.Automatic) - case format == "rfc3164": - server.SetFormat(syslog.RFC3164) - case format == "rfc5424": - server.SetFormat(syslog.RFC5424) - } - // TODO: propose a patch to mcuadros/go-syslog.v2 - // to get the format from the server itself. - log.Printf("Syslog format set to: %s\n", format) -} - func main() { var err error + var logFmt formatter.SyslogRFC + logFmt = formatter.Auto syslogSocketPath := flag.String("syslogd-socket", "", "The socket to listen to syslog addresses") // dumpSocketPath := flag.String("dump-socket", "/run/buffer.sock", "The socket that user will connect to in order to receive logs") bufsize := flag.Int("buffer-size", 1000, "Number of messages to keep") @@ -45,7 +34,7 @@ func main() { queryAddr := flag.String("query-addr", "127.0.0.1:9080", "Address:port where to bind the query service") querySocket := flag.String("query-socket", "", "Path to a unix domain socket for the HTTP server; recommended for security reasons!") ctlSocket := flag.String("ctl-socket", "/tmp/circologd-ctl.sock", "Path to a unix domain socket for the control server; leave empty to disable") - logFmt := flag.String("log-fmt", "auto", "Log messages format. If not set, defaults to automatic choice. Allowed values: rfc3164, rfc5424.") + flag.Var(&logFmt, "log-fmt", "Log messages format. If not set, defaults to automatic choice. Allowed values: rfc3164, rfc5424, auto.") verbose := flag.Bool("verbose", false, "Print more output executing the daemon") debug := flag.Bool("debug", false, "Print debugging info executing the daemon") flag.Parse() @@ -58,7 +47,7 @@ func main() { go hub.Run() server := syslog.NewServer() - setSyslogFormat(server, *logFmt) + formatter.SetSyslogFormat(server, logFmt) server.SetHandler(handler) if *syslogSocketPath != "" { if err = server.ListenUnixgram(*syslogSocketPath); err != nil { diff --git a/formatter/rfc.go b/formatter/rfc.go new file mode 100644 index 0000000..40efebe --- /dev/null +++ b/formatter/rfc.go @@ -0,0 +1,67 @@ +package formatter + +import ( + "errors" + "log" + + syslog "gopkg.in/mcuadros/go-syslog.v2" +) + +type SyslogRFC string + +// SetSyslogFormat does the job of setting the server parser to the provided RFC log format. +func SetSyslogFormat(server *syslog.Server, format SyslogRFC) { + switch { + case format == Auto: + server.SetFormat(syslog.Automatic) + case format == RFC3164: + server.SetFormat(syslog.RFC3164) + case format == RFC5424: + server.SetFormat(syslog.RFC5424) + } + log.Printf("Syslog format set to: %s\n", format) +} + +func (rfc *SyslogRFC) Set(v string) error { + newval, err := parseRFCValue(v) + if err != nil { + return err + } + *rfc = newval + return nil +} + +func (rfc *SyslogRFC) String() string { + switch { + case *rfc == Auto: + return "auto" + case *rfc == RFC3164: + return "rfc3164" + case *rfc == RFC5424: + return "rfc5424" + } + return "" +} + +func parseRFCValue(v string) (SyslogRFC, error) { + switch { + case v == "rfc3164": + return RFC3164, nil + case v == "rfc5424": + return RFC5424, nil + case v == "auto": + return Auto, nil + default: + return "", ErrRFCNotSupported + } +} + +const ( + RFC3164 = "rfc3164" + RFC5424 = "rfc5424" + Auto = "auto" +) + +// ErrRFCNotSupported is raised if the supplied rfc string is +// not recognized. +var ErrRFCNotSupported = errors.New("RFC not known")