Skip to content

Commit

Permalink
Formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
eldarnash committed Dec 13, 2023
1 parent 6a35568 commit 580eb08
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 34 deletions.
10 changes: 5 additions & 5 deletions content/app-man-syslog-ng/syslog-ng-debun.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,18 +71,18 @@ Using this option under high message load may increase disk I/O during the debug

- `-t <seconds>`

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.
Run {{% param "product.abbrev" %}} in non-interactive debug mode for `<seconds>`, and automatically exit debug mode after the specified number of seconds.

- `-w <seconds>`

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



## System call tracing

- `-s`

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.


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

- `-t <seconds>`

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



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

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.
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.

```shell
syslog-ng-debun -r -d
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ weight: 300
---
<!-- 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. -->

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).
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).

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:
For further details about the `MSG` and `PRI` parts of a syslog message, see the following sections:

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

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


## The HEADER message part

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:
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:

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@ weight: 500
---
<!-- 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. -->

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).
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).

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:

- `[HEADER]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-header/_index.md" >}})`

- `[PRI]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-bsdsyslog/concepts-message-bsdsyslog-pri/_index.md" >}})`
For further details about the `HEADER` and `PRI` message parts of a syslog message, see the following sections:

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

## The MSG message part

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*.

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`.
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For the `kafka` destination, include the path to the directory where you copied

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

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.
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.

{{% /alert %}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ If you are using a recent enough PCRE library, {{% param "product.abbrev" %}} wi
python [21631 ] : SELinux is preventing <syslog-ng path> from using the execmem access on a process.
```

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.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ If you are using a recent enough PCRE library, {{% param "product.abbrev" %}} wi
python [21631 ] : SELinux is preventing <syslog-ng path> from using the execmem access on a process.
```

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.
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.
31 changes: 18 additions & 13 deletions content/quickstart/managing-and-checking-linux/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ To check the status of {{% param "product.abbrev" %}} service

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

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

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

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

- `inactive (dead)` - syslog-ng service is stopped
- `inactive (dead)` - `syslog-ng` service is stopped

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

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

- `ps u `pidof syslog-ng``
- `ps u <pid of syslog-ng>`

Expected output example:

<span class="code">USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND</span>

<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>
```shell
USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND
syslogng 6709 0.0 0.6 308680 13432 ? Ss 09:17 0:00 /opt/syslog-ng/libexec/syslog-ng -F --no-caps --enable-core
```

- `ps axu | grep syslog-ng | grep -v grep`

Expected output example:

<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>

```shell
syslogng 6709 0.0 0.6 308680 13432 ? Ss 09:17 0:00 /opt/syslog-ng/libexec/syslog-ng -F --no-caps --enable-core
```

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

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

By default, {{% param "product.abbrev" %}} log messages (generated on the <span class="code">internal()</span> source) are written to `/var/log/messages`.
By default, {{% param "product.abbrev" %}} log messages (generated on the `internal()` source) are written to `/var/log/messages`.
Check the internal logs of {{% param "product.abbrev" %}} for any issue.
### <span id="stats"></span> Message processing
<span id="stats"></span>
### Message processing
The {{% param "product.abbrev" %}} application collects statistics about the number of processed messages on the different sources and destinations.
Expand Down

0 comments on commit 580eb08

Please sign in to comment.