Skip to content

Commit 721835b

Browse files
authored
Update README.md
1 parent 8e7a167 commit 721835b

File tree

1 file changed

+34
-49
lines changed

1 file changed

+34
-49
lines changed

README.md

Lines changed: 34 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -50,73 +50,58 @@ systemd-netlogd reads configuration files named `/etc/systemd/netlogd.conf` and
5050

5151
**[NETWORK]** SECTION OPTIONS
5252

53+
The "[Network]" section only applies for UDP multicast address and Port:
5354

54-
The "[Network]" section only applies for UDP multicast address and Port:
55+
Address=
56+
Controls whether log messages received by the systemd daemon shall be forwarded to a unicast UDP address or multicast UDP network group in syslog RFC 5424 format. The the address string format is similar to socket units. See systemd.socket(1)
5557

56-
Address=
57-
Controls whether log messages received by the systemd daemon shall be forwarded
58-
to a unicast UDP address or multicast UDP network group in syslog RFC 5424 format.
58+
Protocol=
59+
Specifies whether to use udp, tcp, tls or dtls (Datagram Transport Layer Security) protocol. Defaults to udp.
5960

60-
The the address string format is similar to socket units. See systemd.socket(1)
61+
LogFormat=
62+
Specifies whether to use RFC 5424 format or RFC 3339 format. Takes one of rfc5424 or rfc3339. Defaults to rfc5424.
6163

62-
Protocol=
63-
Specifies whether to use udp, tcp, tls or dtls (Datagram Transport Layer Security) protocol. Defaults to udp.
64+
Directory=
65+
Takes a directory path. Specifies whether to operate on the specified journal directory DIR instead of the default runtime and system journal paths.
66+
67+
Namespace=
68+
Takes a journal namespace identifier string as argument. If not specified the data collected by the default namespace is shown. If specified shows the log data of the specified namespace instead. If the namespace is specified as "*" data from all namespaces is shown, interleaved. If the namespace identifier is prefixed with "+" data from the specified namespace and the default namespace is shown, interleaved, but no other
6469

65-
LogFormat=
66-
Specifies whether to use RFC 5424 format or RFC 3339 format. Takes one of rfc5424 or rfc3339. Defaults to rfc5424.
70+
ConnectionRetrySec=
71+
Specifies the minimum delay before subsequent attempts to contact a Log server are made. Takes a time span value. The default unit is seconds, but other units may be specified, see systemd.time(5). Defaults to 30 seconds and must not be smaller than 1 second.
6772

68-
Directory=
69-
Takes a directory path. Specifies whether to operate on the specified journal directory DIR instead of the default runtime and system journal paths.
73+
TLSCertificateAuthMode=
74+
Specifies whether to validate the certificate. Takes one of no, allow, deny, warn. Defaults to 'no' which disables certificate validation.
7075

71-
Namespace=
72-
Takes a journal namespace identifier string as argument. If not specified the data collected by the default namespace is shown. If specified
73-
shows the log data of the specified namespace instead. If the namespace is specified as "*" data from all namespaces is shown, interleaved.
74-
If the namespace identifier is prefixed with "+" data from the specified namespace and the default namespace is shown, interleaved, but no other
76+
KeepAlive=
77+
Takes a boolean argument. If true, the TCP/IP stack will send a keep alive message after 2h (depending on the configuration of /proc/sys/net/ipv4/tcp_keepalive_time) for all TCP streams accepted on this socket. This controls the SO_KEEPALIVE socket option (see socket(7) and the TCP Keepalive HOWTO for details.) Defaults to false.
7578

76-
ConnectionRetrySec=
77-
Specifies the minimum delay before subsequent attempts to contact a Log server are made.
78-
Takes a time span value. The default unit is seconds, but other units may be specified,
79-
see systemd.time(5). Defaults to 30 seconds and must not be smaller than 1 second.
79+
KeepAliveTimeSec=
80+
Takes time (in seconds) as argument. The connection needs to remain idle before TCP starts sending keepalive probes. This controls the TCP_KEEPIDLE socket option (see socket(7) and the TCP Keepalive HOWTO for details.) Default value is 7200 seconds (2 hours).
8081

