Skip to content

Commit 7fa477d

Browse files
committed
syslog-ng name variables in admin guide
Signed-off-by: mrgarris0n <gergely.karacsonyi@gmail.com>
1 parent a897c55 commit 7fa477d

File tree

419 files changed

+2165
-2204
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

419 files changed

+2165
-2204
lines changed

_includes/doc/admin-guide/facility-severity.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ The possible Facility values (between 0 and 23) and Severity values
22
(between 0 and 7) each correspond to a message type (see **Table 1: syslog Message Facilities**), or a message importance level (see **Table 2:** syslog Message Severities).
33

44
**NOTE:** Facility codes may slightly vary between different platforms. The
5-
syslog-ng Open Source Edition (syslog-ng OSE) application accepts
5+
{{ site.product.name }} ({{ site.product.short_name }}) application accepts
66
Facility codes as numerical values as well.
77
{: .notice--info}
88

99
The following table lists possible Facility values.
1010

11-
**Table 1:** syslog-ng message facilities
11+
**Table 1:** {{ site.product.short_name }} message facilities
1212

1313
|Numerical Code| Facility|
1414
|-----------------|--------|
@@ -30,7 +30,7 @@ The following table lists possible Facility values.
3030
|15 |clock daemon|
3131
|16-23 |locally used facilities (local0-local7)|
3232

33-
**Table 2:** syslog-ng message severities
33+
**Table 2:** {{ site.product.short_name }} message severities
3434

3535
The following table lists possible Severity values.
3636

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
The FQDN of the host that sent the message to syslog-ng
2-
as resolved by syslog-ng using DNS. If the message traverses several
2+
as resolved by {{ site.product.short_name }} using DNS. If the message traverses several
33
hosts, this is the last host in the chain.
44

5-
The syslog-ng OSE application uses the following procedure to determine
5+
The {{ site.product.short_name }} application uses the following procedure to determine
66
the value of the {{ include.from }} macro:
77

8-
1. The syslog-ng OSE application takes the IP address of the host
8+
1. The {{ site.product.short_name }} application takes the IP address of the host
99
sending the message.
1010

11-
2. If the use-dns() option is enabled, syslog-ng OSE attempts to
11+
2. If the use-dns() option is enabled, {{ site.product.short_name }} attempts to
1212
resolve the IP address to a hostname. If it succeeds, the returned
1313
hostname will be the value of the {{ include.from }} macro. This value
1414
will be the FQDN of the host if the use-fqdn() option is enabled,
@@ -18,5 +18,5 @@ the value of the {{ include.from }} macro:
1818
fails, the {{ include.from }} macro will return the IP address of
1919
the sender host.
2020

21-
For details on using name resolution in syslog-ng OSE, see
21+
For details on using name resolution in {{ site.product.short_name }}, see
2222
Using name resolution in syslog-ng.

_includes/doc/admin-guide/host-macro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The name of the source host where the message originates from.
77
- If the keep-hostname() option is disabled
88
(**keep-hostname(no)**), the value of the {{ include.macro }} macro
99
will be the DNS hostname of the host that sent the message to
10-
syslog-ng OSE (that is, the DNS hostname of the last hop). In this
10+
{{ site.product.short_name }} (that is, the DNS hostname of the last hop). In this
1111
case the {{ include.macro }} and {{ include.from }} macros will have the same
1212
value.
1313

@@ -23,5 +23,5 @@ The name of the source host where the message originates from.
2323
hostname.
2424
{: .notice--info}
2525

26-
For details on using name resolution in syslog-ng OSE, see
26+
For details on using name resolution in {{ site.product.short_name }}, see
2727
Using name resolution in syslog-ng.

