Skip to content

Commit a936b42

Browse files
authored
Legacy link fixes (#19)
Fixes: #14
2 parents ce2ef70 + 5008a85 commit a936b42

File tree

32 files changed

+48
-59
lines changed

32 files changed

+48
-59
lines changed
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
For details on how this option influences HTTP batch mode, see
2-
[[this chapter | adm-dest-http-nonjava-batch]]
2+
[[this chapter|adm-dest-http-nonjava-batch]]

_includes/doc/admin-guide/options/deployment.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@
77
deployment](https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security).
88

99
For details on the deployment() option in the sumologic-http()
10-
destination\'s declaration, see [[Declaration for the sumologic-http()
11-
destination|adm-dest-sumologic-http]].
10+
destination\'s declaration, see [[Declaration for the sumologic-http() destination|adm-dest-sumologic-http]].
1211

1312
For details on the deployment() option in the sumologic-syslog()
14-
destination\'s declaration, see [[Declaration for the sumologic-syslog()
15-
destination|adm-dest-sumologic-syslog]].
13+
destination\'s declaration, see [[Declaration for the sumologic-syslog() destination|adm-dest-sumologic-syslog]].

_includes/doc/admin-guide/options/trim-large-messages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ drivers ignore the trim-large-messages() option.
3030
3131
Available in syslog-ng OSE version 3.21 and later.
3232
33-
Uses the value of the [[global option]] if not specified.
33+
Uses the value of the global option if not specified.

_includes/doc/admin-guide/options/ts-format.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ ts-format() parameter) for the specific destination. For details, see
1111
Destinations that use specific protocols (for example, network(), or
1212
syslog()) ignore this option. For protocol-like destinations, use a
1313
template locally in the destination, or use the
14-
[[proto-template]] option.
14+
proto-template() option.
1515
{: .notice--info}

doc/_admin-guide/020_The_concepts_of_syslog-ng/009_Structuring_macros/000_Specifying_data_types.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ description: >-
1515
From syslog-ng OSE version 4.0 onwards, name-value pairs are now
1616
triplets (name, type, value). Typing support is available for several
1717
other components, for example, json-parser() and the $(format-json)
18-
template function. For more information, see [[Components supported by
19-
data types]].
18+
template function. For more information, see Components supported by data types.
2019

2120
![]({{ site.baseurl}}/assets/images/caution.png)
2221
**CAUTION:** Hazard of data loss!
@@ -111,8 +110,7 @@ destination.
111110
Elements without type data are handled as strings.
112111

113112
JSON lists (arrays) are converted to syslog-ng OSE lists, and can be
114-
manipulated using the [[list-append]]
115-
template functions.
113+
manipulated using the $(list-append) template functions.
116114

117115
### set() and groupset() rewrite rules
118116

