Skip to content

Commit

Permalink
Formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
eldarnash committed Feb 7, 2024
1 parent 6a8917f commit 05f0c76
Show file tree
Hide file tree
Showing 17 changed files with 60 additions and 73 deletions.
16 changes: 8 additions & 8 deletions content/app-man-syslog-ng/pdbtool.1.md
Expand Up @@ -53,13 +53,13 @@ Lists every name-value pair that can be set by the rules of the pattern database

List the tags instead of the names of the name-value pairs.

- `--pdb \<path-to-file\>` or `-p \<path-to-file\>`
- `--pdb <path-to-file>` or `-p <path-to-file>`

Name of the pattern database file to use.

- `--program \<programname\>` or `-P \<programname\>`
- `--program <programname>` or `-P <programname>`

List only the name-value pairs that can be set for the messages of the specified `$PROGRAM` application.
List only the name-value pairs that can be set for the messages of the specified `${PROGRAM}` application.



Expand Down Expand Up @@ -151,7 +151,7 @@ The `match` command has the following options:

Print debugging information about the pattern matching. See also the `--debug-csv` option.

- `--file=\<filename-with-path\>` or `-f`
- `--file=<filename-with-path>` or `-f`

Process the messages of the specified log file with the pattern database. This option allows to classify messages offline, and to apply the pattern database to already existing logfiles. To read the messages from the standard input (`stdin`), specify a hyphen (`-`) character instead of a filename.

Expand All @@ -171,7 +171,7 @@ The `match` command has the following options:

Name of the program to use, as contained in the `${PROGRAM}` part of the syslog message.

- `--template=\<template-expression\>` or `-T`
- `--template=<template-expression>` or `-T`

An AxoSyslog template expression that is used to format the output messages.

Expand Down Expand Up @@ -253,7 +253,7 @@ Automatically create a pattern database from a log file containing a large numbe

Enable debug/diagnostic messages on stderr.

- `--file=\<path\>` or `-f`
- `--file=<path>` or `-f`

The logfile containing the log messages to create patterns from. To receive the log messages from the standard input (`stdin`), use `-`.

Expand All @@ -269,11 +269,11 @@ Automatically create a pattern database from a log file containing a large numbe

Do not parse the input file, treat every line as the message part of a log message.

- `--samples=\<number-of-samples\>`
- `--samples=<number-of-samples>`

Include a generated name in the parsers, for example, `.dict.string1`, `.dict.string2`, and so on.

- `--support=\<number\>` or `-S`
- `--support=<number>` or `-S`

A pattern is added to the output pattern database if at least the specified percentage of log messages from the input logfile match the pattern. For example, if the input logfile contains 1000 log messages and the `--support=3.0` option is used, a pattern is created only if the pattern matches at least 3 percent of the log messages (that is, 30 log messages). If patternize does not create enough patterns, try to decrease the support value.

Expand Down
Expand Up @@ -41,9 +41,9 @@ The following example illustrates a sample syslog message with a sample `PRI` fi

In this example, `<133>` represents the `PRI` field (Priority value). The syslog message's Facility value is `16`, and the Severity value is `5`.

Substituting the numerical values into the `<PRI>` = ( `<facility>` \* `8`) + `<severity>` formula, the results match the Priority value in our example:
Substituting the numerical values into the `<PRI>` = ( `<facility>` * `8`) + `<severity>` formula, the results match the Priority value in our example:

`<133>` = ( `<16>` \* `8`) + `<5>`.
`<133>` = ( `<16>` * `8`) + `<5>`.


## Facility and Severity values
Expand Down
28 changes: 14 additions & 14 deletions content/chapter-concepts/concepts-things-to-consider/_index.md
Expand Up @@ -48,24 +48,24 @@ Because some combination of drivers and options are invalid, you can use the fol

If you use the same driver and options in the destination of your {{% param "product.abbrev" %}} client and the source of your {{% param "product.abbrev" %}} server, everything should work as expected. Unfortunately there are some other combinations, that seem to work, but result in losing parts of the messages. The following table show the combinations:

