Ignore build/

This reverts commit 07f4246c80, reversing
changes made to 6da968177b.

.gitignore

@@ -0,0 +1,2 @@
+.*.vim
+/build

cmd/circolog-tail/main.go

@@ -54,8 +54,8 @@ func (b *BoolAuto) Set(s string) error {
 }
 
 func main() {
-	addr := flag.String("addr", "localhost:9080", "http service address")
-	querySocket := flag.String("socket", "", "Path to a unix domain socket for the HTTP server")
+	queryAddr := flag.String("addr", "", "http service address")
+	querySocket := flag.String("socket", "/tmp/circologd-query.sock", "Path to a unix domain socket for the HTTP server")
 	backlogLimit := flag.Int("n", -1, "Limit the backlog length, defaults to no limit (-1)")
 	var format formatter.Format
 	format = formatter.FormatSyslog
@@ -75,7 +75,7 @@ func main() {
 	signal.Notify(interrupt, os.Interrupt)
 	var d *websocket.Dialer
 	u := url.URL{Scheme: "ws",
-		Host: *addr, // ignored in case of -socket; see the Dialer below
+		Host: *queryAddr, // ignored in case of -socket; see the Dialer below
 		Path: "/ws",
 	}
 	q := u.Query()
@@ -84,7 +84,7 @@ func main() {
 		q.Set("l", strconv.Itoa(*backlogLimit))
 	}
 	u.RawQuery = q.Encode()
-	if *querySocket != "" {
+	if *queryAddr == "" {
 		d = &websocket.Dialer{
 			NetDial: func(network, addr string) (net.Conn, error) {
 				return net.Dial("unix", *querySocket)
@@ -95,7 +95,7 @@ func main() {
 		log.Printf("connecting to %s", *querySocket)
 	} else {
 		d = websocket.DefaultDialer
-		log.Printf("connecting to %s", *addr)
+		log.Printf("connecting to %s", *queryAddr)
 	}
 
 	c, _, err := d.Dial(u.String(), nil)
@@ -149,7 +149,7 @@ func main() {
 			select {
 			case <-done:
 				log.Println("Successfully close")
-			case <-time.After(1 * time.Second):
+			case <-time.After(5 * time.Second):
 				log.Println("Forced close")
 			}
 			return

cmd/circologd/activation.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"net"
+
+	"github.com/coreos/go-systemd/activation"
+)
+
+func Listeners() ([]net.Listener, error) {
+	files := activation.Files(false)
+	listeners := make([]net.Listener, len(files))
+
+	for i, f := range files {
+		if pc, err := net.FileListener(f); err == nil {
+			listeners[i] = pc
+			f.Close()
+		}
+	}
+	return listeners, nil
+}
+
+// PacketConns returns a slice containing a net.PacketConn for each matching socket type
+// passed to this process.
+//
+// The order of the file descriptors is preserved in the returned slice.
+// Nil values are used to fill any gaps. For example if systemd were to return file descriptors
+// corresponding with "udp, tcp, udp", then the slice would contain {net.PacketConn, nil, net.PacketConn}
+func PacketConns() ([]net.PacketConn, error) {
+	files := activation.Files(false)
+	conns := make([]net.PacketConn, len(files))
+
+	for i, f := range files {
+		if pc, err := net.FilePacketConn(f); err == nil {
+			conns[i] = pc
+			f.Close()
+		}
+	}
+	return conns, nil
+}

cmd/circologd/http_log.go

@@ -153,6 +153,15 @@ func getWSHandler(hub circolog.Hub) http.HandlerFunc {
 				hub.Unregister <- c
 				conn.Close()
 			}()
+			go func() {
+				for {
+					_, _, err := conn.ReadMessage()
+					if err != nil {
+						conn.Close()
+						return
+					}
+				}
+			}()
 			for {
 				select {
 				case message, ok := <-c.Messages:

cmd/circologd/main.go

@@ -12,25 +12,36 @@ 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"
 )
 
+var socketsToRemove []string
+
 func cleanSocket(socket string) {
 	if err := os.Remove(socket); err != nil {
 		fmt.Fprintln(os.Stderr, "Error cleaning", socket, ":", err)
 	}
 }
 
+func removeAtExit(socket string) {
+	socketsToRemove = append(socketsToRemove, socket)
+}
+
 func main() {
 	var err error
-	syslogSocketPath := flag.String("syslogd-socket", "", "The socket to listen to syslog addresses")
+	var syslogSocket SyslogSocket
+	var logFmt formatter.SyslogRFC
+	logFmt.Format = syslog.Automatic
+	flag.Var(&syslogSocket, "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")
 	syslogAddr := flag.String("syslog-addr", "127.0.0.1:9514", "Address:port where to listen for syslog messages")
-	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!")
+	queryAddr := flag.String("query-addr", "", "Address:port where to bind the query service")
+	querySocket := flag.String("query-socket", "/tmp/circologd-query.sock", "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")
+	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()
@@ -43,20 +54,33 @@ func main() {
 	go hub.Run()
 
 	server := syslog.NewServer()
-	server.SetFormat(syslog.Automatic)
+	server.SetFormat(logFmt.Format)
+	fmt.Printf("Syslog format set to: %s\n", logFmt.String())
 	server.SetHandler(handler)
-	if *syslogSocketPath != "" {
-		if err = server.ListenUnixgram(*syslogSocketPath); err != nil {
-			fmt.Fprintln(os.Stderr, "argh", err)
-			os.Exit(1)
+	if syslogSocket.isSocketActivated {
+		fmt.Printf("Binding to socket `%s` [syslog]\n", syslogSocket.String())
+		if syslogSocket.Listener != nil {
+			fmt.Println("(stream)")
+			server.Listen(syslogSocket.Listener)
+		} else {
+			fmt.Println("(datagram)", syslogSocket.Conn)
+			server.ListenDgram(syslogSocket.Conn)
 		}
-		defer cleanSocket(*syslogSocketPath)
-		fmt.Printf("Binding socket `%s` [syslog]\n", *syslogSocketPath)
 	} else {
-		fmt.Printf("Binding address `%s` [syslog]\n", *syslogAddr)
-		if err = server.ListenUDP(*syslogAddr); err != nil {
-			fmt.Fprintln(os.Stderr, "argh", err)
-			os.Exit(1)
+		syslogSocketPath := syslogSocket.Path
+		if syslogSocketPath != "" {
+			if err = server.ListenUnixgram(syslogSocketPath); err != nil {
+				fmt.Fprintln(os.Stderr, "argh", err)
+				os.Exit(1)
+			}
+			fmt.Printf("Binding socket `%s` [syslog]\n", syslogSocketPath)
+			removeAtExit(syslogSocketPath)
+		} else {
+			fmt.Printf("Binding address `%s` [syslog]\n", *syslogAddr)
+			if err = server.ListenUDP(*syslogAddr); err != nil {
+				fmt.Fprintln(os.Stderr, "argh", err)
+				os.Exit(1)
+			}
 		}
 	}
 	if err = server.Boot(); err != nil {
@@ -65,14 +89,14 @@ func main() {
 	}
 
 	httpQueryServer := http.Server{Handler: setupHTTP(hub)}
-	if *querySocket != "" {
+	if *queryAddr == "" {
 		fmt.Printf("Binding address `%s` [http]\n", *querySocket)
 		unixListener, err := net.Listen("unix", *querySocket)
 		if err != nil {
 			fmt.Fprintln(os.Stderr, "Error binding HTTP unix domain socket", err)
 			return
 		}
-		defer cleanSocket(*querySocket)
+		removeAtExit(*querySocket)
 		go func() {
 			if err := httpQueryServer.Serve(unixListener); err != nil && err != http.ErrServerClosed {
 				fmt.Fprintln(os.Stderr, "error binding", *querySocket, ":", err)
@@ -97,7 +121,7 @@ func main() {
 			fmt.Fprintln(os.Stderr, "Error binding HTTP unix domain socket", err)
 			return
 		}
-		defer cleanSocket(*ctlSocket)
+		removeAtExit(*ctlSocket)
 		go func() {
 			if err := httpCtlServer.Serve(unixListener); err != nil && err != http.ErrServerClosed {
 				fmt.Fprintln(os.Stderr, "error binding:", err)
@@ -147,6 +171,9 @@ func main() {
 				if err := httpCtlServer.Shutdown(nil); err != nil {
 					fmt.Fprintln(os.Stderr, "Error closing control server:", err)
 				}
+				for _, socket := range socketsToRemove {
+					cleanSocket(socket)
+				}
 				return
 			}
 		}

cmd/circologd/sockets.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"net"
+)
+
+// SyslogSocket is a struct eventually containing a net.Listener
+// ready with messages, and a Path in case the Listener is not present.
+type SyslogSocket struct {
+	Listener          net.Listener
+	Conn              net.PacketConn
+	Path              string
+	isSocketActivated bool
+}
+
+// Set from command-line
+func (s *SyslogSocket) Set(v string) error {
+	err := s.getActivationSocket()
+	if err == nil && (s.Conn != nil || s.Listener != nil) {
+		s.isSocketActivated = true
+	}
+	if !s.isSocketActivated {
+		s.Path = v
+	}
+	return nil
+}
+
+func (s *SyslogSocket) String() string {
+	if s.isSocketActivated {
+		return "systemd-provided"
+	}
+	return s.Path
+}
+
+func (s *SyslogSocket) getActivationSocket() error {
+	conns, err := PacketConns()
+	if err == nil && len(conns) > 0 && conns[0] != nil {
+		s.Conn = conns[0]
+		return nil
+	}
+	listeners, err := Listeners()
+	if err != nil {
+		return err
+	}
+	if len(listeners) == 0 {
+		return nil
+	}
+	s.Listener = listeners[0]
+	return nil
+}

docs/docs/systemd.md

@@ -69,4 +69,26 @@ Here is a working unit for this:
 ### journald with socket activation
 
 To run circologd as non-root, while listening on a root-owned socket (`/run/systemd/journal/syslog`) use
-socket activation
+socket activation. Create a unit in `/etc/systemd/system/circolog.service`:
+
+    [Unit]
+    Description=In-memory logging
+
+    [Service]
+    User=nobody
+    Group=nogroup
+    ExecStart=/usr/local/sbin/circologd -syslogd-socket "" -buffer-size 2000 -query-socket /run/circolog/query.sock
+
+    [Install]
+    WantedBy=multi-user.target
+
+Then symlink the `syslog.service` unit to the newly created one:
+
+    ln -sf /etc/systemd/system/circolog.service /etc/systemd/system/syslog.service
+
+and restart the service:
+
+    systemctl daemon-reload
+    systemctl restart syslog.service
+
+Now circolog is activated and receives messages from `journald`.

docs/mkdocs.yml

@@ -4,5 +4,6 @@ nav:
     - Install: install.md
     - Queries: query.md
     - Hacking: hacking.md
+    - Systemd: systemd.md
 repo_url: https://git.lattuga.net/boyska/circolog
 repo_name: 'Repository'

formatter/rfc.go

@@ -0,0 +1,49 @@
+package formatter
+
+import (
+	"errors"
+
+	syslog "gopkg.in/mcuadros/go-syslog.v2"
+	"gopkg.in/mcuadros/go-syslog.v2/format"
+)
+
+// SyslogRFC is the formatter that the server should use
+type SyslogRFC struct{ format.Format }
+
+func (rfc *SyslogRFC) Set(v string) error {
+	newval, err := parseRFCValue(v)
+	if err != nil {
+		return err
+	}
+	rfc.Format = newval
+	return nil
+}
+
+func (rfc *SyslogRFC) String() string {
+	switch {
+	case rfc.Format == syslog.Automatic:
+		return "auto"
+	case rfc.Format == syslog.RFC3164:
+		return "rfc3164"
+	case rfc.Format == syslog.RFC5424:
+		return "rfc5424"
+	}
+	return ""
+}
+
+func parseRFCValue(v string) (format.Format, error) {
+	switch {
+	case v == "rfc3164":
+		return syslog.RFC3164, nil
+	case v == "rfc5424":
+		return syslog.RFC5424, nil
+	case v == "auto":
+		return syslog.Automatic, nil
+	default:
+		return nil, ErrRFCNotSupported
+	}
+}
+
+// ErrRFCNotSupported is raised if the supplied rfc string is
+// not recognized.
+var ErrRFCNotSupported = errors.New("RFC not known")

release.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -u
+
+for goosarch in $(go tool dist list | grep -vw -e aix -e js/wasm -e plan9 -e solaris -e android -e nacl)
+do
+    mkdir -p "build/$goosarch"
+    goos=$(cut -d/ -f 1 <<<$goosarch)
+    goarch=$(cut -d/ -f 2 <<<$goosarch)
+    for cmd in cmd/*; do
+        GOOS=${goos} GOARCH=${goarch} go build -o "build/$goos/$goarch/$(basename $cmd)" ./$cmd
+    done
+done
+
+find build/ -type f|cut -d/ -f 1-3|uniq|while read -r dir; do
+    find $dir/ -type f -executable | xargs sha1sum > $dir/SHA1SUMS.txt
+    # TODO: touch to last commit date maybe
+    find build -exec touch -d @1234567890 {} \;
+    zip -q -X -j -r "circolog-$(git describe --tags --always)-$(cut -d/ -f 2-3 <<<"$dir"|tr / -)" "$dir"
+done

vendor/gopkg.in/mcuadros/go-syslog.v2

@@ -1 +1 @@
-Subproject commit a127d826d6c27489d377b3c080bd256d8f8093a6
+Subproject commit 166aad3f993ce4a67bf486e62d637c834c8a8fe6