Skip to content

Commit c477e50

Browse files
committed
Missing macro annotations
Signed-off-by: mrgarris0n <gergely.karacsonyi@gmail.com>
1 parent bcfc068 commit c477e50

File tree

4 files changed

+41
-41
lines changed

4 files changed

+41
-41
lines changed

doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,50 +35,50 @@ Rewrite the timezone of a message.
3535
Converting the timezone changes the values of the following date-related
3636
macros (macros MSEC and USEC are not changed):
3737

38-
- AMPM
38+
- ${AMPM}
3939

40-
- DATE
40+
- ${DATE}
4141

42-
- DAY
42+
- ${DAY}
4343

44-
- FULLDATE
44+
- ${FULLDATE}
4545

46-
- HOUR
46+
- ${HOUR}
4747

48-
- HOUR12
48+
- ${HOUR12}
4949

50-
- ISODATE
50+
- ${ISODATE}
5151

52-
- ISOWEEK
52+
- ${ISOWEEK}
5353

54-
- MIN
54+
- ${MIN}
5555

56-
- MONTH
56+
- ${MONTH}
5757

58-
- MONTH_ABBREV
58+
- ${MONTH_ABBREV}
5959

60-
- MONTH_NAME
60+
- ${MONTH_NAME}
6161

62-
- MONTH_WEEK
62+
- ${MONTH_WEEK}
6363

64-
- SEC
64+
- ${SEC}
6565

66-
- STAMP
66+
- ${STAMP}
6767

68-
- TZ
68+
- ${TZ}
6969

70-
- TZOFFSET
70+
- ${TZOFFSET}
7171

72-
- UNIXTIME
72+
- ${UNIXTIME}
7373

74-
- WEEK
74+
- ${WEEK}
7575

76-
- WEEK_DAY
76+
- ${WEEK_DAY}
7777

78-
- WEEK_DAY_ABBREV
78+
- ${WEEK_DAY_ABBREV}
7979

80-
- WEEK_DAY_NAME
80+
- ${WEEK_DAY_NAME}
8181

82-
- YEAR
82+
- ${YEAR}
8383

84-
- YEAR_DAY
84+
- ${YEAR_DAY}

doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/003_Hard_vs_soft_macros.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ However, it is not possible to change the values of hard macros in
1919
rewrite rules or via any other means.
2020

2121
The following macros in {{ site.product.short_name }} are hard macros and cannot be
22-
modified: BSDTAG, CONTEXT\_ID, DATE, DAY, FACILITY\_NUM, FACILITY,
23-
FULLDATE, HOUR, ISODATE, ISOWEEK, LEVEL\_NUM, LEVEL, MIN, MONTH\_ABBREV,
24-
MONTH\_NAME, MONTH, MONTH\_WEEK, PRIORITY, PRI, RCPTID, SDATA, SEC,
25-
SEQNUM, SOURCEIP, STAMP, TAG, TAGS, TZOFFSET, TZ, UNIXTIME,
26-
WEEK\_DAY\_ABBREV, WEEK\_DAY\_NAME, WEEK\_DAY, WEEK, YEAR\_DAY, YEAR.
22+
modified: ${BSDTAG}, ${CONTEXT_ID}, ${DATE}, ${DAY}, ${FACILITY_NUM}, ${FACILITY},
23+
${FULLDATE}, ${HOUR}, ${ISODATE}, ${ISOWEEK}, ${LEVEL_NUM}, ${LEVEL}, ${MIN}, ${MONTH_ABBREV},
24+
${MONTH_NAME}, ${MONTH}, ${MONTH_WEEK}, ${PRIORITY}, ${PRI}, ${RCPTID}, ${SDATA}, ${SEC},
25+
${SEQNUM}, ${SOURCEIP}, ${STAMP}, ${TAG}, ${TAGS}, ${TZOFFSET}, ${TZ}, ${UNIXTIME},
26+
${WEEK_DAY_ABBREV}, ${WEEK_DAY_NAME}, ${WEEK_DAY}, ${WEEK}, ${YEAR_DAY}, ${YEAR}.
2727

28-
The following macros can be modified:FULLHOST\_FROM, FULLHOST,
29-
HOST\_FROM, HOST, LEGACY\_MSGHDR, MESSAGE, MSG,MSGID, MSGONLY, PID,
30-
PROGRAM, SOURCE. Custom values created using rewrite rules or parsers
28+
The following macros can be modified: ${FULLHOST_FROM}, ${FULLHOST},
29+
${HOST_FROM}, ${HOST}, ${LEGACY_MSGHDR}, ${MESSAGE}, ${MSG}, ${MSGID}, ${MSGONLY}, ${PID},
30+
${PROGRAM}, ${SOURCE}. Custom values created using rewrite rules or parsers
3131
can be modified as well, just like stored matches of regular expressions
3232
($0 \... $255).
3333

doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/004_Macros_of_syslog-ng.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ When used, the output specifies the local IP address of the
6464
source from which the message originates.
6565

6666
For an example use case when using the macro is recommended, see
67-
[[Example use case: using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros]]
67+
Example use case: using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros
6868

6969
## ${DESTPORT}
7070

7171
When used, the output specifies the local port of the
7272
source from which the message originates.
7373

7474
For an example use case when using the macro is recommended, see
75-
[[Example use case: using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros]].
75+
Example use case: using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros.
7676

7777
## ${FACILITY}
7878

doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/000_Round_robin.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: Load balancing with a round robin load balancing method based on the R_MSEC macro of {{ site.product.short_name }}
2+
title: Load balancing with a round robin load balancing method based on the ${R_MSEC} macro of {{ site.product.short_name }}
33
short_title: Load balancing with round robin
44
id: adm-pract-round-robin
55
description: >-
66
This section describes a round robin load balancing method based on the
7-
R_MSEC macro of {{ site.product.short_name }} to load
7+
${R_MSEC} macro of {{ site.product.short_name }} to load
88
balance your logs between multiple {{ site.product.short_name }} destinations.
99
---
1010

11-
**TIP:** If R_MSEC is not precise enough, you can replace it with R_USEC
11+
**TIP:** If ${R_MSEC} is not precise enough, you can replace it with R_USEC
1212
(which uses microseconds instead of milliseconds).
1313
{: .notice--info}
1414

15-
For more information about the R_MSEC macro and further macros of
16-
{{ site.product.short_name }}, see Macros of {{ site.product.short_name }}.
15+
For more information about the ${R_MSEC} macro and further macros,
16+
see Macros of {{ site.product.short_name }}.
1717

1818
## Example: round robin load balancing between multiple destinations
1919

@@ -51,7 +51,7 @@ destination d_lb_network {
5151

5252
The filter {\" \<return value \>\" == \"$(% ${R_MSEC} 2)\"}; code
5353
snippets (in bold) serve as the basis of the method. This filter
54-
separates incoming log messages\' timestamp values based on the R_MSEC
54+
separates incoming log messages\' timestamp values based on the ${R_MSEC}
5555
macro, using a division with remainder method, and distributes the log
5656
messages equally between two destinations based on the return value (in
5757
this case, 0 or 1).
@@ -61,5 +61,5 @@ destination with the file in the example (and use the same analogy for
6161
any other {{ site.product.short_name }} destinations).
6262

6363
For an alternative method to use the round robin load balancing method
64-
based on the R_MSEC macro, see
64+
based on the ${R_MSEC} macro, see
6565
Configuration generator for the load balancing method based on MSEC hashing.

0 commit comments

Comments
 (0)