81-
TLSCertificateAuthMode=
82-
Specifies whether to validate the certificate. Takes one of no, allow, deny, warn. Defaults to 'no' which disables certificate validation.
82+
KeepAliveIntervalSec=
83+
Takes time (in seconds) as argument between individual keepalive probes, if the socket option SO_KEEPALIVE has been set on this socket. This controls the TCP_KEEPINTVL socket option (see socket(7) and the TCP Keepalive HOWTO for details.) Default value is 75 seconds.
8384

84-
KeepAlive=
85-
Takes a boolean argument. If true, the TCP/IP stack will send a keep alive message after 2h (depending on the configuration of /proc/sys/net/ipv4/tcp_keepalive_time)
86-
for all TCP streams accepted on this socket. This controls the SO_KEEPALIVE socket option (see socket(7) and the TCP Keepalive HOWTO for details.) Defaults to false.
85+
KeepAliveProbes=
86+
Takes an integer as argument. It is the number of unacknowledged probes to send before considering the connection dead and notifying the application layer. This controls the TCP_KEEPCNT socket option (see socket(7) and the TCP Keepalive HOWTO for details.) Default value is 9.
8787

88-
KeepAliveTimeSec=
89-
Takes time (in seconds) as argument. The connection needs to remain idle before TCP starts sending keepalive probes. This controls the TCP_KEEPIDLE socket option (see socket(7)
90-
and the TCP Keepalive HOWTO for details.) Default value is 7200 seconds (2 hours).
88+
SendBuffer=
89+
Takes an integer argument controlling the receive or send buffer sizes of this socket, respectively. This controls the SO_SNDBUF socket options (see socket(7) for details.). The usual suffixes K, M, G are supported and are understood to the base of 1024.
9190

92-
KeepAliveIntervalSec=
93-
Takes time (in seconds) as argument between individual keepalive probes, if the socket option SO_KEEPALIVE has been set on this socket. This controls the TCP_KEEPINTVL
94-
socket option (see socket(7) and the TCP Keepalive HOWTO for details.) Default value is 75 seconds.
95-
96-
KeepAliveProbes=
97-
Takes an integer as argument. It is the number of unacknowledged probes to send before considering the connection dead and notifying the application layer. This controls the
98-
TCP_KEEPCNT socket option (see socket(7) and the TCP Keepalive HOWTO for details.) Default value is 9.
99-
100-
SendBuffer=
101-
Takes an integer argument controlling the receive or send buffer sizes of this socket, respectively. This controls the SO_SNDBUF socket options (see socket(7) for details.). The usual suffixes K, M, G are supported and are understood to the base of 1024.
102-
103-
NoDelay=
104-
Takes a boolean argument. TCP Nagle's algorithm works by combining a number of small outgoing messages, and sending them all at once.
105-
This controls the TCP_NODELAY socket option (see tcp(7)). Defaults to false.
91+
NoDelay=
92+
Takes a boolean argument. TCP Nagle's algorithm works by combining a number of small outgoing messages, and sending them all at once. This controls the TCP_NODELAY socket option (see tcp(7)). Defaults to false.
10693

10794
Optional settings
10895

109-
StructuredData=
110-
Meta information about the syslog message, which can be used for Cloud Based
111-
syslog servers, such as Loggly
96+
StructuredData=
97+
Meta information about the syslog message, which can be used for Cloud Based syslog servers, such as Loggly
11298

113-
UseSysLogStructuredData=
114-
A boolean. Specifies whether to extract SYSLOG_STRUCTURED_DATA= from journal. Defaults to false.
99+
UseSysLogStructuredData=
100+
A boolean. Specifies whether to extract SYSLOG_STRUCTURED_DATA= from journal. Defaults to false.
115101

116-
UseSysLogMsgId=
102+
UseSysLogMsgId=
117103
A boolean. Specifies whether to extract SYSLOG_MSGID= from journal. Defaults to false.
118104

119-
120105
**EXAMPLE**
121106

122107
Example 1.UDP Multicast
@@ -184,7 +169,7 @@ Example 6. DTLS with certificate authentocation mode
184169

185170
Use case of ```UseSysLogStructuredData=``` and ```UseSysLogMsgId=```
186171

187-
```
172+
```C
188173
sd_journal_send(
189174
"MESSAGE=%s", "Message to process",
190175
"PRIORITY=%s", "4",

0 commit comments

Comments
 (0)