Skip to content

Commit

Permalink
Fixes xrefs and formatting errors
Browse files Browse the repository at this point in the history
  • Loading branch information
eldarnash committed Sep 2, 2023
1 parent 30c5dda commit ecec42e
Show file tree
Hide file tree
Showing 15 changed files with 55 additions and 121 deletions.
2 changes: 1 addition & 1 deletion content/app-man-syslog-ng/dqtool.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist --all

## See also

<span class="mcFormatColor" style="color: #04aada;">The `syslog-ng.conf` manual page</span>
{{% xref "/app-man-syslog-ng/syslog-ng.conf.5.md" %}}

{{% xref "/app-man-syslog-ng/syslog-ng.8/_index.md" %}}

Expand Down
2 changes: 1 addition & 1 deletion content/app-man-syslog-ng/loggen.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ loggen 127.0.0.1 1061 --read-file -

## See also

<span class="mcFormatColor" style="color: #04aada;">The `syslog-ng.conf` manual page</span>
{{% xref "/app-man-syslog-ng/syslog-ng.conf.5.md" %}}

{{% alert title="Note" color="info" %}}

Expand Down
4 changes: 2 additions & 2 deletions content/app-man-syslog-ng/pdbtool.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,9 +337,9 @@ pdbtool test --validate /home/me/mypatterndb.pdb

## See also

