From 5c18e4044998da0a8f0e8a4e20892751b2ad9133 Mon Sep 17 00:00:00 2001 From: Eldar Nash Date: Sun, 22 Oct 2023 16:38:19 +0200 Subject: [PATCH] Use product.abbrev variable instead of product.ose --- config/_default/config.toml | 1 - content/app-man-syslog-ng/dqtool.1.md | 6 +-- content/app-man-syslog-ng/pdbtool.1.md | 4 +- content/app-man-syslog-ng/syslog-ng-ctl.1.md | 44 +++++++++---------- .../app-man-syslog-ng/syslog-ng-debun.1.md | 28 ++++++------ content/app-man-syslog-ng/syslog-ng.8.md | 30 ++++++------- content/app-man-syslog-ng/syslog-ng.conf.5.md | 36 +++++++-------- content/chapter-concepts/_index.md | 2 +- .../concepts-high-availability/_index.md | 2 +- .../concepts-route-of-a-message/_index.md | 22 +++++----- .../concepts-message-representation/_index.md | 2 +- .../concepts-message-structure/_index.md | 2 +- .../concepts-message-ietfsyslog/_index.md | 2 +- .../syslog-ng-message-format/_index.md | 2 +- .../concepts-client-mode/_index.md | 2 +- .../concepts-relay-mode/_index.md | 2 +- .../concepts-server-mode/_index.md | 2 +- .../syslog-ng-philosophy/_index.md | 2 +- .../chunk/option-destination-diskbuffer.md | 10 ++--- content/headless/chunk/relay-mode-uses.md | 4 +- 20 files changed, 102 insertions(+), 103 deletions(-) diff --git a/config/_default/config.toml b/config/_default/config.toml index ba70d817..0e37b218 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -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" diff --git a/content/app-man-syslog-ng/dqtool.1.md b/content/app-man-syslog-ng/dqtool.1.md index 0056c04c..e1742181 100644 --- a/content/app-man-syslog-ng/dqtool.1.md +++ b/content/app-man-syslog-ng/dqtool.1.md @@ -75,13 +75,13 @@ 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` @@ -89,7 +89,7 @@ The `cat` command has the following options: - `--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 diff --git a/content/app-man-syslog-ng/pdbtool.1.md b/content/app-man-syslog-ng/pdbtool.1.md index afbd10d6..6ddf0f56 100644 --- a/content/app-man-syslog-ng/pdbtool.1.md +++ b/content/app-man-syslog-ng/pdbtool.1.md @@ -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` @@ -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` diff --git a/content/app-man-syslog-ng/syslog-ng-ctl.1.md b/content/app-man-syslog-ng/syslog-ng-ctl.1.md index 5c3a1769..199f95ca 100644 --- a/content/app-man-syslog-ng/syslog-ng-ctl.1.md +++ b/content/app-man-syslog-ng/syslog-ng-ctl.1.md @@ -21,7 +21,7 @@ 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 %}} @@ -29,15 +29,15 @@ The `syslog-ng-ctl` application is distributed with the {{% param "product.ose" 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" %}}. @@ -51,7 +51,7 @@ Use the `syslog-ng-ctl log-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 --control=` command to specify the socket to use. @@ -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] @@ -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. @@ -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: @@ -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` @@ -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=` 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=` or `-r` @@ -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). @@ -271,7 +271,7 @@ 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 @@ -279,7 +279,7 @@ The `syslog-ng-ctl credentials status` command allows you to query the status of /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: @@ -289,7 +289,7 @@ Waiting for password; keyfile='private.key' - `--control=` 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. @@ -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= @@ -319,11 +319,11 @@ echo "" | syslog-ng-ctl credentials add --id=` 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=` 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=` or `-s` @@ -337,7 +337,7 @@ echo "" | syslog-ng-ctl credentials add --id=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. diff --git a/content/app-man-syslog-ng/syslog-ng-debun.1.md b/content/app-man-syslog-ng/syslog-ng-debun.1.md index ae315158..b3701a04 100644 --- a/content/app-man-syslog-ng/syslog-ng-debun.1.md +++ b/content/app-man-syslog-ng/syslog-ng-debun.1.md @@ -27,7 +27,7 @@ The `syslog-debun` application is distributed with the {{% param "product.abbrev {{% /alert %}} -The `syslog-debun` tool collects and saves information about your {{% param "product.ose" %}} installation, making troubleshooting easier, especially if you ask help about your {{% param "product.ose" %}} related problem. +The `syslog-debun` tool collects and saves information about your {{% param "product.abbrev" %}} installation, making troubleshooting easier, especially if you ask help about your {{% param "product.abbrev" %}} related problem. @@ -47,7 +47,7 @@ The `syslog-debun` tool collects and saves information about your {{% param "pro - `-R ` - The directory where {{% param "product.ose" %}} is installed instead of `/opt/syslog-ng`. + The directory where {{% param "product.abbrev" %}} is installed instead of `/opt/syslog-ng`. - `-W ` @@ -59,7 +59,7 @@ The `syslog-debun` tool collects and saves information about your {{% param "pro - `-d` - Start {{% param "product.ose" %}} in debug mode, using the `-Fedv --enable-core` options. + Start {{% param "product.abbrev" %}} in debug mode, using the `-Fedv --enable-core` options. {{% alert title="Warning" color="warning" %}} Using this option under high message load may increase disk I/O during the debug, and the resulting debug bundle can be huge. To exit debug mode, press Enter. @@ -67,11 +67,11 @@ Using this option under high message load may increase disk I/O during the debug - `-D ` - Start {{% param "product.ose" %}} in debug mode, using the specified command-line options. To exit debug mode, press Enter. + Start {{% param "product.abbrev" %}} in debug mode, using the specified command-line options. To exit debug mode, press Enter. - `-t ` - Run {{% param "product.ose" %}} in noninteractive debug mode for , and automatically exit debug mode after the specified number of seconds. + Run {{% param "product.abbrev" %}} in noninteractive debug mode for , and automatically exit debug mode after the specified number of seconds. - `-w ` @@ -83,7 +83,7 @@ Using this option under high message load may increase disk I/O during the debug - `-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.ose" %}} process. To trace system calls in debug mode, use both the `-s` and `-d` options. + 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. @@ -105,7 +105,7 @@ Capturing packets requires a packet capture tool on the host. The `syslog-debun` - `-t ` - Run {{% param "product.ose" %}} in noninteractive debug mode for ``, and automatically exit debug mode after the specified number of seconds. + Run {{% param "product.abbrev" %}} in noninteractive debug mode for ``, and automatically exit debug mode after the specified number of seconds. @@ -129,19 +129,19 @@ Similar to `syslog-ng-debun -r`, but without privacy-sensitive information. For syslog-ng-debun -r -d ``` -Similar to `syslog-ng-debun -r`, but it also stops {{% param "product.ose" %}}, then restarts it in debug mode (`-Fedv --enable-core`). To stop debug mode, press Enter. The output of the debug mode collected into a separate file, and also added to the debug bundle. +Similar to `syslog-ng-debun -r`, but it also stops {{% param "product.abbrev" %}}, then restarts it in debug mode (`-Fedv --enable-core`). To stop debug mode, press Enter. The output of the debug mode collected into a separate file, and also added to the debug bundle. ```shell syslog-ng-debun -r -s ``` -Trace the system calls (using `strace` or `truss`) of an already running {{% param "product.ose" %}} process. +Trace the system calls (using `strace` or `truss`) of an already running {{% param "product.abbrev" %}} process. ```shell syslog-ng-debun -r -d -s ``` -Restart {{% param "product.ose" %}} in debug mode, and also trace the system calls (using `strace` or `truss`) of the {{% param "product.ose" %}} process. +Restart {{% param "product.abbrev" %}} in debug mode, and also trace the system calls (using `strace` or `truss`) of the {{% param "product.abbrev" %}} process. ```shell syslog-ng-debun -r -p @@ -169,11 +169,11 @@ Collect `pcap` and debug mode output following this scenario: - Start packet capture with default parameters (`-p`) - Wait 5 seconds (`-w 5`) -- Stop {{% param "product.ose" %}} -- Start {{% param "product.ose" %}} in debug mode with default parameters (`-d`) +- Stop {{% param "product.abbrev" %}} +- Start {{% param "product.abbrev" %}} in debug mode with default parameters (`-d`) - Wait 10 seconds (`-t 10`) -- Stop {{% param "product.ose" %}} debugging -- Start {{% param "product.ose" %}} +- Stop {{% param "product.abbrev" %}} debugging +- Start {{% param "product.abbrev" %}} - Stop packet capturing ## Files diff --git a/content/app-man-syslog-ng/syslog-ng.8.md b/content/app-man-syslog-ng/syslog-ng.8.md index 84929768..09ca044a 100644 --- a/content/app-man-syslog-ng/syslog-ng.8.md +++ b/content/app-man-syslog-ng/syslog-ng.8.md @@ -24,7 +24,7 @@ weight: 4900 -The {{% param "product.ose" %}} application is a flexible and highly scalable system logging application. Typically, {{% param "product.ose" %}} is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server. The different devices - called clients - all run {{% param "product.ose" %}}, and collect the log messages from the various applications, files, and other sources. The clients send all important log messages to the remote {{% param "product.ose" %}} server, where the server sorts and stores them. +The {{% param "product.abbrev" %}} application is a flexible and highly scalable system logging application. Typically, {{% param "product.abbrev" %}} is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server. The different devices - called clients - all run {{% param "product.abbrev" %}}, and collect the log messages from the various applications, files, and other sources. The clients send all important log messages to the remote {{% param "product.abbrev" %}} server, where the server sorts and stores them. @@ -32,11 +32,11 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--caps` - Run {{% param "product.ose" %}} process with the specified POSIX capability flags. + Run {{% param "product.abbrev" %}} process with the specified POSIX capability flags. - - If the `--no-caps` option is not set, {{% param "product.ose" %}} has been compiled with the `--enable-linux-caps compile` option, and the host supports `CAP_SYSLOG`, {{% param "product.ose" %}} uses the following capabilities: `cap_net_bind_service`, `cap_net_broadcast`, `cap_net_raw`, `cap_dac_read_search`, `cap_dac_override`, `cap_chown`, `cap_fowner=p cap_syslog=ep` + - If the `--no-caps` option is not set, {{% param "product.abbrev" %}} has been compiled with the `--enable-linux-caps compile` option, and the host supports `CAP_SYSLOG`, {{% param "product.abbrev" %}} uses the following capabilities: `cap_net_bind_service`, `cap_net_broadcast`, `cap_net_raw`, `cap_dac_read_search`, `cap_dac_override`, `cap_chown`, `cap_fowner=p cap_syslog=ep` - - If the `--no-caps` option is not set, and the host does not support `CAP_SYSLOG`, {{% param "product.ose" %}} uses the following capabilities: `cap_net_bind_service`, `cap_net_broadcast`, `cap_net_raw`, `cap_dac_read_search`, `cap_dac_override`, `cap_chown`, `cap_fowner=p cap_sys_admin=ep` + - If the `--no-caps` option is not set, and the host does not support `CAP_SYSLOG`, {{% param "product.abbrev" %}} uses the following capabilities: `cap_net_bind_service`, `cap_net_broadcast`, `cap_net_raw`, `cap_dac_read_search`, `cap_dac_override`, `cap_chown`, `cap_fowner=p cap_sys_admin=ep` For example: @@ -66,11 +66,11 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--default-modules` - A comma-separated list of the modules that are loaded automatically. Modules not loaded automatically can be loaded by including the `@module ` statement in the {{% param "product.ose" %}} configuration file. Available only in {{% param "product.ose" %}} version 4.1 and later. + A comma-separated list of the modules that are loaded automatically. Modules not loaded automatically can be loaded by including the `@module ` statement in the {{% param "product.abbrev" %}} configuration file. Available only in {{% param "product.abbrev" %}} version 4.1 and later. - `--enable-core` - Enable {{% param "product.ose" %}} to write core files in case of a crash to help support and debugging. + Enable {{% param "product.abbrev" %}} to write core files in case of a crash to help support and debugging. - `--fd-limit ` @@ -78,7 +78,7 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--foreground` or `-F` - Do not daemonize, run in the foreground. When running in the foreground, {{% param "product.ose" %}} starts from the current directory (`$CWD`) so it can create core files (normally, {{% param "product.ose" %}} starts from `/$PREFIX/var`). + Do not daemonize, run in the foreground. When running in the foreground, {{% param "product.abbrev" %}} starts from the current directory (`$CWD`) so it can create core files (normally, {{% param "product.abbrev" %}} starts from `/$PREFIX/var`). - `--group ` or `-g ` @@ -90,7 +90,7 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--log-level ` - Set the internal log level of {{% param "product.ose" %}} to `default`, `verbose`, `debug`, or `trace`. Available in {{% param "product.ose" %}} 4.0 and later. + Set the internal log level of {{% param "product.abbrev" %}} to `default`, `verbose`, `debug`, or `trace`. Available in {{% param "product.abbrev" %}} 4.0 and later. - `--module-registry` @@ -98,9 +98,9 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--no-caps` - Run {{% param "product.ose" %}} as root, without capability-support. This is the default behavior. On Linux, it is possible to run {{% param "product.ose" %}} as non-root with capability-support if {{% param "product.ose" %}} was compiled with the `--enable-linux-caps` option enabled. (Run `syslog-ng --version` to display the list of enabled build parameters.) + Run {{% param "product.abbrev" %}} as root, without capability-support. This is the default behavior. On Linux, it is possible to run {{% param "product.abbrev" %}} as non-root with capability-support if {{% param "product.abbrev" %}} was compiled with the `--enable-linux-caps` option enabled. (Run `syslog-ng --version` to display the list of enabled build parameters.) - To run {{% param "product.ose" %}} with specific capabilities, use the `--caps` option. + To run {{% param "product.abbrev" %}} with specific capabilities, use the `--caps` option. - `--persist-file ` or `-R ` @@ -112,15 +112,15 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--preprocess-into ` - After processing the configuration file and resolving included files and variables, write the resulting configuration into the specified output file. Available only in {{% param "product.ose" %}} 4 F1 and later. + After processing the configuration file and resolving included files and variables, write the resulting configuration into the specified output file. Available only in {{% param "product.abbrev" %}} 4 F1 and later. - `--process-mode ` - Sets how to run {{% param "product.ose" %}}: in the `foreground` (mainly used for debugging), in the `background` as a daemon, or in `safe-background` mode. By default, `syslog-ng` runs in `safe-background` mode. This mode creates a supervisor process called `supervising syslog-ng`, that restarts {{% param "product.ose" %}} if it crashes. + Sets how to run {{% param "product.abbrev" %}}: in the `foreground` (mainly used for debugging), in the `background` as a daemon, or in `safe-background` mode. By default, `syslog-ng` runs in `safe-background` mode. This mode creates a supervisor process called `supervising syslog-ng`, that restarts {{% param "product.abbrev" %}} if it crashes. - `--stderr` or `-e` - Log internal messages of {{% param "product.ose" %}} to `stderr`. Mainly used for debugging purposes in conjunction with the `--foreground` option. If not specified, `syslog-ng` logs such messages to its internal source. + Log internal messages of {{% param "product.abbrev" %}} to `stderr`. Mainly used for debugging purposes in conjunction with the `--foreground` option. If not specified, `syslog-ng` logs such messages to its internal source. - `--syntax-only` or `-s` @@ -132,7 +132,7 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--verbose` or `-v` - Enable verbose logging used to troubleshoot {{% param "product.ose" %}}. + Enable verbose logging used to troubleshoot {{% param "product.abbrev" %}}. - `--version` or `-V` @@ -140,7 +140,7 @@ The {{% param "product.ose" %}} application is a flexible and highly scalable sy - `--worker-threads` - Sets the number of worker threads {{% param "product.ose" %}} can use, including the main {{% param "product.ose" %}} thread. Note that certain operations in {{% param "product.ose" %}} can use threads that are not limited by this option. This setting has effect only when {{% param "product.ose" %}} is running in multithreaded mode. Available only in {{% param "product.ose" %}} 4 F1 and later. See `The {{% param "product.ose" %}} 7 Administrator Guide` for details. + Sets the number of worker threads {{% param "product.abbrev" %}} can use, including the main {{% param "product.abbrev" %}} thread. Note that certain operations in {{% param "product.abbrev" %}} can use threads that are not limited by this option. This setting has effect only when {{% param "product.abbrev" %}} is running in multithreaded mode. Available only in {{% param "product.abbrev" %}} 4 F1 and later. See `The {{% param "product.abbrev" %}} 7 Administrator Guide` for details. ## Files diff --git a/content/app-man-syslog-ng/syslog-ng.conf.5.md b/content/app-man-syslog-ng/syslog-ng.conf.5.md index c0cc3667..96cc44bb 100644 --- a/content/app-man-syslog-ng/syslog-ng.conf.5.md +++ b/content/app-man-syslog-ng/syslog-ng.conf.5.md @@ -21,31 +21,31 @@ weight: 4900 -The {{% param "product.ose" %}} application is a flexible and highly scalable system logging application. Typically, {{% param "product.ose" %}} is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server. The different devices - called {{% param "product.syslog-ng" %}} clients - all run {{% param "product.ose" %}}, and collect the log messages from the various applications, files, and other sources. The clients send all important log messages to the remote {{% param "product.ose" %}} server, where the server sorts and stores them. +The {{% param "product.abbrev" %}} application is a flexible and highly scalable system logging application. Typically, {{% param "product.abbrev" %}} is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server. The different devices - called {{% param "product.syslog-ng" %}} clients - all run {{% param "product.abbrev" %}}, and collect the log messages from the various applications, files, and other sources. The clients send all important log messages to the remote {{% param "product.abbrev" %}} server, where the server sorts and stores them. -## Basic concepts of {{% param "product.ose" %}} +## Basic concepts of {{% param "product.abbrev" %}} -The {{% param "product.ose" %}} application reads incoming messages and forwards them to the selected destinations. The {{% param "product.ose" %}} application can receive messages from files, remote hosts, and other sources. +The {{% param "product.abbrev" %}} application reads incoming messages and forwards them to the selected destinations. The {{% param "product.abbrev" %}} application can receive messages from files, remote hosts, and other sources. -Log messages enter {{% param "product.ose" %}} in one of the defined sources, and are sent to one or more destinations. +Log messages enter {{% param "product.abbrev" %}} in one of the defined sources, and are sent to one or more destinations. -Sources and destinations are independent objects, log paths define what {{% param "product.ose" %}} does with a message, connecting the sources to the destinations. A log path consists of one or more sources and one or more destinations: messages arriving from a source are sent to every destination listed in the log path. A log path defined in {{% param "product.ose" %}} is called a log statement. +Sources and destinations are independent objects, log paths define what {{% param "product.abbrev" %}} does with a message, connecting the sources to the destinations. A log path consists of one or more sources and one or more destinations: messages arriving from a source are sent to every destination listed in the log path. A log path defined in {{% param "product.abbrev" %}} is called a log statement. -Optionally, log paths can include filters. Filters are rules that select only certain messages, for example, selecting only messages sent by a specific application. If a log path includes filters, {{% param "product.ose" %}} sends only the messages satisfying the filter rules to the destinations set in the log path. +Optionally, log paths can include filters. Filters are rules that select only certain messages, for example, selecting only messages sent by a specific application. If a log path includes filters, {{% param "product.abbrev" %}} sends only the messages satisfying the filter rules to the destinations set in the log path. Other optional elements that can appear in log statements are parsers and rewriting rules. Parsers segment messages into different fields to help processing the messages, while rewrite rules modify the messages by adding, replacing, or removing parts of the messages. -## Configuring {{% param "product.ose" %}} +## Configuring {{% param "product.abbrev" %}} - The main body of the configuration file consists of object definitions: sources, destinations, logpaths define which log message are received and where they are sent. All identifiers, option names and attributes, and any other strings used in the `syslog-ng.conf` configuration file are case sensitive. Object definitions (also called statements) have the following syntax: @@ -57,7 +57,7 @@ Other optional elements that can appear in log statements are parsers and rewrit Identifier of the object: A unique name identifying the object. When using a reserved word as an identifier, enclose the identifier in quotation marks (`""`). - All identifiers, attributes, and any other strings used in the {{% param "product.ose" %}} configuration file are case sensitive. + All identifiers, attributes, and any other strings used in the {{% param "product.abbrev" %}} configuration file are case sensitive. {{% alert title="Note" color="info" %}} @@ -111,7 +111,7 @@ unix-stream("" group(log) max-connections(10)); }; ``` -- Some options are global options, or can be set globally, for example, whether {{% param "product.ose" %}} should use DNS resolution to resolve IP addresses. +- Some options are global options, or can be set globally, for example, whether {{% param "product.abbrev" %}} should use DNS resolution to resolve IP addresses. ```shell options { use-dns(no); }; @@ -121,7 +121,7 @@ unix-stream("" group(log) max-connections(10)); }; - Objects can be defined inline as well. This is useful if you use the object only once (for example, a filter). - - To add comments to the configuration file, start a line with `#` and write your comments. These lines are ignored by {{% param "product.ose" %}}. + - To add comments to the configuration file, start a line with `#` and write your comments. These lines are ignored by {{% param "product.abbrev" %}}. ```shell #Comment: This is a stream source @@ -150,7 +150,7 @@ destination d_tcp { network("10.1.2.3" port(1999) localport(999)); }; log { source(s_localhost); destination(d_tcp); }; ``` -The {{% param "product.ose" %}} application has a number of global options governing DNS usage, the timestamp format used, and other general points. Each option may have parameters, similarly to driver specifications. To set global options add an option statement to the {{% param "product.ose" %}} configuration file using the following syntax: +The {{% param "product.abbrev" %}} application has a number of global options governing DNS usage, the timestamp format used, and other general points. Each option may have parameters, similarly to driver specifications. To set global options add an option statement to the {{% param "product.abbrev" %}} configuration file using the following syntax: ```shell options { option1(params); option2(params); ... }; @@ -159,23 +159,23 @@ options { option1(params); option2(params); ... }; ## Example: Using global options -To disable domain name resolving, add the following line to the {{% param "product.ose" %}} configuration file: +To disable domain name resolving, add the following line to the {{% param "product.abbrev" %}} configuration file: ```shell options { use-dns(no); }; ``` -The sources, destinations, and filters available in {{% param "product.ose" %}} are listed below. For details, see the [{{% param "product.ose" %}} documentation](https://axoflow.com/). +The sources, destinations, and filters available in {{% param "product.abbrev" %}} are listed below. For details, see the [{{% param "product.abbrev" %}} documentation](https://axoflow.com/). -## Table: Source drivers available in {{% param "product.ose" %}} +## Table: Source drivers available in {{% param "product.abbrev" %}} | Name | Description | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | [file()](#) | Opens the specified file and reads messages. | | [wildcard-file()](#) | Reads messages from multiple files and directories. | -| [internal()](#) | Messages generated internally in {{% param "product.ose" %}}. | +| [internal()](#) | Messages generated internally in {{% param "product.abbrev" %}}. | | [network()](#) | Receives messages from remote hosts using the [BSD-syslog protocol](#) over IPv4 and IPv6. Supports the TCP, UDP, and TLS network protocols. | | [nodejs()](#) | Receives JSON messages from nodejs applications. | | [mbox()](#) | Read e-mail messages from local mbox files, and convert them to multiline log messages. | @@ -186,7 +186,7 @@ The sources, destinations, and filters available in {{% param "product.ose" %}} | [snmptrap()](#) | Read and parse the SNMP traps of the Net-SNMP's snmptrapd application. | | [sun-stream(), sun-streams()](#) | Opens the specified STREAMS device on Solaris systems and reads incoming messages. | | [syslog()](#) | Listens for incoming messages using the new [IETF-standard syslog protocol](#). | -| [system()](#) | Automatically detects which platform {{% param "product.ose" %}} is running on, and collects the native log messages of that platform. | +| [system()](#) | Automatically detects which platform {{% param "product.abbrev" %}} is running on, and collects the native log messages of that platform. | | [systemd-journal()](#) | Collects messages directly from the journal of platforms that use systemd. | | [systemd-syslog()](#) | Collects messages from the journal using a socket on platforms that use `systemd`. | | [unix-dgram()](#) | Opens the specified unix socket in SOCK_DGRAM mode and listens for incoming messages. | @@ -218,7 +218,7 @@ The sources, destinations, and filters available in {{% param "product.ose" %}} | [redis()](#) | Sends messages as name-value pairs to a [Redis](https://redis.io/) key-value store. | | [riemann()](#) | Sends metrics or events to a [Riemann](http://riemann.io/) monitoring system. | | [smtp()](#) | Sends e-mail messages to the specified recipients. | -| [sql()](#) | Sends messages into an SQL database. In addition to the standard {{% param "product.ose" %}} packages, the sql() destination requires database-specific packages to be installed. | +| [sql()](#) | Sends messages into an SQL database. In addition to the standard {{% param "product.abbrev" %}} packages, the sql() destination requires database-specific packages to be installed. | | [stomp()](#) | Sends messages to a STOMP server. | | [syslog()](#) | Sends messages to the specified remote host using the [IETF-syslog protocol](#). The IETF standard supports message transport using the UDP, TCP, and TLS networking protocols. | | [unix-dgram()](#) | Sends messages to the specified unix socket in `SOCK_DGRAM` style (BSD). | @@ -242,7 +242,7 @@ The sources, destinations, and filters available in {{% param "product.ose" %}} | [message()](#) | Use a regular expression to filter messages based on their content. | | [netmask()](#) | Filter messages based on the IP address of the sending host. | | [program()](#) | Filter messages based on the sending application. | -| [source()](#) | Select messages of the specified {{% param "product.ose" %}} source statement. | +| [source()](#) | Select messages of the specified {{% param "product.abbrev" %}} source statement. | | [tags()](#) | Select messages having the specified tag. | diff --git a/content/chapter-concepts/_index.md b/content/chapter-concepts/_index.md index 4942b774..43553df7 100644 --- a/content/chapter-concepts/_index.md +++ b/content/chapter-concepts/_index.md @@ -4,4 +4,4 @@ weight: 1100 --- -This chapter discusses the technical concepts of {{% param "product.ose" %}}. +This chapter discusses the technical concepts of {{% param "product.abbrev" %}}. diff --git a/content/chapter-concepts/concepts-high-availability/_index.md b/content/chapter-concepts/concepts-high-availability/_index.md index 1da53dd4..e3788f3f 100644 --- a/content/chapter-concepts/concepts-high-availability/_index.md +++ b/content/chapter-concepts/concepts-high-availability/_index.md @@ -4,6 +4,6 @@ weight: 1300 --- -Multiple {{% param "product.ose" %}} servers can be run in fail-over mode. The {{% param "product.ose" %}} application does not include any internal support for this, as clustering support must be implemented on the operating system level. A tool that can be used to create UNIX clusters is Heartbeat (for details, see [this page](http://www.linux-ha.org/wiki/Main_Page/)). +Multiple {{% param "product.abbrev" %}} servers can be run in fail-over mode. The {{% param "product.abbrev" %}} application does not include any internal support for this, as clustering support must be implemented on the operating system level. A tool that can be used to create UNIX clusters is Heartbeat (for details, see [this page](http://www.linux-ha.org/wiki/Main_Page/)). Starting with {{% param "product.name" %}} version 3.2, {{% param "product.abbrev" %}} clients can be configured to send the log messages to failover servers in case the primary syslog server becomes unaccessible. For details on configuring failover servers, see the description of the `failover-servers()` destination option in {{% xref "/chapter-destinations/_index.md" %}}. diff --git a/content/chapter-concepts/concepts-logging-with-syslog-ng/concepts-route-of-a-message/_index.md b/content/chapter-concepts/concepts-logging-with-syslog-ng/concepts-route-of-a-message/_index.md index de38f153..43f6d69d 100644 --- a/content/chapter-concepts/concepts-logging-with-syslog-ng/concepts-route-of-a-message/_index.md +++ b/content/chapter-concepts/concepts-logging-with-syslog-ng/concepts-route-of-a-message/_index.md @@ -7,39 +7,39 @@ weight: 100 ## Purpose: -The following procedure illustrates the route of a log message from its source on the {{% param "product.ose" %}} client to its final destination on the central {{% param "product.ose" %}} server. +The following procedure illustrates the route of a log message from its source on the {{% param "product.abbrev" %}} client to its final destination on the central {{% param "product.abbrev" %}} server. ![The route of a log message](/images/figures/fig-syslog-ng-logging-01.png) ## Steps: -1. A device or application sends a log message to a source on the {{% param "product.ose" %}} client. For example, an Apache web server running on Linux enters a message into the `/var/log/apache` file. +1. A device or application sends a log message to a source on the {{% param "product.abbrev" %}} client. For example, an Apache web server running on Linux enters a message into the `/var/log/apache` file. -2. The {{% param "product.ose" %}} client running on the web server reads the message from its `/var/log/apache` source. +2. The {{% param "product.abbrev" %}} client running on the web server reads the message from its `/var/log/apache` source. -3. The {{% param "product.ose" %}} client processes the first log statement that includes the `/var/log/apache` source. +3. The {{% param "product.abbrev" %}} client processes the first log statement that includes the `/var/log/apache` source. -4. The {{% param "product.ose" %}} client performs optional operations (message filtering, parsing, and rewriting) on the message, for example, it compares the message to the filters of the log statement (if any). If the message complies with all filter rules, {{% param "product.ose" %}} sends the message to the destinations set in the log statement, for example, to the remote {{% param "product.ose" %}} server. +4. The {{% param "product.abbrev" %}} client performs optional operations (message filtering, parsing, and rewriting) on the message, for example, it compares the message to the filters of the log statement (if any). If the message complies with all filter rules, {{% param "product.abbrev" %}} sends the message to the destinations set in the log statement, for example, to the remote {{% param "product.abbrev" %}} server. {{% alert title="Warning" color="warning" %}} Message filtering, parsing, and rewriting is performed in the order that the operations appear in the log statement. {{% /alert %}} -5. The {{% param "product.ose" %}} client processes the next log statement that includes the `/var/log/apache` source, repeating Steps 3-4. +5. The {{% param "product.abbrev" %}} client processes the next log statement that includes the `/var/log/apache` source, repeating Steps 3-4. -6. The message sent by the {{% param "product.ose" %}} client arrives from a source set in the {{% param "product.ose" %}} server. +6. The message sent by the {{% param "product.abbrev" %}} client arrives from a source set in the {{% param "product.abbrev" %}} server. -7. The {{% param "product.ose" %}} server reads the message from its source and processes the first log statement that includes that source. +7. The {{% param "product.abbrev" %}} server reads the message from its source and processes the first log statement that includes that source. -8. The {{% param "product.ose" %}} server performs optional operations (message filtering, parsing, and rewriting) on the message, for example, it compares the message to the filters of the log statement (if any). If the message complies with all filter rules, {{% param "product.ose" %}} sends the message to the destinations set in the log statement. +8. The {{% param "product.abbrev" %}} server performs optional operations (message filtering, parsing, and rewriting) on the message, for example, it compares the message to the filters of the log statement (if any). If the message complies with all filter rules, {{% param "product.abbrev" %}} sends the message to the destinations set in the log statement. {{% alert title="Warning" color="warning" %}} Message filtering, parsing, and rewriting is performed in the order that the operations appear in the log statement. {{% /alert %}} -9. The {{% param "product.ose" %}} server processes the next log statement, repeating Steps 7-9. +9. The {{% param "product.abbrev" %}} server processes the next log statement, repeating Steps 7-9. {{% alert title="Note" color="info" %}} -The {{% param "product.ose" %}} application can stop reading messages from its sources if the destinations cannot process the sent messages. This feature is called flow-control and is detailed in {{% xref "/chapter-routing-filters/concepts-flow-control/_index.md" %}}. +The {{% param "product.abbrev" %}} application can stop reading messages from its sources if the destinations cannot process the sent messages. This feature is called flow-control and is detailed in {{% xref "/chapter-routing-filters/concepts-flow-control/_index.md" %}}. {{% /alert %}} diff --git a/content/chapter-concepts/concepts-message-representation/_index.md b/content/chapter-concepts/concepts-message-representation/_index.md index fbbbf3b1..ab076bc8 100644 --- a/content/chapter-concepts/concepts-message-representation/_index.md +++ b/content/chapter-concepts/concepts-message-representation/_index.md @@ -42,7 +42,7 @@ A parsed syslog message has the following parts: - `Soft macros` - Soft macros (sometimes also called name-value pairs) are either built-in macros automatically generated from the log message (for example, ${HOST}), or custom user-created macros generated by using the {{% param "product.ose" %}} pattern database or a CSV-parser. The SDATA fields of RFC5424-formatted log messages become soft macros as well. In contrast with hard macros, soft macros are writable and can be modified within {{% param "product.abbrev" %}}, for example, using rewrite rules. + Soft macros (sometimes also called name-value pairs) are either built-in macros automatically generated from the log message (for example, ${HOST}), or custom user-created macros generated by using the {{% param "product.abbrev" %}} pattern database or a CSV-parser. The SDATA fields of RFC5424-formatted log messages become soft macros as well. In contrast with hard macros, soft macros are writable and can be modified within {{% param "product.abbrev" %}}, for example, using rewrite rules. {{% alert title="Note" color="info" %}} It is also possible to set the value of built-in soft macros using parsers, for example, to set the ${HOST} macro from the message using a column of a CSV-parser. diff --git a/content/chapter-concepts/concepts-message-structure/_index.md b/content/chapter-concepts/concepts-message-structure/_index.md index b2228d61..7c20f6d5 100644 --- a/content/chapter-concepts/concepts-message-structure/_index.md +++ b/content/chapter-concepts/concepts-message-structure/_index.md @@ -10,6 +10,6 @@ The following sections describe the structure of log messages. Currently there a - The new standard described in RFC 5424 (also called the IETF-syslog protocol): see {{% xref "/chapter-concepts/concepts-message-structure/concepts-message-ietfsyslog/_index.md" %}} - - The Enterprise-wide message model or EWMM allows you to deliver structured messages between {{% param "product.ose" %}} nodes: see {{% xref "/chapter-concepts/concepts-message-structure/syslog-ng-message-format/_index.md" %}} + - The Enterprise-wide message model or EWMM allows you to deliver structured messages between {{% param "product.abbrev" %}} nodes: see {{% xref "/chapter-concepts/concepts-message-structure/syslog-ng-message-format/_index.md" %}} - How messages are represented in {{% param "product.abbrev" %}}: see {{% xref "/chapter-concepts/concepts-message-representation/_index.md" %}}. diff --git a/content/chapter-concepts/concepts-message-structure/concepts-message-ietfsyslog/_index.md b/content/chapter-concepts/concepts-message-structure/concepts-message-ietfsyslog/_index.md index d2ef2ffd..84f1d6cf 100644 --- a/content/chapter-concepts/concepts-message-structure/concepts-message-ietfsyslog/_index.md +++ b/content/chapter-concepts/concepts-message-structure/concepts-message-ietfsyslog/_index.md @@ -166,7 +166,7 @@ The HEADER part contains the following elements: {{% alert title="Note" color="info" %}} -The {{% param "product.ose" %}} application supports other timestamp formats as well, like ISO, or the PIX extended format. The timestamp used in the IETF-syslog protocol is derived from RFC3339, which is based on ISO8601. For details, see the `ts-format()` option in {{% xref "/chapter-global-options/reference-options/_index.md" %}}. +The {{% param "product.abbrev" %}} application supports other timestamp formats as well, like ISO, or the PIX extended format. The timestamp used in the IETF-syslog protocol is derived from RFC3339, which is based on ISO8601. For details, see the `ts-format()` option in {{% xref "/chapter-global-options/reference-options/_index.md" %}}. {{% /alert %}} diff --git a/content/chapter-concepts/concepts-message-structure/syslog-ng-message-format/_index.md b/content/chapter-concepts/concepts-message-structure/syslog-ng-message-format/_index.md index 6599a945..0be56751 100644 --- a/content/chapter-concepts/concepts-message-structure/syslog-ng-message-format/_index.md +++ b/content/chapter-concepts/concepts-message-structure/syslog-ng-message-format/_index.md @@ -14,7 +14,7 @@ The message has the following parts: - The header of the complies with the [RFC5424 message format]({{< relref "/chapter-concepts/concepts-message-structure/concepts-message-ietfsyslog/_index.md" >}}), where the PROGRAM field is set to `@syslog-ng`, and the SDATA field is empty. - - The MESSAGE part is in JSON format, and contains the actual message, as well as any name-value pairs that {{% param "product.abbrev" %}} has attached to or extracted from the message. The `${._TAGS}` field contains the identifier of the {{% param "product.ose" %}} source that has originally received the message on the first {{% param "product.ose" %}} node. + - The MESSAGE part is in JSON format, and contains the actual message, as well as any name-value pairs that {{% param "product.abbrev" %}} has attached to or extracted from the message. The `${._TAGS}` field contains the identifier of the {{% param "product.abbrev" %}} source that has originally received the message on the first {{% param "product.abbrev" %}} node. To send a message in EWMM format, you can use the [`syslog-ng()` destination driver]({{< relref "/chapter-destinations/destination-syslog-ng/_index.md" >}}), or the [`format-ewmm()` template function]({{< relref "/chapter-manipulating-messages/customizing-message-format/reference-template-functions/_index.md#template-function-format-ewmm" >}}). diff --git a/content/chapter-concepts/concepts-modes-of-operation/concepts-client-mode/_index.md b/content/chapter-concepts/concepts-modes-of-operation/concepts-client-mode/_index.md index e605526b..18b6f8b5 100644 --- a/content/chapter-concepts/concepts-modes-of-operation/concepts-client-mode/_index.md +++ b/content/chapter-concepts/concepts-modes-of-operation/concepts-client-mode/_index.md @@ -6,4 +6,4 @@ weight: 100 ![Processing logs in client mode](/images/figures/fig-client_mode01.png) -In client mode, {{% param "product.ose" %}} collects the local logs generated by the host and forwards them through a network connection to the central {{% param "product.ose" %}} server or to a relay. Clients often also log the messages locally into files. +In client mode, {{% param "product.abbrev" %}} collects the local logs generated by the host and forwards them through a network connection to the central {{% param "product.abbrev" %}} server or to a relay. Clients often also log the messages locally into files. diff --git a/content/chapter-concepts/concepts-modes-of-operation/concepts-relay-mode/_index.md b/content/chapter-concepts/concepts-modes-of-operation/concepts-relay-mode/_index.md index 7bc1239c..b9c7c4b6 100644 --- a/content/chapter-concepts/concepts-modes-of-operation/concepts-relay-mode/_index.md +++ b/content/chapter-concepts/concepts-modes-of-operation/concepts-relay-mode/_index.md @@ -6,6 +6,6 @@ weight: 300 ![Processing logs in relay mode](/images/figures/fig-relay_mode01.png) -In relay mode, {{% param "product.ose" %}} receives logs through the network from {{% param "product.ose" %}} clients and forwards them to the central {{% param "product.ose" %}} server using a network connection. Relays also log the messages from the relay host into a local file, or forward these messages to the central {{% param "product.ose" %}} server. +In relay mode, {{% param "product.abbrev" %}} receives logs through the network from {{% param "product.abbrev" %}} clients and forwards them to the central {{% param "product.abbrev" %}} server using a network connection. Relays also log the messages from the relay host into a local file, or forward these messages to the central {{% param "product.abbrev" %}} server. {{% include-headless "chunk/relay-mode-uses.md" %}} diff --git a/content/chapter-concepts/concepts-modes-of-operation/concepts-server-mode/_index.md b/content/chapter-concepts/concepts-modes-of-operation/concepts-server-mode/_index.md index 38684ca2..49f6c6ce 100644 --- a/content/chapter-concepts/concepts-modes-of-operation/concepts-server-mode/_index.md +++ b/content/chapter-concepts/concepts-modes-of-operation/concepts-server-mode/_index.md @@ -6,5 +6,5 @@ weight: 500 ![Processing logs in server mode](/images/figures/fig-server_mode01.png) -In server mode, {{% param "product.ose" %}} acts as a central log-collecting server. It receives messages from {{% param "product.ose" %}} clients and relays over the network, and stores them locally in files, or passes them to other applications, for example, log analyzers. +In server mode, {{% param "product.abbrev" %}} acts as a central log-collecting server. It receives messages from {{% param "product.abbrev" %}} clients and relays over the network, and stores them locally in files, or passes them to other applications, for example, log analyzers. diff --git a/content/chapter-concepts/syslog-ng-philosophy/_index.md b/content/chapter-concepts/syslog-ng-philosophy/_index.md index b9fad0ea..fe8a1e99 100644 --- a/content/chapter-concepts/syslog-ng-philosophy/_index.md +++ b/content/chapter-concepts/syslog-ng-philosophy/_index.md @@ -4,4 +4,4 @@ weight: 100 --- -Typically, {{% param "product.ose" %}} is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server. The different devices — called {{% param "product.ose" %}} clients — all run {{% param "product.ose" %}}, and collect the log messages from the various applications, files, and other *sources*. The clients send all important log messages to the remote {{% param "product.ose" %}} server, which sorts and stores them. +Typically, {{% param "product.abbrev" %}} is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server. The different devices — called {{% param "product.abbrev" %}} clients — all run {{% param "product.abbrev" %}}, and collect the log messages from the various applications, files, and other *sources*. The clients send all important log messages to the remote {{% param "product.abbrev" %}} server, which sorts and stores them. diff --git a/content/headless/chunk/option-destination-diskbuffer.md b/content/headless/chunk/option-destination-diskbuffer.md index 79c53548..5923c5cc 100644 --- a/content/headless/chunk/option-destination-diskbuffer.md +++ b/content/headless/chunk/option-destination-diskbuffer.md @@ -14,7 +14,7 @@ *Description:* This is a required option. The maximum size of the disk-buffer in bytes. The minimum value is `1048576` bytes. If you set a smaller value, the minimum value will be used automatically. It replaces the old `log-disk-fifo-size()` option. -In {{% param "product.ose" %}} version 4.2 and earlier, this option was called `disk-buf-size()`. +In {{% param "product.abbrev" %}} version 4.2 and earlier, this option was called `disk-buf-size()`. ### compaction() @@ -42,7 +42,7 @@ Simply unsetting these name-value pairs by using the `unset()` rewrite operation {{% alert title="Note" color="info" %}} -If the `dir()` path provided by the user does not exist, {{% param "product.ose" %}} creates the path with the same permission as the running instance. +If the `dir()` path provided by the user does not exist, {{% param "product.abbrev" %}} creates the path with the same permission as the running instance. {{% /alert %}} @@ -54,7 +54,7 @@ If the `dir()` path provided by the user does not exist, {{% param "product.ose" *Description:* Use this option if the option `reliable()` is set to `yes`. This option contains the size of the messages in bytes that is used in the memory part of the disk buffer. It replaces the old `log-fifo-size()` option. It does not inherit the value of the global `log-fifo-size()` option, even if it is provided. Note that this option will be ignored if the option `reliable()` is set to `no`. -In {{% param "product.ose" %}} version 4.2 and earlier, this option was called `mem-buf-size()`. +In {{% param "product.abbrev" %}} version 4.2 and earlier, this option was called `mem-buf-size()`. ### flow-control-window-size() @@ -64,7 +64,7 @@ In {{% param "product.ose" %}} version 4.2 and earlier, this option was called ` *Description:* Use this option if the option `reliable()` is set to `no`. This option contains the number of messages stored in overflow queue. It replaces the old `log-fifo-size()` option. It inherits the value of the global `log-fifo-size()` option if provided. If it is not provided, the default value is `10000` messages. Note that this option will be ignored if the option `reliable()` is set to `yes`. -In {{% param "product.ose" %}} version 4.2 and earlier, this option was called `mem-buf-length()`. +In {{% param "product.abbrev" %}} version 4.2 and earlier, this option was called `mem-buf-length()`. ### front-cache-size() @@ -76,7 +76,7 @@ In {{% param "product.ose" %}} version 4.2 and earlier, this option was called ` Options `reliable()` and `capacity-bytes()` are required options. -In {{% param "product.ose" %}} version 4.2 and earlier, this option was called `qout-size()`. +In {{% param "product.abbrev" %}} version 4.2 and earlier, this option was called `qout-size()`. ### prealloc() {#diskbuf-prealloc} diff --git a/content/headless/chunk/relay-mode-uses.md b/content/headless/chunk/relay-mode-uses.md index 644b1ab7..ad52a78c 100644 --- a/content/headless/chunk/relay-mode-uses.md +++ b/content/headless/chunk/relay-mode-uses.md @@ -12,7 +12,7 @@ You can use a relay for many different use cases as described in the examples be Most network devices send log messages over UDP. However, UDP does not guarantee that all packets are delivered, which makes UDP unreliable. -To ensure at least a best effort level of reliability, {{% param "product.companyabbrev" %}} recommends that you deploy a relay on the network, close to the source devices. With the most reliable hops between the source and the relay, you can minimize the risk of losing UDP packets. Once the packet arrives at the relay, {{% param "product.ose" %}} ensures that the messages are delivered to the central server in a reliable manner. +To ensure at least a best effort level of reliability, {{% param "product.companyabbrev" %}} recommends that you deploy a relay on the network, close to the source devices. With the most reliable hops between the source and the relay, you can minimize the risk of losing UDP packets. Once the packet arrives at the relay, {{% param "product.abbrev" %}} ensures that the messages are delivered to the central server in a reliable manner. ## Too many source devices @@ -36,7 +36,7 @@ If you need to collect log messages from geographically remote sites or over pub - `Security`: If you trust your internal network, it is not necessary to hold encrypted connections within the LAN of the remote site as the messages can get to the relay without encryption. Messages must be sent in an encrypted way over the public WAN, and it is enough to hold only a single TCP/TLS connection between the sites, that is, between the remote relay and the central server. This eliminates the wasting of resources as holding several TLS connections directly from the clients is more costly than holding a single connection from the relay. - - `Reliability`: You can set up a main disk-buffer on the relay. The main disk-buffer is only responsible for buffering all the logs of the remote site if the central {{% param "product.ose" %}} server is temporarily unavailable. It is easier to maintain this single main disk-buffer instead of setting disk-buffers on individual client machines. + - `Reliability`: You can set up a main disk-buffer on the relay. The main disk-buffer is only responsible for buffering all the logs of the remote site if the central {{% param "product.abbrev" %}} server is temporarily unavailable. It is easier to maintain this single main disk-buffer instead of setting disk-buffers on individual client machines.