Skip to content

Commit

Permalink
Use product.abbrev variable instead of product.ose
Browse files Browse the repository at this point in the history
  • Loading branch information
eldarnash committed Oct 22, 2023
1 parent 7b029dd commit 5c18e40
Show file tree
Hide file tree
Showing 20 changed files with 102 additions and 103 deletions.
1 change: 0 additions & 1 deletion config/_default/config.toml
Expand Up @@ -160,7 +160,6 @@ abbrev = "AxoSyslog"
version = "4.0"
techversion = "4.0"
configversion = "4.0"
ose = "AxoSyslog"
syslog-ng = "syslog-ng"
selinux = "SELinux"
apparmor = "AppArmor"
Expand Down
6 changes: 3 additions & 3 deletions content/app-man-syslog-ng/dqtool.1.md
Expand Up @@ -75,21 +75,21 @@ Mar 3 10:52:05 tristram localprg[1234]: seq: 0000011631, runid: 1267609923, sta

`relocate [options] [files]`

Use the `relocate` command to move or rename disk-buffer (also called disk-queue) files. Note that this option modifies the persist file. Stop {{% param "product.ose" %}} before using this command.
Use the `relocate` command to move or rename disk-buffer (also called disk-queue) files. Note that this option modifies the persist file. Stop {{% param "product.abbrev" %}} before using this command.

The `cat` command has the following options:

- `--all` or `-a`

Relocate every disk-buffer file that is listed in the {{% param "product.ose" %}} persist file.
Relocate every disk-buffer file that is listed in the {{% param "product.abbrev" %}} persist file.

- `--new_path` or `-n`

The directory where you want to move the disk-bufffer files. For example: `/var/disk-buffers`

- `--persist` or `-p`

The path to the {{% param "product.ose" %}} persist file. The `relocate` command automatically updates the entries of the disk-buffer files in the persist file.
The path to the {{% param "product.abbrev" %}} persist file. The `relocate` command automatically updates the entries of the disk-buffer files in the persist file.

## Examples

Expand Down
4 changes: 2 additions & 2 deletions content/app-man-syslog-ng/pdbtool.1.md
Expand Up @@ -69,7 +69,7 @@ Lists every name-value pair that can be set by the rules of the pattern database

`dump [options]`

Display the RADIX tree built from the patterns. This shows how are the patterns represented in {{% param "product.ose" %}} and it might also help to track down pattern-matching problems. The dump utility can dump the tree used for matching the PROGRAM or the MSG parts.
Display the RADIX tree built from the patterns. This shows how are the patterns represented in {{% param "product.abbrev" %}} and it might also help to track down pattern-matching problems. The dump utility can dump the tree used for matching the PROGRAM or the MSG parts.

- `--debug` or `-d`

Expand Down Expand Up @@ -295,7 +295,7 @@ pdbtool patternize --support=2.5 --file=/var/log/messages

`test [options]`

Use the `test` command to validate a pattern database XML file. Note that you must have the `xmllint` application installed. The `test` command is available only in {{% param "product.ose" %}} version 3.2 and later.
Use the `test` command to validate a pattern database XML file. Note that you must have the `xmllint` application installed. The `test` command is available only in {{% param "product.abbrev" %}} version 3.2 and later.

- `--color-out` or `-c`

Expand Down
44 changes: 22 additions & 22 deletions content/app-man-syslog-ng/syslog-ng-ctl.1.md
Expand Up @@ -21,23 +21,23 @@ weight: 4900

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

The `syslog-ng-ctl` application is distributed with the {{% param "product.ose" %}} system logging application, and is usually part of the {{% param "product.ose" %}} package.
The `syslog-ng-ctl` application is distributed with the {{% param "product.abbrev" %}} system logging application, and is usually part of the {{% param "product.abbrev" %}} package.

{{% /alert %}}



The `syslog-ng-ctl` application is a utility that can be used to:

- enable/disable various {{% param "product.ose" %}} messages for troubleshooting
- enable/disable various {{% param "product.abbrev" %}} messages for troubleshooting

- display statistics about the processed messages

- handling password-protected private keys

- display the currently running configuration of {{% param "product.ose" %}}
- display the currently running configuration of {{% param "product.abbrev" %}}

- reload the configuration of {{% param "product.ose" %}}.
- reload the configuration of {{% param "product.abbrev" %}}.

<span id="syslog-ng-ctl"></span>

Expand All @@ -51,7 +51,7 @@ Use the `syslog-ng-ctl log-level <level>` command to display verbose, trace, or

Use `syslog-ng-ctl log-level` without any parameters to display the current log level.

If {{% param "product.ose" %}} was started with the `--stderr` or `-e` option, the messages will be sent to `stderr`. If not specified, {{% param "product.ose" %}} will log such messages to its internal source.
If {{% param "product.abbrev" %}} was started with the `--stderr` or `-e` option, the messages will be sent to `stderr`. If not specified, {{% param "product.abbrev" %}} will log such messages to its internal source.

