Skip to content

Commit ea5c7d8

Browse files
authored
More RFC text fixes #62 (#63)
Fixes: #62 Reformatted some missing RFC ids to RFC-XXXX format Expanded RFC-XXXX-ZZ format to RFC-XXXX, RFC-XXZZ Eliminated some additional hyphens for the sake of better indexing ("RFC-XXXX-formatted") Added missing RFC links to external_links.yml
2 parents 77adcd2 + 153e23d commit ea5c7d8

File tree

40 files changed

+95
-75
lines changed

40 files changed

+95
-75
lines changed

_data/external_links.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,16 +430,36 @@ welf:
430430

431431
### RFC links ###
432432

433+
rfc-822:
434+
id: rfc-822
435+
url: https://www.ietf.org/rfc/rfc822.txt
436+
title: [ "RFC-822" ]
437+
438+
rfc-3162:
439+
id: rfc-3162
440+
url: https://www.ietf.org/rfc/rfc3162.txt
441+
title: [ "RFC-3162" ]
442+
433443
rfc-3164:
434444
id: rfc-3164
435445
url: https://www.ietf.org/rfc/rfc3164.txt
436446
title: [ "RFC-3164" ]
437447

448+
rfc-3339:
449+
id: rfc-3339
450+
url: https://www.ietf.org/rfc/rfc3339.txt
451+
title: [ "RFC-3339" ]
452+
438453
rfc-3526:
439454
id: rfc-3526
440455
url: https://www.ietf.org/rfc/rfc3526.txt
441456
title: [ "RFC-3526" ]
442457

458+
rfc-4122:
459+
id: rfc-4122
460+
url: https://www.ietf.org/rfc/rfc4122.txt
461+
title: [ "RFC-4122" ]
462+
443463
rfc-4180:
444464
id: rfc-4180
445465
url: https://tools.ietf.org/html/rfc4180

_includes/doc/admin-guide/options/destination-flags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
- *syslog-protocol*: The syslog-protocol flag instructs the driver to
1212
format the messages according to the new IETF syslog protocol
13-
standard (RFC5424), but without the frame header. If this flag is
13+
standard (RFC-5424), but without the frame header. If this flag is
1414
enabled, macros used for the message have effect only for the text
1515
of the message, the message header is formatted to the new standard.
1616
Note that this flag is not needed for the syslog driver, and that

_includes/doc/admin-guide/options/log-msg-size.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
length includes the entire message (the data structure and individual
88
fields). The maximal value that can be set is 268435456 bytes (256 MiB).
99

10-
For messages using the IETF-syslog message format (RFC5424), the maximal
10+
For messages using the IETF-syslog message format (RFC-5424), the maximal
1111
size of the value of an SDATA field is 64 KiB.
1212

1313
**NOTE:** In most cases, log-msg-size() does not need to be set higher than

_includes/doc/admin-guide/options/source-flags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
110110
- *syslog-protocol*: The syslog-protocol flag specifies that incoming
111111
messages are expected to be formatted according to the new IETF
112-
syslog protocol standard (RFC5424), but without the frame header.
112+
syslog protocol standard (RFC-5424), but without the frame header.
113113
Note that this flag is not needed for the syslog driver, which
114114
handles only messages that have a frame header.
115115

_includes/doc/admin-guide/options/value-pairs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,17 +196,17 @@ The rekey() option can be used with the format-json template-function as well, u
196196

197197
- *all-nv-pairs*: Include every soft macro (name-value pair). Equivalent to using both nv-pairs and dot-nv-pairs.
198198

199-
- *rfc3164*: The macros that correspond to the RFC3164 (legacy or BSD-syslog) message format: ${FACILITY}, ${PRIORITY}, ${HOST}, ${PROGRAM}, ${PID},${MESSAGE}, and ${DATE}.
199+
- *rfc3164*: The macros that correspond to the RFC-3164 (legacy or BSD-syslog) message format: ${FACILITY}, ${PRIORITY}, ${HOST}, ${PROGRAM}, ${PID},${MESSAGE}, and ${DATE}.
200200

201-
- *rfc5424*: The macros that correspond to the RFC5424 (IETF-syslog) message format: ${FACILITY}, ${PRIORITY}, ${HOST}, ${PROGRAM}, ${PID}, ${MESSAGE}, ${MSGID}, ${R_DATE}, and the metadata from the structured-data (SDATA) part of RFC5424-formatted messages, that is, every macro that starts with .SDATA..
201+
- *rfc5424*: The macros that correspond to the RFC-5424 (IETF-syslog) message format: ${FACILITY}, ${PRIORITY}, ${HOST}, ${PROGRAM}, ${PID}, ${MESSAGE}, ${MSGID}, ${R_DATE}, and the metadata from the structured-data (SDATA) part of RFC-5424 formatted messages, that is, every macro that starts with .SDATA..
202202