doc/_admin-guide/050_The_configuration_file/007_Managing_complex_syslog-ng_configurations/001_Reusing_config_blocks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ source s_example {
222222
### Example: Using arguments in blocks
223223

224224
The following example is the code of the
225-
[[pacct() source driver]], which is actually a block that
225+
[[pacct() source driver|adm-src-pacct]], which is actually a block that
226226
can optionally receive two arguments.
227227

228228
```config

doc/_admin-guide/060_Sources/140_Python/003_Fetcher_style_Python_sources.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ the log path. This object references a Python class, which is the second
1717
part of the Python source. The Python class receives or fetches the log
1818
messages, and can do virtually anything that you can code in Python. You
1919
can either embed the Python class into your syslog-ng OSE configuration
20-
file, or [[store it in an external Python file]].
20+
file, or [[store it in an external Python file|adm-conf-python]].
2121

2222
```config
2323
source <name_of_the_python_source>{

doc/_admin-guide/060_Sources/200_systemd-syslog/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: >-
1010
Note the following points about this driver:
1111

1212
- If possible, use the more reliable
13-
[[systemd-journal()]] driver instead.
13+
[[systemd-journal() driver|adm-src-systemd-journal]] instead.
1414

1515
- The socket activation of systemd is buggy, causing some log messages
1616
to get lost during system startup.

doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/000_Unix_credentials.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: >-
1010
The syslog-ng OSE application can extract the following information on
1111
Linux and FreeBSD platforms (examples show the value of the macro for the `su - myuser`
1212
command). Similar information is available for the
13-
[[systemd-journal source]].
13+
[[systemd-journal source|adm-src-systemd-journal]].
1414

1515
| Macro | Description |
1616
|---|---|

doc/_admin-guide/070_Destinations/050_Graphite/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ destination d_graphite { graphite(payload("--key monitor.*")); };
4747
**NOTE:** The graphite() destination is only a wrapper around the network()
4848
destination and the graphite-output template function. If you want to
4949
fine-tune the TCP parameters, use the **network()** destination instead,
50-
as described in [[graphite-output]].
50+
as described in $(graphite-output).
5151
{: .notice--info}

doc/_admin-guide/070_Destinations/070_HDFS/003_hdfs_kerberos_authentication.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ for the changes to take effect.
3030
authentication.
3131

3232
- You have a keytab file and a principal for the host running
33-
syslog-ng OSE. For details, see the [Kerberos
34-
documentation](http://web.mit.edu/Kerberos/krb5-1.5/krb5-1.5.4/doc/krb5-install/The-Keytab-File.html).
33+
syslog-ng OSE. For details, see the [Kerberos documentation](http://web.mit.edu/Kerberos/krb5-1.5/krb5-1.5.4/doc/krb5-install/The-Keytab-File.html).
3534

3635
- You have installed and configured the Kerberos client packages on
3736
the host running syslog-ng OSE. (That is, Kerberos authentication

doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,7 @@ hdfs-uri(\"hdfs://\[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210\]:8020\").
143143

144144
{% include doc/admin-guide/options/jvm-options.md %}
145145

146-
You can set this option only as a
147-
[[global option]], by adding it
146+
You can set this option only as a global option, by adding it
148147
to the options statement of the syslog-ng configuration file.
149148

150149
## kerberos-keytab-file()

doc/_admin-guide/070_Destinations/070_HDFS/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ destination d_hdfs {
7474
- For details on using MapR-FS, see
7575
[[Storing messages with MapR-FS]].
7676
- For details on using Kerberos authentication, see
77-
[[Kerberos authentication with syslog-ng hdfs()destination]].
77+
[[Kerberos authentication with syslog-ng hdfs() destination]].
7878
- For the list of options, see
7979
[[HDFS destination options]].
8080

doc/_admin-guide/070_Destinations/100_Kafka-c/002_Flow_control.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ You can specify a "high water mark" limit for the Kafka client in the
1818
properties-file().
1919

2020
For more information about how the C implementation of the kafka()
21-
destination works with syslog-ng OSE, click [[here]].
21+
destination works with syslog-ng OSE, click [[here|adm-dest-kafkac]].

doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ the message, for example, template(\"$(format-json \--scope rfc5424
226226
\--exclude DATE \--key ISODATE)\").
227227

228228
For details on formatting messages in JSON format, see
229-
[[format-json]].
229+
[[format-json|adm-temp-func#format-json]].
230230

231231
{% include doc/admin-guide/options/throttle.md %}
232232

doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ This destination is available in syslog-ng OSE version 4.4 and later versions.
1313
{% include doc/admin-guide/options/batch-lines.md %}
1414

1515
For details on how this option influences batch mode, see
16-
[[Batch mode and load balancing]]
16+
Batch mode and load balancing with OpenSearch.
1717

1818
{% include doc/admin-guide/options/batch-timeout.md %}
1919

2020
For details on how this option influences batch mode, see
21-
[[Batch mode and load balancing]]
21+
Batch mode and load balancing with OpenSearch.
2222

2323
{% include doc/admin-guide/options/ca-dir.md %}
2424

@@ -37,7 +37,7 @@ For details on how this option influences batch mode, see
3737

3838
{% include doc/admin-guide/options/delimiter.md %}
3939

40-
For details on how this option influences batch mode, see [[Batch mode and load balancing]].
40+
For details on how this option influences batch mode, see Batch mode and load balancing with OpenSearch.
4141

4242
{% include doc/admin-guide/options/disk-buffer.md %}
4343

doc/_admin-guide/070_Destinations/200_Python/README.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ the second part of the Python destination. The Python class processes
2323
the log messages it receives, and can do virtually anything that you can
2424
code in Python. You can either embed the Python class into your
2525
syslog-ng OSE configuration file, or
26-
[[store it in an external Python file]].
26+
[[store it in an external Python file|adm-conf-python]].
2727

2828
```config
2929
destination <name_of_the_python_destination>{
@@ -102,9 +102,8 @@ Error handling in the python() destination.
102102

103103
The send method sends a message to the target service. It should return
104104
True to indicate success, or self.QUEUED when using batch mode. For
105-
other possible return values, see the description of the [[flush()
106-
method|adm-dest-python#flushself-method-optional]]. Note that for batch mode, the
107-
flush() method must be implemented as well.
105+
other possible return values, see the description of the [[flush() method|adm-dest-python#flushself-method-optional]].
106+
Note that for batch mode, the flush() method must be implemented as well.
108107

109108
This is the only mandatory method of the destination.
110109

@@ -208,7 +207,7 @@ The Python destination handles errors as follows.
208207

209208
The purpose of this example is only to demonstrate the basics of the
210209
Python destination, if you really want to write log messages into text
211-
files, use the [[file destination]] instead.
210+
files, use the [[file destination|adm-dest-file]] instead.
212211

213212
The following sample code writes the body of log messages into the
214213
/tmp/example.txt file. Only the send() method is implemented, meaning
@@ -273,9 +272,8 @@ class TextDestination(object):
273272
```
274273

275274
For a more detailed example about sending log messages to an MQTT
276-
(Message Queuing Telemetry Transport) server, see the [Writing Python
277-
destination in syslog-ng: how to send log messages to MQTT blog
278-
post](https://www.syslog-ng.com/community/b/blog/posts/writing-python-destination-in-syslog-ng-how-to-send-log-messages-to-mqtt).
275+
(Message Queuing Telemetry Transport) server, see the
276+
[Writing Python destination in syslog-ng: how to send log messages to MQTT](https://www.syslog-ng.com/community/b/blog/posts/writing-python-destination-in-syslog-ng-how-to-send-log-messages-to-mqtt) blog post.
279277

280278
### Example: Print logs in batch mode
281279

@@ -299,4 +297,4 @@ class MyDestination(object):
299297
```
300298

301299
For the list of available optional parameters, see
302-
[[python() destination options]].
300+
python() destination options.

doc/_admin-guide/070_Destinations/260_Splunk/000_Splunk-hec-event.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,6 @@ destination d_splunk_hec_raw {
7272
};
7373
```
7474

75-
The options of the `splunk-hec-raw()` destination are similar to the [[splunk-hec-event()]] destination, however, the `channel()` option is mandatory. The `channel()` option must be a globally unique channel identifier (GUID), this ID differentiates the data from different clients. Note that Splunk does not generate this ID, you must create it for yourself. When Splunk sees a new channel identifier, it creates a new channel.
75+
The options of the `splunk-hec-raw()` destination are similar to the [[splunk-hec-event()|adm-dest-splunk-hec-event]] destination, however, the `channel()` option is mandatory. The `channel()` option must be a globally unique channel identifier (GUID), this ID differentiates the data from different clients. Note that Splunk does not generate this ID, you must create it for yourself. When Splunk sees a new channel identifier, it creates a new channel.
7676

77-
Use the `template()` option to set the content of the log message sent to Splunk. Avoid using the `event()` option, that is used in the [[splunk-hec-event()]] destination.
77+
Use the `template()` option to set the content of the log message sent to Splunk. Avoid using the `event()` option, that is used in the [[splunk-hec-event()|adm-dest-splunk-hec-event]] destination.

doc/_admin-guide/070_Destinations/310_syslog-ng/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
syslog-ng node in EWMM format.
88
---
99

10-
The [[Enterprise-wide message model (EWMM)]]
10+
The [[Enterprise-wide message model (EWMM)]]
1111
allows you to deliver structured messages from the initial
1212
receiving syslog-ng component right up to the central log server,
1313
through any number of hops. It does not matter if you parse the messages
@@ -18,11 +18,12 @@ component in your infrastructure has received it, which is important if
1818
you want to forward a message for example, to a SIEM system. To make use
1919
of the enterprise-wide message model, you have to use the syslog-ng()
2020
destination on the sender side, and the
21-
[[default-network-drivers() source]] on the receiver side.
21+
[[default-network-drivers() source|adm-src-def-netw]]
22+
on the receiver side.
2223

2324
The syslog-ng() destination driver is available in version 3.16 and
2425
later. The node that receives this message must use the
25-
[[default-network-drivers() source]]
26+
[[default-network-drivers() source|adm-src-def-netw]]
2627
to properly handle the messages.
2728

2829
The following is a sample log message in EWMM format.

doc/_admin-guide/080_Log/030_Filters/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ The following sections describe how to select and filter log messages.
1313
- [[Comparing macro values in filters]]
1414
explains how to evaluate macros in filters.
1515

16-
- [[Using wildcards, special characters, and regular expressions in
17-
filters]] provides tips on using
16+
- [[Using wildcards, special characters, and regular expressions in filters]] provides tips on using
1817
regular expressions.
1918

2019
- [[Tagging messages]] explains

doc/_admin-guide/100_TLS-encrypted_message_transfer/003_Password_protected_keys.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ description: >-
2222
destination, and you use this destination in a log path that has
2323
multiple destinations, neither destinations will receive log
2424
messages until you provide the password. In this cases, always
25-
[[use disk-based buffering to avoid data loss]].
25+
use disk-based buffering to avoid data loss.
2626

2727
- The path and the filename of the private key cannot contain
2828
whitespaces.

doc/_admin-guide/100_TLS-encrypted_message_transfer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ standard syslog protocols, that is, the network() and syslog() drivers,
1414
for example, to forward log messages between two syslog-ng nodes, or to
1515
send log data to syslog-ng Store Box or another log server. Other
1616
destinations that support TLS-encryption are not discussed in this
17-
chapter (for example, [[http())]]).
17+
chapter (for example, [[http())|adm-dest-http-nonjava]]).
1818
{: .notice--info}
1919

2020
TLS uses certificates to authenticate and encrypt the communication, as

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ The week number of the year, prefixed with a zero for the
483483
first nine weeks of the year. (The first Monday in the year marks the
484484
first week.)
485485

486-
See also [[ISOWEEK, C_ISOWEEK, R_ISOWEEK, S_ISOWEEK]].
486+
See also ${ISOWEEK}, ${C_ISOWEEK}, ${R_ISOWEEK}, ${S_ISOWEEK}.
487487

488488
## ${WEEK_DAY_ABBREV}, ${C_WEEK_DAY_ABBREV}, ${R_WEEK_DAY_ABBREV}, ${S_WEEK_DAY_ABBREV}
489489

doc/_admin-guide/120_Parser/005_Parsing_dates/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ the entire template or field. Since by default syslog-ng Open Source
1515
Edition (syslog-ng OSE) uses the ${MESSAGE} part of the log message,
1616
parsing will fail, unless the log message contains only a date, but that
1717
is unlikely, so practically you will have to segment the message (for
18-
example, using a [[csv-parser()]].
18+
example, using a [[csv-parser()|adm-parser-csv]].
1919
You can also use date-parser() to parse dates received in
2020
a JSON or key-value-formatted log message.
2121
{: .notice--info}

doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/002_Correlating_log_messages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,5 +96,5 @@ Note the following points about timeout values:
9696
```
9797

9898
For details on configuring message correlation, see the
99-
[[context-id, context-timeout, and context-scope]]
99+
[[context-id, context-timeout, and context-scope|adm-parser-db-elem-rule#attributes]]
100100
attributes of pattern database rules.

doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ when a message matching the rule is received.
4343
the rule is received.
4444

4545
- *timeout*: Execute the action when the correlation timer
46-
([[context-timeout]] of the
46+
([[context-timeout|adm-parser-db-elem-rule#attributes]] of the
4747
pattern database rule expires. This is available only if actions
4848
are used together with correlating messages.
4949

doc/_admin-guide/120_Parser/023_db_parser/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
title: 'db-parser: Process message content with a pattern database
3-
(patterndb)'
2+
title: 'db-parser: Process message content with a pattern database (patterndb)'
43
short_title: db-parser
54
id: adm-parser-db
65
---

doc/_admin-guide/120_Parser/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ parse the messages, or parts of the messages:
3232
- To parse XML-formatted messages, see [[XML parser]].
3333

3434
- To identify and parse the messages using a pattern database, see
35-
[[db-parser: Process message content with a pattern database]].
35+
[[db-parser: Process message content with a pattern database (patterndb)]].
3636

3737
- To parse a specially-formatted date or timestamp, see
3838
[[Parsing dates and timestamps]].

doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ The displayed metrics have the following structure.
6060
To avoid performance issues or even overloading syslog-ng OSE,
6161
you might want to limit the number of registered dynamic
6262
counters in the message statistics. To do this, configure the
63-
[[stats-max-dynamics()]]
64-
global option.
63+
max-dynamics() parameter of the stats() global option.
6564

6665
- **o** - This object was once active, but stopped receiving messages.
6766
(For example, a dynamic object may disappear and become orphan.)
@@ -249,7 +248,7 @@ The displayed metrics have the following structure.
249248
## Availability of statistics
250249
251250
Certain statistics are available only if the
252-
[[stats-level()]] global option is set to a higher value.
251+
level parameter of stats() global option is set to a higher value.
253252
254253
- Level 0 collects only statistics about the sources and destinations.
255254

doc/_admin-guide/150_Statistics_of_syslog-ng/001_Log_statistic_from_internal_source.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ messages are sent to both destinations.
2727
2828
The statistics include a list of source groups and destinations, as well
2929
as the number of processed messages for each. You can control the
30-
verbosity of the statistics using the
31-
[[stats-level()]] global option.
30+
verbosity of the statistics using the level parameter of stats() global option.
3231

3332
The following is an example output.
3433

doc/_admin-guide/180_Best_practices_and_examples/005_Load_balancing_logs/001_msec_hashing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ description: >-
1111
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:**
1212
Consider that network-load-balancer() is not a destination, only a script that
1313
generates the example configuration described in
14-
[[Load balancing with round robin]].
14+
[[Load balancing with round robin|adm-pract-round-robin]].
1515
Also consider that the configuration generator script may change incompatibly
1616
in the future. As a result, One Identity does not officially support using
1717
this script, and recommends that you only use this script at your own risk.
1818
{: .notice--warning}
1919

2020
As an alternative to using the example configuration described in
21-
[[Load balancing with round robin]], a
21+
[[Load balancing with round robin|adm-pract-round-robin]], a
2222
configuration generator script is also available in syslog-ng OSE:
2323

2424
```config

doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ The stats command has the following options:
226226
>dst.file;#anon-destination0#0;/tmp/2021-08-17.log;o;processed;156
227227
>dst.file;#anon-destination0#0;/tmp/2021-08-18.log;a;processed;961
228228
229-
**NOTE:** The [[stats-lifetime()]] can be used to do the same
229+
**NOTE:** The stats-lifetime() can be used to do the same
230230
automatically and periodically, but currently stats-lifetime()
231231
removes only dynamic counters that have a timestamp field set.
232232
{: .notice--info}

0 commit comments

Comments
 (0)