If you need to use a non-standard control socket to access `syslog-ng`, use the `syslog-ng-ctl <command> --control=<socket>` command to specify the socket to use.

Expand All @@ -68,7 +68,7 @@ syslog-ng-ctl log-level verbose

## syslog-ng-ctl query

The {{% param "product.ose" %}} application stores various data, metrics, and statistics in a hash table. Every property has a name and a value. For example:
The {{% param "product.abbrev" %}} application stores various data, metrics, and statistics in a hash table. Every property has a name and a value. For example:

```shell
[syslog-ng]
Expand All @@ -84,7 +84,7 @@ You can query the nodes of this tree, and also use filters to select the informa

- Select all `dropped` value from every `stats` node: `\*.stats.dropped`

The nodes and properties available in the tree depend on your {{% param "product.ose" %}} configuration (that is, the sources, destinations, and other objects you have configured), and also on your `stats-level()` settings.
The nodes and properties available in the tree depend on your {{% param "product.abbrev" %}} configuration (that is, the sources, destinations, and other objects you have configured), and also on your `stats-level()` settings.



Expand All @@ -94,7 +94,7 @@ The nodes and properties available in the tree depend on your {{% param "product

`syslog-ng-ctl query list`

Use the `syslog-ng-ctl query list` command to display the list of metrics that {{% param "product.ose" %}} collects about the processed messages.
Use the `syslog-ng-ctl query list` command to display the list of metrics that {{% param "product.abbrev" %}} collects about the processed messages.

An example output:

Expand Down Expand Up @@ -176,7 +176,7 @@ The `syslog-ng-ctl query get` command has the following options:

Add up the result of each matching node and return only a single number.

For example, the `syslog-ng-ctl query get --sum "destination\*.dropped"` command displays the number of messages dropped by the {{% param "product.ose" %}} instance.
For example, the `syslog-ng-ctl query get --sum "destination\*.dropped"` command displays the number of messages dropped by the {{% param "product.abbrev" %}} instance.

- `--reset`

Expand All @@ -190,11 +190,11 @@ The `syslog-ng-ctl query get` command has the following options:

`stats [options]`

Use the `stats` command to display statistics about the processed messages. For details about the displayed statistics, see [The {{% param "product.ose" %}} documentation](https://axoflow.com/). The `stats` command has the following options:
Use the `stats` command to display statistics about the processed messages. For details about the displayed statistics, see [The {{% param "product.abbrev" %}} documentation](https://axoflow.com/). The `stats` command has the following options:

- `--control=<socket>` or `-c`

Specify the socket to use to access {{% param "product.ose" %}}. Only needed when using a non-standard socket.
Specify the socket to use to access {{% param "product.abbrev" %}}. Only needed when using a non-standard socket.

- `--reset=<socket>` or `-r`

Expand Down Expand Up @@ -261,7 +261,7 @@ destination;df_facility_dot_err;;a;processed;0

`syslog-ng-ctl credentials [options]`

The `syslog-ng-ctl credentials status` command allows you to query the status of the private keys that {{% param "product.ose" %}} uses in the `network()` and `syslog()` drivers. You can also provide the passphrase for password-protected private keys using the `syslog-ng-ctl credentials add` command. For details on using password-protected keys, see [The syslog-ng Administrator Guide](https://www.syslog-ng.com).
The `syslog-ng-ctl credentials status` command allows you to query the status of the private keys that {{% param "product.abbrev" %}} uses in the `network()` and `syslog()` drivers. You can also provide the passphrase for password-protected private keys using the `syslog-ng-ctl credentials add` command. For details on using password-protected keys, see [The syslog-ng Administrator Guide](https://www.syslog-ng.com).



Expand All @@ -271,15 +271,15 @@ The `syslog-ng-ctl credentials status` command allows you to query the status of

`syslog-ng-ctl credentials status [options]`

The `syslog-ng-ctl credentials status` command allows you to query the status of the private keys that {{% param "product.ose" %}} uses in the `network()` and `syslog()` drivers. The command returns the list of private keys used, and their status. For example:
The `syslog-ng-ctl credentials status` command allows you to query the status of the private keys that {{% param "product.abbrev" %}} uses in the `network()` and `syslog()` drivers. The command returns the list of private keys used, and their status. For example:

```shell
syslog-ng-ctl credentials status
Secret store status:
/home/user/ssl_test/client-1/client-encrypted.key SUCCESS
```

If the status of a key is PENDING, you must provide the passphrase for the key, otherwise {{% param "product.ose" %}} cannot use it. The sources and destinations that use these keys will not work until you provide the passwords. Other parts of the {{% param "product.ose" %}} configuration will be unaffected. You must provide the passphrase of the password-protected keys every time {{% param "product.ose" %}} is restarted.
If the status of a key is PENDING, you must provide the passphrase for the key, otherwise {{% param "product.abbrev" %}} cannot use it. 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. You must provide the passphrase of the password-protected keys every time {{% param "product.abbrev" %}} is restarted.

The following log message also notifies you of PENDING passphrases:

Expand All @@ -289,7 +289,7 @@ Waiting for password; keyfile='private.key'

- `--control=<socket>` or `-c`

Specify the socket to use to access {{% param "product.ose" %}}. Only needed when using a non-standard socket.
Specify the socket to use to access {{% param "product.abbrev" %}}. Only needed when using a non-standard socket.



Expand All @@ -299,7 +299,7 @@ Waiting for password; keyfile='private.key'

`syslog-ng-ctl credentials add [options]`

You can add the passphrase to a password-protected private key file using the following command. {{% param "product.ose" %}} will display a prompt for you to enter the passphrase. We recommend that you use this method.
You can add the passphrase to a password-protected private key file using the following command. {{% param "product.abbrev" %}} will display a prompt for you to enter the passphrase. We recommend that you use this method.

```shell
syslog-ng-ctl credentials add --id=<path-to-the-key>
Expand All @@ -319,11 +319,11 @@ echo "<passphrase-of-the-key>" | syslog-ng-ctl credentials add --id=<path-to-the