_includes/doc/admin-guide/load-balancing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Starting with version 3.19, you can specify multiple URLs, for example,
2-
url("site1" "site2"). In this case, syslog-ng OSE sends log messages
2+
url("site1" "site2"). In this case, {{ site.product.short_name }} sends log messages
33
to the specified URLs in a load-balance fashion. This means that
4-
syslog-ng OSE sends each message to only one URL. For example, you can
4+
{{ site.product.short_name }} sends each message to only one URL. For example, you can
55
use this to send the messages to a set of ingestion nodes or indexers of
66
your SIEM solution if a single node cannot handle the load. Note that
77
the order of the messages as they arrive on the servers can differ from
8-
the order syslog-ng OSE has received them, so use load-balancing only if
8+
the order {{ site.product.short_name }} has received them, so use load-balancing only if
99
your server can use the timestamp from the messages. If the server uses
1010
the timestamp when it receives the messages, the order of the messages
1111
will be incorrect.
@@ -15,7 +15,7 @@ If you set multiple URLs in the url() option, set the **persist-name()**
1515
option as well to avoid data loss.
1616
{: .notice--warning}
1717

18-
Starting with version syslog-ng OSE version 3.22, you can use any of the
18+
Starting with version {{ site.product.short_name }} version 3.22, you can use any of the
1919
following formats to specify multiple URLs:
2020

2121
```config
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
## See also
22

33
The syslog-ng.conf manual page
4-
The syslog-ng manual page
4+
The {{ site.product.short_name }} manual page
55

66
>**NOTE:**
7-
>If you experience any problems or need help with syslog-ng OSE, visit
8-
>the syslog-ng mailing list.
7+
>If you experience any problems or need help with {{ site.product.short_name }}, visit
8+
>the {{ site.product.short_name }} mailing list.
99
>
10-
>For news and notifications about syslog-ng OSE, visit the syslog-ng blogs.
10+
>For news and notifications about {{ site.product.short_name }}, visit the {{ site.product.short_name }} blogs.
1111
{: .notice--info}
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

2-
**NOTE:** The {{ page.app }} application is distributed with the syslog-ng OSE
3-
system logging application, and is usually part of the syslog-ng OSE
4-
package. The latest version of the syslog-ng OSE application is
5-
available at the syslog-ng OSE page.
2+
**NOTE:** The {{ page.app }} application is distributed with the {{ site.product.short_name }}
3+
system logging application, and is usually part of the {{ site.product.short_name }}
4+
package. The latest version of the {{ site.product.short_name }} application is
5+
available at the {{ site.product.short_name }} page.
66
{: .notice--info}
77

88
This manual page is only an abstract.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**NOTE:** To convert match variables into a syslog-ng OSE list, use the $\*
1+
**NOTE:** To convert match variables into a {{ site.product.short_name }} list, use the $\*
22
macro, which can be further manipulated using List manipulation,
33
or turned into a list in type-aware destinations.
44
{: .notice--info}

_includes/doc/admin-guide/notes/kafka-c.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
mandatory. While you can specify everything in the config() option if
33
you want, the properties-file() is optional. If you have an option in
44
both the config() and the properties-file() specified, the option
5-
specified later in the syslog-ng OSE configuration file will prevail.
5+
specified later in the {{ site.product.short_name }} configuration file will prevail.
66
{: .notice--info}
77

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
**NOTE:** If the specified parameter value is not a valid value, the
2-
function ignores it and sends a debug message. However, the syslog-ng
3-
Open Source Edition (syslog-ng OSE) application will still send the
2+
function ignores it and sends a debug message. However, the ({{ site.product.name }}({{ site.product.short_name }}) application will still send the
43
message.
54
{: .notice--info}

_includes/doc/admin-guide/notes/python-arrow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
>**NOTE:** From version 3.27, syslog-ng OSE supports the arrow syntax for
1+
>**NOTE:** From version 3.27, {{ site.product.short_name }} supports the arrow syntax for
22
>declaring custom Java and Python options. You can alternatively declare
33
>them using a similar syntax:
44
>

0 commit comments

Comments
 (0)