Skip to content

Commit 580eb08

Browse files
committed
Formatting fixes
1 parent 6a35568 commit 580eb08

File tree

7 files changed

+36
-34
lines changed

7 files changed

+36
-34
lines changed

content/app-man-syslog-ng/syslog-ng-debun.1.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,18 +71,18 @@ Using this option under high message load may increase disk I/O during the debug
7171

7272
- `-t <seconds>`
7373

74-
Run {{% param "product.abbrev" %}} in noninteractive debug mode for <span class="code"><seconds></span>, and automatically exit debug mode after the specified number of seconds.
74+
Run {{% param "product.abbrev" %}} in non-interactive debug mode for `<seconds>`, and automatically exit debug mode after the specified number of seconds.
7575

7676
- `-w <seconds>`
7777

78-
Wait <span class="code"><seconds></span> seconds before starting debug mode.
78+
Wait `<seconds>` seconds before starting debug mode.
7979

8080

8181

8282
## System call tracing
8383

8484
- `-s`
85-
85+
8686
Enable syscall tracing (`strace -f` or `truss -f`). Note that using `-s` itself does not enable debug mode, only traces the system calls of an already running {{% param "product.abbrev" %}} process. To trace system calls in debug mode, use both the `-s` and `-d` options.
8787

8888

@@ -105,7 +105,7 @@ Capturing packets requires a packet capture tool on the host. The `syslog-debun`
105105

106106
- `-t <seconds>`
107107

108-
Run {{% param "product.abbrev" %}} in noninteractive debug mode for `<seconds>`, and automatically exit debug mode after the specified number of seconds.
108+
Run {{% param "product.abbrev" %}} in non-interactive debug mode for `<seconds>`, and automatically exit debug mode after the specified number of seconds.
109109

110110

111111

@@ -123,7 +123,7 @@ Create a simple debug bundle, collecting information about your environment, for
123123
syslog-ng-debun -r -l
124124
```
125125

126-
Similar to `syslog-ng-debun -r`, but without privacy-sensitive information. For example, the following is NOT collected: `fstab`, df output, mount info, ip / network interface configuration, DNS resolv info, and process tree.
126+
Similar to `syslog-ng-debun -r`, but without privacy-sensitive information. For example, the following is NOT collected: `fstab`, df output, mount info, ip / network interface configuration, DNS resolve info, and process tree.
127127

128128
```shell
129129
syslog-ng-debun -r -d

content/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-header/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ weight: 300
44
---
55
<!-- 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. -->
66