203203
The rfc5424 group also has the following alias: syslog-proto. Note that the value of ${R_DATE} will be listed under the DATE key. The rfc5424 group does not contain any metadata about the message, only information that was present in the original message. To include the most commonly used metadata (for example, the ${SOURCEIP} macro), use the selected-macros group instead.
204204

205205
- *all-macros*: Include every hard macro. This group is mainly useful for debugging, as it contains redundant information (for example, the date-related macros include the date-related information several times in various formats).
206206

207207
- *selected-macros*: Include the macros of the rfc3164 groups, and the most commonly used metadata about the log message: the ${TAGS}, ${SOURCEIP}, and ${SEQNUM} macros.
208208

209-
- *sdata*: The metadata from the structured-data (SDATA) part of RFC5424-formatted messages, that is, every macro that starts with .SDATA.
209+
- *sdata*: The metadata from the structured-data (SDATA) part of RFC-5424 formatted messages, that is, every macro that starts with .SDATA.
210210

211211
- *everything*: Include every hard and soft macros. This group is mainly useful for debugging, as it contains redundant information (for example, the date-related macros include the date-related information several times in various formats).
212212

doc/_admin-guide/010_Introduction_to_syslog-ng/000_What_syslog-ng_is.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ monitoring system.
9292

9393
## syslog protocol standards
9494

95-
syslog-ng not only supports legacy BSD syslog (RFC3164) and the enhanced
96-
RFC5424 protocols but also JavaScript Object Notation (JSON) and
95+
syslog-ng not only supports legacy BSD syslog (RFC-3164) and the enhanced
96+
RFC-5424 protocols but also JavaScript Object Notation (JSON) and
9797
journald message formats.
9898

9999
## Heterogeneous environments

doc/_admin-guide/020_The_concepts_of_syslog-ng/004_Timezones_and_daylight_saving.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >-
88
---
99

1010
The syslog-ng application supports messages originating from different
11-
timezones. The original syslog protocol (RFC3164) does not include
11+
timezones. The original syslog protocol (RFC-3164) does not include
1212
timezone information, but syslog-ng provides a solution by extending the
1313
syslog protocol to include the timezone in the log messages. The
1414
syslog-ng application also enables administrators to supply timezone
@@ -63,7 +63,7 @@ to the message using the following algorithm.
6363

6464
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** If syslog-ng
6565
OSE sends the message is to the destination using the legacy-syslog protocol
66-
(RFC3164) which does not support timezone information in its timestamps,
66+
(RFC-3164) which does not support timezone information in its timestamps,
6767
the timezone information cannot be encapsulated into the sent timestamp,
6868
so syslog-ng OSE will convert the hour:min values based on the explicitly
6969
specified timezone.

doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/001_IETF_syslog_messages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The HEADER part contains the following elements:
8383

8484
**NOTE:** The syslog-ng application supports other timestamp formats as
8585
well, like ISO, or the PIX extended format. The timestamp used in the
86-
IETF-syslog protocol is derived from RFC3339, which is based on ISO8601.
86+
IETF-syslog protocol is derived from RFC-3339, which is based on ISO8601.
8787
For details, see the ts-format() option in Global options.
8888
{: .notice--info}
8989

doc/_admin-guide/020_The_concepts_of_syslog-ng/007_The_structure_of_a_log_message/002_EWMM_messages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The following is a sample log message in EWMM format.
2828
The message has the following parts:
2929

3030
- The header of the complies with the
31-
IETF-syslog messages RFC5424 message format,
31+
IETF-syslog messages RFC-5424 message format,
3232
where the PROGRAM field is set to @syslog-ng, and the SDATA field is empty.
3333

3434
- The MESSAGE part is in JSON format, and contains the actual message,

doc/_admin-guide/020_The_concepts_of_syslog-ng/008_Message_representation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ id: adm-conc-msg
44
description: >-
55
When the syslog-ng OSE application receives a message, it automatically
66
parses the message. The syslog-ng OSE application can automatically
7-
parse log messages that conform to the RFC3164 (BSD or legacy-syslog) or
8-
the RFC5424 (IETF-syslog) message formats. If syslog-ng OSE cannot parse
7+
parse log messages that conform to the RFC-3164 (BSD or legacy-syslog) or
8+
the RFC-5424 (IETF-syslog) message formats. If syslog-ng OSE cannot parse
99
a message, it results in an error.
1010
---
1111

@@ -67,7 +67,7 @@ Soft macros (sometimes also called name-value pairs) are either
6767
built-in macros automatically generated from the log message (for
6868
example, ${HOST}), or custom user-created macros generated by using
6969
the syslog-ng pattern database or a CSV-parser. The SDATA fields of
70-
RFC5424-formatted log messages become soft macros as well. In
70+
RFC-5424 formatted log messages become soft macros as well. In
7171
contrast with hard macros, soft macros are writable and can be
7272
modified within syslog-ng OSE, for example, using rewrite rules.
7373

0 commit comments

Comments
 (0)