[<span class="mcFormatColor" style="color: #04aada;">AxoSyslog documentation</span>](https://axoflow.com/)
[AxoSyslog documentation](https://axoflow.com/)

<span class="mcFormatColor" style="color: #04aada;">The `syslog-ng.conf` manual page</span>
{{% xref "/app-man-syslog-ng/syslog-ng.conf.5.md" %}}

{{% xref "/app-man-syslog-ng/syslog-ng.8/_index.md" %}}

Expand Down
2 changes: 1 addition & 1 deletion content/app-man-syslog-ng/syslog-ng-ctl.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ Health checks are also published as periodically updated metrics. You can config

## See also

<span class="mcFormatColor" style="color: #04aada;">The `syslog-ng.conf` manual page</span>
{{% xref "/app-man-syslog-ng/syslog-ng.conf.5.md" %}}

{{% xref "/app-man-syslog-ng/syslog-ng.8/_index.md" %}}

Expand Down
2 changes: 1 addition & 1 deletion content/app-man-syslog-ng/syslog-ng-debun.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ Collect `pcap` and debug mode output following this scenario:

## See also

<span class="mcFormatColor" style="color: #04aada;">The `syslog-ng.conf` manual page</span>
{{% xref "/app-man-syslog-ng/syslog-ng.conf.5.md" %}}

{{% alert title="Note" color="info" %}}

Expand Down
2 changes: 1 addition & 1 deletion content/app-man-syslog-ng/syslog-ng.8.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy

## See also

<span class="mcFormatColor" style="color: #04aada;">The `syslog-ng.conf` manual page</span>
{{% xref "/app-man-syslog-ng/syslog-ng.conf.5.md" %}}

{{% alert title="Note" color="info" %}}

Expand Down
4 changes: 2 additions & 2 deletions content/chapter-concepts/concepts-licensing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Practically, the code stored under the `lib` directory of the source code packag

{{% /alert %}}

For details about the LGPL and GPL licenses, see <span class="mcFormatColor" style="color: #04aada;">GNU Lesser General Public License</span> and <span class="mcFormatColor" style="color: #04aada;">GNU General Public License</span>, respectively.
For details about the LGPL and GPL licenses, see [GNU Lesser General Public License](https://github.com/syslog-ng/syslog-ng/blob/master/LGPL.txt) and [GNU General Public License](https://github.com/syslog-ng/syslog-ng/blob/master/GPL.txt), respectively.

For clarity, the Documentation is licensed separately. For details, see <span class="mcFormatColor" style="color: #04aada;">The {{% param "product.ose" %}} Documentation License</span>.
The Documentation is licensed separately. For details, see {{% xref "/documentation-license/_index.md" %}}.
Original file line number Diff line number Diff line change
Expand Up @@ -48,91 +48,40 @@ Substituting the numerical values into the `<PRI>` = ( `<facility>` \* `8`) + `<

## Facility and Severity values

The possible Facility values (between `0` and `23`) and Severity values (between `0` and `7`) each correspond to a message type (see [<span class="mcFormatColor" style="color: #04aada;">Table 1: syslog Message Facilities</span>](#facility-codes)), or a message importance level (see [<span class="mcFormatColor" style="color: #04aada;">Table 2: syslog Message Severities</span>](#severity-codes)).
The possible Facility values (between `0` and `23`) and Severity values (between `0` and `7`) each correspond to a message type (see [Table 1: syslog Message Facilities</span>](#facility-codes)), or a message importance level (see [Table 2: syslog Message Severities](#severity-codes)).

{{% alert title="Note" color="info" %}}

Facility codes may slightly vary between different platforms. The {{% param "product.name" %}} application accepts Facility codes as numerical values as well.

{{% /alert %}}<span id="facility-codes"></span>
{{% /alert %}}

The following table lists possible Facility values.

syslog Message Facilities

Numerical Code

Facility

0

kernel messages

1

user-level messages

2

mail system

3

system daemons

4

security/authorization messages

5

messages generated internally by syslogd

6

line printer subsystem

7

network news subsystem
## syslog Message Facilities {#facility-codes}

8

UUCP subsystem

9

clock daemon

10

security/authorization messages

11

FTP daemon

12

NTP subsystem

13

log audit

14

log alert

15

clock daemon

16-23
The following table lists possible Facility values.

locally used facilities (local0-local7)

<span id="severity-codes"></span>
| Numerical Code | Facility |
| -------------- | ---------------------------------------- |
| 0 | kernel messages |
| 1 | user-level messages |
| 2 | mail system |
| 3 | system daemons |
| 4 | security/authorization messages |
| 5 | messages generated internally by syslogd |
| 6 | line printer subsystem |
| 7 | network news subsystem |
| 8 | UUCP subsystem |
| 9 | clock daemon |
| 10 | security/authorization messages |
| 11 | FTP daemon |
| 12 | NTP subsystem |
| 13 | log audit |
| 14 | log alert |
| 15 | clock daemon |
| 16-23 | locally used facilities (local0-local7) |

## syslog Message Severities {#severity-codes}

The following table lists possible Severity values.

Expand All @@ -146,5 +95,3 @@ The following table lists possible Severity values.
| 5 | Notice: normal but significant condition |
| 6 | Informational: informational messages |
| 7 | Debug: debug-level messages |

syslog Message Severities
2 changes: 1 addition & 1 deletion content/chapter-concepts/concepts-value-pairs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ When using `value-pairs`, there are three ways to specify which information (tha

- Define new name-value pairs to include using the `pair()` parameter.

These parameters are detailed in <span class="mcFormatColor" style="color: #04aada;">value-pairs()</span>.
These parameters are detailed in {{% xref "/chapter-concepts/concepts-value-pairs/option-value-pairs/_index.md" %}}.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 1300
---
<!-- DISCLAIMER: This file is based on the syslog-ng Open Source Edition documentation https://github.com/balabit/syslog-ng-ose-guides/commit/2f4a52ee61d1ea9ad27cb4f3168b95408fddfdf2 and is used under the terms of The syslog-ng Open Source Edition Documentation License. The file has been modified by Axoflow. -->

The `graphite()` destination can send metrics to a [Graphite](http://graphite.readthedocs.io/en/latest/index.html) server to store numeric time-series data. There are many ways to feed the Graphite template function with name value pairs. The {{% param "product.abbrev" %}} CSV and PatternDB parsers (for details, see <span class="mcFormatColor" style="color: #04aada;">Using pattern parsers</span>) can parse log messages and generate name value pairs based on message content. The CSV parser (for details, see {{% xref "/chapter-parsers/csv-parser/_index.md" %}}) can be used for logs that have a constant field based structure, like the Apache web server access logs. The <span>patterndb</span> parser can parse information and can extract important fields from free form log messages, as long as patterns describing the log messages are available. Another way is to send JSON-based log messages (for details, see {{% xref "/chapter-parsers/json-parser/_index.md" %}}) to {{% param "product.abbrev" %}}, like running a simple shell script collecting metrics and running it from cron regularly.
The `graphite()` destination can send metrics to a [Graphite](http://graphite.readthedocs.io/en/latest/index.html) server to store numeric time-series data. There are many ways to feed the Graphite template function with name value pairs. The {{% param "product.abbrev" %}} CSV and PatternDB parsers (for details, see {{% xref "/chapter-parsers/chapter-patterndb/reference-parsers-pattern-databases/syslog-ng-patterndb-using-parsers/_index.md" %}}) can parse log messages and generate name value pairs based on message content. The CSV parser (for details, see {{% xref "/chapter-parsers/csv-parser/_index.md" %}}) can be used for logs that have a constant field based structure, like the Apache web server access logs. The [patterndb() parser] can parse information and can extract important fields from free form log messages, as long as patterns describing the log messages are available. Another way is to send JSON-based log messages (for details, see {{% xref "/chapter-parsers/json-parser/_index.md" %}}) to {{% param "product.abbrev" %}}, like running a simple shell script collecting metrics and running it from cron regularly.

To see an example of how the `graphite()` destination is used to collect statistics coming from `syslog-ng`, see the blog post [Collecting syslog-ng statistics to Graphite](https://syslog-ng.com/blog/collecting-syslog-ng-statistics-to-graphite/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,22 @@ weight: 700

Starting with {{% param "product.abbrev" %}} version 3.14, you can use password-protected private keys in the `network()` and `syslog()` source and destination drivers.


## Restrictions and limitations

- {{% alert title="Note" color="info" %}}
- {{% alert title="Note" color="info" %}}
*Hazard of data loss!* If you use password-protected keys, you must provide the passphrase of the password-protected keys every time {{% param "product.abbrev" %}} is restarted ({{% param "product.abbrev" %}} keeps the passphrases over reloads). The sources and destinations that use these keys will not work until you provide the passwords. Other parts of the {{% param "product.abbrev" %}} configuration will be unaffected.
{{% /alert %}}

This means that if you use a password-protected key in a destination, and you use this destination in a log path that has multiple destinations, neither destinations will receive log messages until you provide the password. In this cases, always [use disk-based buffering to avoid data loss]({{< relref "/chapter-routing-filters/concepts-diskbuffer/_index.md" >}}).

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

- Depending on your platform, the number of passwords {{% param "product.abbrev" %}} can use at the same time might be limited (for example, on Ubuntu 16.04 you can store 16 passwords if you are running {{% param "product.abbrev" %}} as a non-root user). If you use lots of password-protected private keys in your {{% param "product.abbrev" %}} configuration, increase this limit using the following command: `sudo ulimit -l unlimited`
This means that if you use a password-protected key in a destination, and you use this destination in a log path that has multiple destinations, neither destinations will receive log messages until you provide the password. In this cases, always [use disk-based buffering to avoid data loss]({{< relref "/chapter-routing-filters/concepts-diskbuffer/_index.md" >}}).

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

- Depending on your platform, the number of passwords {{% param "product.abbrev" %}} can use at the same time might be limited (for example, on Ubuntu 16.04 you can store 16 passwords if you are running {{% param "product.abbrev" %}} as a non-root user). If you use lots of password-protected private keys in your {{% param "product.abbrev" %}} configuration, increase this limit using the following command: `sudo ulimit -l unlimited`

## Providing the passwords

{{% include-headless "chunk/syslog-ng-ctl-credentials-status-description.md" %}}

{{% include-headless "chunk/syslog-ng-ctl-credentials-add-description.md" %}}

For details on the `syslog-ng-ctl credentials` command, see <span class="mcFormatColor" style="color: #04aada;">The `syslog-ng` control tool manual page</span>.

For details on the `syslog-ng-ctl credentials` command, see {{% xref "/app-man-syslog-ng/syslog-ng-ctl.1.md" %}}.
24 changes: 9 additions & 15 deletions content/chapter-log-statistics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,17 @@ The {{% param "product.abbrev" %}} application collects various statistics and m

## Recommended: Structured, selective methods:

- Using the `monitoring()` source.
- Using the `monitoring()` source.
- Using the [`syslog-ng-ctl`]({{< relref "/chapter-quickstart/managing-and-checking-linux/_index.md#stats" >}}) query command. For further information about using `syslog-ng-ctl` commands, see {{% xref "/app-man-syslog-ng/syslog-ng-ctl.1.md" %}}.

- Using the [`syslog-ng-ctl`]({{< relref "/chapter-quickstart/managing-and-checking-linux/_index.md#stats" >}}) query command.

For further information about using `syslog-ng-ctl` commands, see <span class="mcFormatColor" style="color: #04aada;">The `syslog-ng` manual pages</span>.
## Legacy: Unstructured, bulk methods

- Using the [`internal()` source]({{< relref "/chapter-log-statistics/log-statistics-internal-source/_index.md" >}}).

- Using the [`syslog-ng-ctl stats`]({{< relref "/chapter-quickstart/managing-and-checking-linux/_index.md#stats" >}}) command.

For further information about using `syslog-ng-ctl` commands, see {{% xref "/app-man-syslog-ng/syslog-ng-ctl.1.md" %}}.

## Legacy: Unstructured, bulk methods:

- Using the [`internal()` source]({{< relref "/chapter-log-statistics/log-statistics-internal-source/_index.md" >}}).

- Using the [`syslog-ng-ctl stats`]({{< relref "/chapter-quickstart/managing-and-checking-linux/_index.md#stats" >}}) command.

For further information about using `syslog-ng-ctl` commands, see <span class="mcFormatColor" style="color: #04aada;">The `syslog-ng` manual pages</span>.

- Use the `socat` application: `echo STATS | socat -vv UNIX-CONNECT:/opt/syslog-ng/var/run/syslog-ng.ctl -`

- If you have an OpenBSD-style `netcat` application installed, use the `echo STATS | nc -U /opt/syslog-ng/var/run/syslog-ng.ctl` command. Note that the `netcat` included in most Linux distributions is a GNU-style version that is not suitable to query the statistics of `syslog-ng`.
- Use the `socat` application: `echo STATS | socat -vv UNIX-CONNECT:/opt/syslog-ng/var/run/syslog-ng.ctl -`

- If you have an OpenBSD-style `netcat` application installed, use the `echo STATS | nc -U /opt/syslog-ng/var/run/syslog-ng.ctl` command. Note that the `netcat` included in most Linux distributions is a GNU-style version that is not suitable to query the statistics of `syslog-ng`.
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,9 @@ The following examples replace the separator `';'` character with a `','` charac

## filter

*Syntax:*

$(filter <filter-expression> <list>)
*Syntax:* `$(filter <filter-expression> <list>)`

*Description:* Runs the filter expression on each element of a given list, and returns only those list elements that meet the requirements of the filter expression. The current value is referred by `$_`, similarly to the [<span class="mcFormatColor" style="color: #04aada;">`map` template function</span>](#template-map).
*Description:* Runs the filter expression on each element of a given list, and returns only those list elements that meet the requirements of the filter expression. The current value is referred by `$_`, similarly to the [`map` template function](#template-map).

{{% alert title="Note" color="info" %}}

Expand Down Expand Up @@ -416,8 +414,7 @@ If you have to forward your log messages in JSON format, but the receiving appli
This template function converts value-pairs into the WebTrends Enhanced Log file Format (WELF). The WELF format is a comma-separated list of `name=value` elements. Note that the order of the elements is random. If the value contains whitespace, it is enclosed in double-quotes, for example, `name="value"`. For details on the WELF format, see <https://www3.trustwave.com/support/kb/article.aspx?id=10899>.
To select which value-pairs to convert, use the command-line syntax of the `value-pairs()` option. For details on selecting value-pairs, see <span class="mcFormatColor" style="color: #04aada;">value-pairs()</span>.
To select which value-pairs to convert, use the command-line syntax of the `value-pairs()` option. For details on selecting value-pairs, see {{% xref "/chapter-concepts/concepts-value-pairs/option-value-pairs/_index.md" %}}.
### Example: Using the format-welf() template function
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Some logging implementations require a marker to be set before the JSON payload.

## Example: Using the marker option in JSON parser

This json parser parses log messages which use the "@cee:" marker in front of the json payload. It inserts "`.cee.`" in front of the name of name-value pairs, so later on it is easier to find name-value pairs that were parsed using this parser. (For details on selecting name-value pairs, see <span class="mcFormatColor" style="color: #04aada;">value-pairs()</span>.)
This json parser parses log messages which use the "@cee:" marker in front of the json payload. It inserts "`.cee.`" in front of the name of name-value pairs, so later on it is easier to find name-value pairs that were parsed using this parser. (For details on selecting name-value pairs, see {{% xref "/chapter-concepts/concepts-value-pairs/option-value-pairs/_index.md" %}}.)

```shell
parser {
Expand Down
2 changes: 1 addition & 1 deletion content/chapter-parsers/python-parser/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ This method is executed when {{% param "product.abbrev" %}} is stopped or reload

## Example: Parse loggen logs {#python-parser-example}

The following sample code parses the messages of the `loggen` tool (for details, see <span class="mcFormatColor" style="color: #04aada;">The loggen manual page</span>). The following is a sample loggen message:
The following sample code parses the messages of the `loggen` tool (for details, see {{% xref "/app-man-syslog-ng/loggen.1.md" %}}). The following is a sample loggen message:

```shell
<38>2017-04-05T12:16:46 localhost prg00000[1234]: seq: 0000000000, thread: 0000, runid: 1491387406, stamp: 2017-04-05T12:16:46 PADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADD
Expand Down

0 comments on commit ecec42e

Please sign in to comment.