File: journal.go

package info (click to toggle)
snapd 2.71-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 79,536 kB
  • sloc: ansic: 16,114; sh: 16,105; python: 9,941; makefile: 1,890; exp: 190; awk: 40; xml: 22
file content (98 lines) | stat: -rw-r--r-- 3,349 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
// -*- Mode: Go; indent-tabs-mode: t -*-

/*
 * Copyright (C) 2018 Canonical Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package systemd

import (
	"fmt"
	"log/syslog"
	"net"
	"os"

	"github.com/snapcore/snapd/dirs"
	"github.com/snapcore/snapd/gadget/quantity"
)

// JournalStreamFileParams contains configuration parameters for the journal stream.
// Most of these are optional, but a stream must have a proper Identifier specified to
// be opened. If a namespace is provided, then the stream will connect to that specific
// journal namespace instead.
type JournalStreamFileParams struct {
	Namespace   string
	Identifier  string
	UnitName    string
	Priority    syslog.Priority
	LevelPrefix bool
}

// NewJournalStreamFile creates log stream file descriptor to the journal. The
// semantics is identical to that of sd_journal_stream_fd(3) call.
func NewJournalStreamFile(params JournalStreamFileParams) (*os.File, error) {
	// an identifier must be provided
	if params.Identifier == "" {
		return nil, fmt.Errorf("internal error: cannot setup a journal stream without an identifier")
	}

	var journalPath string
	if params.Namespace != "" {
		journalPath = fmt.Sprintf("%s/journal.%s/stdout", dirs.SnapSystemdRunDir, params.Namespace)
	} else {
		journalPath = fmt.Sprintf("%s/journal/stdout", dirs.SnapSystemdRunDir)
	}

	conn, err := net.DialUnix("unix", nil, &net.UnixAddr{Name: journalPath})
	if err != nil {
		return nil, err
	}
	// does not affect *os.File created through conn.File() later on
	defer conn.Close()

	// systemd closes the read side
	// https://github.com/systemd/systemd/blob/2e8a581b9cc1132743c2341fc334461096266ad4/src/core/exec-invoke.c#L228
	if err := conn.CloseRead(); err != nil {
		return nil, err
	}

	// journald actually tries to force this into 8mb in spite of kernel
	// limits, however let us not do that.
	// https://github.com/systemd/systemd/blob/2e8a581b9cc1132743c2341fc334461096266ad4/src/core/exec-invoke.c#L231
	// intentionally ignore the error like systemd does.
	_ = conn.SetWriteBuffer(int(8 * quantity.SizeMiB))

	var levelPrefix int
	if params.LevelPrefix {
		levelPrefix = 1
	}

	// setup contents taken from the original systemd code:
	// https://github.com/systemd/systemd/blob/2e8a581b9cc1132743c2341fc334461096266ad4/src/core/exec-invoke.c#L233
	setupStr := fmt.Sprintf("%s\n%s\n%d\n%d\n%d\n%d\n%d\n",
		params.Identifier, /* syslog_identifier */
		params.UnitName,   /* unit-name */
		params.Priority,   /* syslog_priority */
		levelPrefix,       /* syslog_level_prefix */
		0,                 /* false */
		0,                 /* is_kmsg_output */
		0,                 /* is_terminal_output */
	)
	if _, err := conn.Write([]byte(setupStr)); err != nil {
		return nil, fmt.Errorf("failed to write header: %v", err)
	}
	return conn.File()
}