| Source \\ Destination | syslog/tcp | syslog/udp | syslog/tls | network/tcp | network/udp | network/tls | network/tcp/flag | network/udp/flag | network/tls/flag |
| Source \ Destination | syslog/tcp | syslog/udp | syslog/tls | network/tcp | network/udp | network/tls | network/tcp/flag | network/udp/flag | network/tls/flag |
| --------------------- | ---------- | ---------- | ---------- | ----------- | ----------- | ----------- | ---------------- | ---------------- | ---------------- |
| syslog/tcp || \- | \- | \! | \- | \- | \! | \- | \- |
| syslog/udp | \- || \- | \- | \! | \- | \- | \! | \- |
| syslog/tls | \- | \- || \- | \- | \! | \- | \- | \! |
| network/tcp | \- | \- | \- || \- | \- | ✔? | \- | \- |
| network/udp | \- | ✔? | \- | \- || \- | \- | ✔? | \- |
| network/tls | \- | \- | \- | \- | \- || \- | \- | ✔? |
| network/tcp/flag | \! | \- | \- | \! | \- | \- || \- | \- |
| network/udp/flag | \- | \! | \- | \- | \! | \- | \- || \- |
| network/tls/flag | \- | \- | \! | \- | \- | \! | \- | \- ||
| syslog/tcp || - | - | ! | - | - | ! | - | - |
| syslog/udp | - || - | - | ! | - | - | ! | - |
| syslog/tls | - | - || - | - | ! | - | - | ! |
| network/tcp | - | - | - || - | - | ✔? | - | - |
| network/udp | - | ✔? | - | - || - | - | ✔? | - |
| network/tls | - | - | - | - | - || - | - | ✔? |
| network/tcp/flag | ! | - | - | ! | - | - || - | - |
| network/udp/flag | - | ! | - | - | ! | - | - || - |
| network/tls/flag | - | - | ! | - | - | ! | - | - ||

Source-destination driver combinations

- \- This method does not work. The logs will not get to the server.
- `-` This method does not work. The logs will not get to the server.

- This method works.
- `` This method works.

- \! This method has some visible drawbacks. The logs go through, but some of the values are missing/misplaced/and so on.
- `!` This method has some visible drawbacks. The logs go through, but some of the values are missing/misplaced/and so on.

- ✔? This method seems to work, but it is not recommended because this can change in a future release.
- `✔?` This method seems to work, but it is not recommended because this can change in a future release.
Expand Up @@ -62,7 +62,7 @@ The `value-pairs()` option has the following parameters. The parameters are eval
)
```

The name of the macro to remove can include wildcards `(\*, ?)`. Regular expressions are not supported.
The name of the macro to remove can include wildcards `(*, ?)`. Regular expressions are not supported.

### `key()` {#key}

Expand All @@ -71,7 +71,7 @@ The name of the macro to remove can include wildcards `(\*, ?)`. Regular express
| Type: | Space-separated list of macros to be included in the selection. |
| Default: | empty string |

*Description:* This option selects the specified macros. The selected macros will be included as `MACRONAME = MACROVALUE`, that is using `key("HOST")` will result in `HOST = $HOST`. You can use wildcards `(\*, ?)` to select multiple macros. For example:
*Description:* This option selects the specified macros. The selected macros will be included as `MACRONAME = MACROVALUE`, that is using `key("HOST")` will result in `HOST = $HOST`. You can use wildcards `(*, ?)` to select multiple macros. For example:

```shell
value-pairs(
Expand Down Expand Up @@ -208,7 +208,7 @@ The `rekey()` option can be used with the `format-json` template-function as wel
- *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.
- *sdata*: The metadata from the structured-data (SDATA) part of RFC5424-formatted messages, that is, every macro that starts with `.SDATA.`
- *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).
- *none*: Reset previously added scopes, for example, to delete automatically-added name-value pairs. The following example deletes every value-pair from the scope, and adds only the ones starting with iptables: `$(format-welf --scope none .iptables.\*)`
- *none*: Reset previously added scopes, for example, to delete automatically-added name-value pairs. The following example deletes every value-pair from the scope, and adds only the ones starting with iptables: `$(format-welf --scope none .iptables.*)`

For example:

Expand Down
Expand Up @@ -20,7 +20,7 @@ The type and name combination of each block must be unique, that is, two blocks

To use a block in your configuration file, you have to do two things:

- Include the file defining the block in the `syslog-ng.conf` file — or a file already included into `syslog-ng.conf`. Version 3.7 and newer automatically includes the `*.conf` files from the `<directory-where-syslog-ng-is-installed>/scl/\*/` directories.
- Include the file defining the block in the `syslog-ng.conf` file — or a file already included into `syslog-ng.conf`. Version 3.7 and newer automatically includes the `*.conf` files from the `<directory-where-syslog-ng-is-installed>/scl/*/` directories.

- Reference the name of the block in your configuration file. This will insert the block into your configuration. For example, to use a block called `myblock`, include the following line in your configuration:

Expand Down
Expand Up @@ -41,7 +41,7 @@ The {{% param "product.abbrev" %}} application can automatically execute scripts
done;
```

The script generates an output similar to this one, where `service\*` is the actual name of a subdirectory:
The script generates an output similar to this one, where `service*` is the actual name of a subdirectory:

```shell
file("/var/log/apache2/service1/access.log" flags(no-parse) program-override("apache2"));
Expand Down
Expand Up @@ -12,9 +12,9 @@ The AxoSyslog application supports including external files in its configuration

This imports the entire file into the configuration of {{% param "product.abbrev" %}}, at the location of the include statement. The `<filename>` can be one of the following:

- A filename, optionally with full path. The filename (not the path) can include UNIX-style wildcard characters (`\*`, `?`). When using wildcard characters, {{% param "product.abbrev" %}} will include every matching file. For details on using wildcard characters, see [Types and options of regular expressions]({{< relref "/chapter-manipulating-messages/regular-expressions/reference-regexp-types/_index.md" >}}).
- A filename, optionally with full path. The filename (not the path) can include UNIX-style wildcard characters (`*`, `?`). When using wildcard characters, {{% param "product.abbrev" %}} will include every matching file. For details on using wildcard characters, see [Types and options of regular expressions]({{< relref "/chapter-manipulating-messages/regular-expressions/reference-regexp-types/_index.md" >}}).

- A directory. When including a directory, {{% param "product.abbrev" %}} will try to include every file from the directory, except files beginning with a \~ (tilde) or a . (dot) character. Including a directory is not recursive. The files are included in alphabetic order, first files beginning with uppercase characters, then files beginning with lowercase characters. For example, if the directory contains the `a.conf, B. conf, c.conf, D.conf` files, they will be included in the following order: `B.conf, D. conf, a.conf, c.conf`.
- A directory. When including a directory, {{% param "product.abbrev" %}} will try to include every file from the directory, except files beginning with a `~` (tilde) or a `.` (dot) character. Including a directory is not recursive. The files are included in alphabetic order, first files beginning with uppercase characters, then files beginning with lowercase characters. For example, if the directory contains the `a.conf, B. conf, c.conf, D.conf` files, they will be included in the following order: `B.conf, D. conf, a.conf, c.conf`.

When including configuration files, consider the following points:

Expand Down
Expand Up @@ -33,7 +33,7 @@ When using the `program()` driver, consider the following:

## Example: Using the program() destination driver {#example-destination-program}

The message format does not include the priority and facility values by default. To add these values, specify a template for the program destination, as shown in the following example. Make sure to end your template with a newline character (`\\n`).
The message format does not include the priority and facility values by default. To add these values, specify a template for the program destination, as shown in the following example. Make sure to end your template with a newline character (`\n`).

```shell
destination d_prog { program("/bin/script" template("<${PRI}>${DATE} ${HOST} ${MESSAGE}\n") ); };
Expand Down
Expand Up @@ -34,7 +34,7 @@ Note that in earlier versions of {{% param "product.abbrev" %}}, the default for

{{% include-headless "chunk/option-destination-template.md" %}}

Make sure to end your template with a newline character (`\\n`).
Make sure to end your template with a newline character (`\n`).

{{% include-headless "chunk/option-destination-template-escape.md" %}}

Expand Down
2 changes: 1 addition & 1 deletion content/chapter-destinations/destination-usertty/_index.md
Expand Up @@ -8,7 +8,7 @@ short_description: "Send messages to a user terminal"

This driver writes messages to the terminal of a logged-in user.

The `usertty()` driver has a single required argument, specifying a username who should receive a copy of matching messages. Use the asterisk `\`* to specify every user currently logged in to the system.
The `usertty()` driver has a single required argument, specifying a username who should receive a copy of matching messages. Use the asterisk `*` to specify every user currently logged in to the system.


## Declaration:
Expand Down
8 changes: 4 additions & 4 deletions content/chapter-encrypted-transport-tls/tlsoptions/_index.md
Expand Up @@ -21,8 +21,8 @@ The tls() option can include the following settings:

| | |
| ---------------- | -------- |
| Accepted values: | yes | no |
| Default: | no |
| Accepted values: | `yes | no` |
| Default: | `no` |

*Description:* Enable on-the-wire compression in TLS communication. Note that this option must be enabled both on the server and the client to have any effect. Enabling compression can significantly reduce the bandwidth required to transport the messages, but can slightly decrease the performance of {{% param "product.abbrev" %}}, reducing the number of transferred messages during a given period.

Expand Down Expand Up @@ -271,8 +271,8 @@ Example configuration:

| | |
| ---------------- | -------- |
| Accepted values: | yes | no |
| Default: | no |
| Accepted values: | `yes | no` |
| Default: | `no` |

*Description:* When set to `yes` in a destination that uses TLS encryption, this option enables [Server Name Indication](https://tools.ietf.org/html/rfc6066#page-6) (also called Server Name Identification, SNI). The {{% param "product.abbrev" %}} sends the hostname or the IP address set in the destination to the server during the TLS handshake.

Expand Down
4 changes: 2 additions & 2 deletions content/chapter-global-options/reference-options/_index.md
Expand Up @@ -636,8 +636,8 @@ By default, timestamps include only seconds. To include fractions of a second (f

| | |
| ---------------- | -------- |
| Accepted values: | yes | no |
| Default: | no |
| Accepted values: | `yes | no` |
| Default: | `no` |

{{% include-headless "chunk/option-description-use-rcptid.md" %}}

Expand Down

0 comments on commit 05f0c76

Please sign in to comment.