7-
This section describes the <span class="code">HEADER</span> message part of a syslog message, according to the [legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
7+
This section describes the `HEADER` message part of a syslog message, according to the [legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
88

9-
For further details about the <span class="code">MSG</span> and <span class="code">PRI</span> parts of a syslog message, see the following sections:
9+
For further details about the `MSG` and `PRI` parts of a syslog message, see the following sections:
1010

11-
- `[MSG]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-msg/_index.md" >}})`
11+
- [MSG]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-msg/_index.md" >}})
1212

13-
- `[PRI]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-pri/_index.md" >}})`
13+
- [PRI]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-pri/_index.md" >}})
1414

1515

1616
## The HEADER message part
1717

18-
The <span class="code">HEADER</span> message part contains a timestamp and the hostname (without the domain name) or the IP address of the device. The timestamp field is the local time in the *Mmm dd hh:mm:ss* format, where:
18+
The `HEADER` message part contains a timestamp and the hostname (without the domain name) or the IP address of the device. The timestamp field is the local time in the *Mmm dd hh:mm:ss* format, where:
1919

2020
- *Mmm* is the English abbreviation of the month: Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
2121

content/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-msg/_index.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,13 @@ weight: 500
44
---
55
<!-- 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. -->
66

7-
This section describes the <span class="code">MSG</span> message part of a syslog message, according to the [legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
7+
This section describes the `MSG` message part of a syslog message, according to the [legacy-syslog or BSD-syslog protocol](https://tools.ietf.org/search/rfc3164).
88

9-
For further details about the <span class="code">HEADER</span> and <span class="code">PRI</span> message parts of a syslog message, see the following sections:
10-
11-
- `[HEADER]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-header/_index.md" >}})`
12-
13-
- `[PRI]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-pri/_index.md" >}})`
9+
For further details about the `HEADER` and `PRI` message parts of a syslog message, see the following sections:
1410

11+
- [HEADER]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-header/_index.md" >}})
12+
- [PRI]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-pri/_index.md" >}})
1513

1614
## The MSG message part
1715

18-
The <span class="code">MSG</span> part contains the name of the program or process that generated the message, and the text of the message itself. The <span class="code">MSG</span> part is usually in the following format: *program[pid]: message text*.
19-
16+
The `MSG` part contains the name of the program or process that generated the message, and the text of the message itself. The `MSG` part is usually in the following format: `program[pid]: message text`.

content/chapter-destinations/configuring-destinations-kafka-c/reference-destination-kafka-c/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ For the `kafka` destination, include the path to the directory where you copied
5555

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

58-
Unlike in the Java implementation, the <span class="code">client-lib-dir()</span> option has no significant role in the C implementation of the `kafka()` destination. The programming language accepts this option for better compatibility.
58+
Unlike in the Java implementation, the `client-lib-dir()` option has no significant role in the C implementation of the `kafka()` destination. The programming language accepts this option for better compatibility.
5959

6060
{{% /alert %}}
6161

content/chapter-troubleshooting-syslog-ng/troubleshooting-selinux-issue-creating-parsers/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ If you are using a recent enough PCRE library, {{% param "product.abbrev" %}} wi
1212
python [21631 ] : SELinux is preventing <syslog-ng path> from using the execmem access on a process.
1313
```
1414

15-
To resolve this issue, switch off the PCRE JIT compile function by using the [disable-jit]({{< relref "/chapter-manipulating-messages/regular-expressions/reference-regexp-types/regexp-flags-options/regexp-flags-options-pcre/_index.md" >}}) <span class="code">flags()</span> option in the given filter or rewrite rule of your configuration.
15+
To resolve this issue, switch off the PCRE JIT compile function by using the [disable-jit]({{< relref "/chapter-manipulating-messages/regular-expressions/reference-regexp-types/regexp-flags-options/regexp-flags-options-pcre/_index.md" >}}) `flags()` option in the given filter or rewrite rule of your configuration.

content/headless/chunk/troubleshooting-selinux-issue-creating-parsers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ If you are using a recent enough PCRE library, {{% param "product.abbrev" %}} wi
1111
python [21631 ] : SELinux is preventing <syslog-ng path> from using the execmem access on a process.
1212
```
1313

14-
To resolve this issue, switch off the PCRE JIT compile function by using the [disable-jit]({{< relref "/chapter-manipulating-messages/regular-expressions/reference-regexp-types/regexp-flags-options/regexp-flags-options-pcre/_index.md" >}}) <span class="code">flags()</span> option in the given filter or rewrite rule of your configuration.
14+
To resolve this issue, switch off the PCRE JIT compile function by using the [disable-jit]({{< relref "/chapter-manipulating-messages/regular-expressions/reference-regexp-types/regexp-flags-options/regexp-flags-options-pcre/_index.md" >}}) `flags()` option in the given filter or rewrite rule of your configuration.

content/quickstart/managing-and-checking-linux/_index.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ To check the status of {{% param "product.abbrev" %}} service
5555

5656
`systemctl --no-pager status syslog-ng`
5757

58-
2. Check the <span class="code">Active:</span> field, which shows the status of {{% param "product.abbrev" %}} service. The following statuses are possible:
58+
2. Check the `Active:` field, which shows the status of {{% param "product.abbrev" %}} service. The following statuses are possible:
5959

60-
- `active (running)` - {{% param "product.abbrev" %}} service is up and running
60+
- `active (running)` - `syslog-ng` service is up and running
6161

6262
```shell
6363
syslog-ng.service - System Logger Daemon
@@ -71,7 +71,7 @@ To check the status of {{% param "product.abbrev" %}} service
7171
6575 /opt/syslog-ng/libexec/syslog-ng -F --no-caps --enable-core
7272
```
7373

74-
- `inactive (dead)` - syslog-ng service is stopped
74+
- `inactive (dead)` - `syslog-ng` service is stopped
7575

7676
```shell
7777
syslog-ng.service - System Logger Daemon
@@ -87,29 +87,34 @@ To check the status of {{% param "product.abbrev" %}} service
8787

8888
To check the process of {{% param "product.abbrev" %}}, execute one of the following commands.
8989

90-
- `ps u `pidof syslog-ng``
91-
90+
- `ps u <pid of syslog-ng>`
91+
9292
Expected output example:
9393

94-
<span class="code">USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND</span>
95-
96-
<span class="code">syslogng 6709 0.0 0.6 308680 13432 ? Ss 09:17 0:00 /opt/syslog-ng/libexec/syslog-ng -F --no-caps --enable-core</span>
94+
```shell
95+
USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND
96+
syslogng 6709 0.0 0.6 308680 13432 ? Ss 09:17 0:00 /opt/syslog-ng/libexec/syslog-ng -F --no-caps --enable-core
97+
```
9798

9899
- `ps axu | grep syslog-ng | grep -v grep`
99-
100+
100101
Expected output example:
101-
102-
<span class="code">syslogng 6709 0.0 0.6 308680 13432 ? Ss 09:17 0:00 /opt/syslog-ng/libexec/syslog-ng -F --no-caps --enable-core</span>
102+
103+
```shell
104+
syslogng 6709 0.0 0.6 308680 13432 ? Ss 09:17 0:00 /opt/syslog-ng/libexec/syslog-ng -F --no-caps --enable-core
105+
```
103106

104107
### Checking the internal logs of {{% param "product.abbrev" %}}
105108

106109
The internal logs of {{% param "product.abbrev" %}} contains informal, warning and error messages.
107110

108-
By default, {{% param "product.abbrev" %}} log messages (generated on the <span class="code">internal()</span> source) are written to `/var/log/messages`.
111+
By default, {{% param "product.abbrev" %}} log messages (generated on the `internal()` source) are written to `/var/log/messages`.
109112
110113
Check the internal logs of {{% param "product.abbrev" %}} for any issue.
111114
112-
### <span id="stats"></span> Message processing
115+
<span id="stats"></span>
116+
117+
### Message processing
113118
114119
The {{% param "product.abbrev" %}} application collects statistics about the number of processed messages on the different sources and destinations.
115120

0 commit comments

Comments
 (0)