- `--control=<socket>` or `-c`

Specify the socket to use to access {{% param "product.ose" %}}. Only needed when using a non-standard socket.
Specify the socket to use to access {{% param "product.abbrev" %}}. Only needed when using a non-standard socket.

- `--id=<path-to-the-key>` or `-i`

The path to the password-protected private key file. This is the same path that you use in the `key-file()` option of the {{% param "product.ose" %}} configuration file.
The path to the password-protected private key file. This is the same path that you use in the `key-file()` option of the {{% param "product.abbrev" %}} configuration file.

- `--secret=<passphrase-of-the-key>` or `-s`

Expand All @@ -337,7 +337,7 @@ echo "<passphrase-of-the-key>" | syslog-ng-ctl credentials add --id=<path-to-the

`syslog-ng-ctl config [options]`

Use the `syslog-ng-ctl config` command to display the configuration that {{% param "product.ose" %}} is currently running. By default, only the content of the main configuration file is displayed, included files are not resolved. To resolve included files and display the entire configuration, use the `syslog-ng-ctl config --preprocessed` command.
Use the `syslog-ng-ctl config` command to display the configuration that {{% param "product.abbrev" %}} is currently running. By default, only the content of the main configuration file is displayed, included files are not resolved. To resolve included files and display the entire configuration, use the `syslog-ng-ctl config --preprocessed` command.

Starting with {{% param "product.name" %}} version 4.2, you can display the configuration identifier (if set) and the SHA256 has of the output of the `syslog-ng-ctl config --preprocessed` command by running `syslog-ng-ctl config --id`. For details, see {{% xref "/chapter-configuration-file/configuration-identifier/_index.md" %}}.

Expand All @@ -347,7 +347,7 @@ Starting with {{% param "product.name" %}} version 4.2, you can display the conf

`syslog-ng-ctl reload [options]`

Use the `syslog-ng-ctl reload` command to reload the configuration file of {{% param "product.ose" %}} without having to restart the {{% param "product.ose" %}} application. The `syslog-ng-ctl reload` works like a SIGHUP.
Use the `syslog-ng-ctl reload` command to reload the configuration file of {{% param "product.abbrev" %}} without having to restart the {{% param "product.abbrev" %}} application. The `syslog-ng-ctl reload` works like a SIGHUP.

The `syslog-ng-ctl reload` command returns 0 if the operation was successful, 1 otherwise.

Expand All @@ -357,9 +357,9 @@ The `syslog-ng-ctl reload` command returns 0 if the operation was successful, 1

Available in {{% param "product.abbrev" %}} 4.2 and later.

You can use the `syslog-ng-ctl healthcheck` command to query the healthcheck status of {{% param "product.ose" %}}. The following health values are reported:
You can use the `syslog-ng-ctl healthcheck` command to query the healthcheck status of {{% param "product.abbrev" %}}. The following health values are reported:

- `mainloop_io_worker_roundtrip_latency_nanoseconds`: mainloop->io-worker-job->mainloop roundtrip - a basic latency measure for {{% param "product.ose" %}}.
- `mainloop_io_worker_roundtrip_latency_nanoseconds`: mainloop->io-worker-job->mainloop roundtrip - a basic latency measure for {{% param "product.abbrev" %}}.
- `io_worker_latency_nanoseconds`: io-worker-job start latency.
- `syslogng_internal_events_queue_usage_ratio`: If you are using the [`internal()`]({{< relref "/chapter-sources/configuring-sources-internal/_index.md" >}}) source in your configuration, then this value shows the saturation of the internal source's queue, ranging from 0 to 1. Non-zero values indicate some kind of disruption in the pipelines.

Expand Down

0 comments on commit 5c18e40

Please sign in to comment.