From 559cf44023d668c5541bc1526f11c7dff8a60bfc Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 17:32:05 +0200 Subject: [PATCH 01/17] Added missing descriptions: Chapter 010 Signed-off-by: mrgarris0n --- .../001_What_syslog-ng_is_not.md | 14 +++++++------- .../003_Who_uses_syslog-ng.md | 9 +++++---- .../004_Supported_platforms.md | 12 ++++++------ .../010_Introduction_to_syslog-ng/README.md | 8 ++++---- 4 files changed, 22 insertions(+), 21 deletions(-) diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md index 798c1033..0873c27a 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md @@ -1,11 +1,11 @@ --- title: What {{ site.product.short_name }} is not id: adm-intro-whatnot +description: >- + The {{ site.product.short_name }} application is not log analysis software. It can filter + log messages and select only the ones matching certain criteria. It can + even convert the messages and restructure them to a predefined format, + or parse the messages and segment them into different fields. But + {{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages, + or recognize patterns in the occurrence of different messages. --- - -The {{ site.product.short_name }} application is not log analysis software. It can filter -log messages and select only the ones matching certain criteria. It can -even convert the messages and restructure them to a predefined format, -or parse the messages and segment them into different fields. But -{{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages, -or recognize patterns in the occurrence of different messages. diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md index e01b60f6..0b12f187 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md @@ -1,12 +1,13 @@ --- title: Who uses {{ site.product.short_name }}? id: adm-intro-who +description: >- + The {{ site.product.short_name }} application is used worldwide by companies and + institutions who collect and manage the logs of several hosts, and want + to store them in a centralized, organized way. --- -The {{ site.product.short_name }} application is used worldwide by companies and -institutions who collect and manage the logs of several hosts, and want -to store them in a centralized, organized way. Using {{ site.product.short_name }} is -particularly advantageous for: +Using {{ site.product.short_name }} is particularly advantageous for: - Internet Service Providers diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md index b29e9f09..678d3c63 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md @@ -1,14 +1,14 @@ --- title: Supported platforms id: adm-intro-supp +description: >- + The {{ site.product.short_name }} application is highly + portable and is known to run on a wide range of hardware architectures + (x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating + systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS, + Cygwin, and others. --- -The {{ site.product.short_name }} application is highly -portable and is known to run on a wide range of hardware architectures -(x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating -systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS, -Cygwin, and others. - - The [[source code|gh-syslog-ng]] of {{ site.product.name }} is released under the GPLv2 license - For the available binary installation packages, see {{ site.product.name }} installation packages. diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md index 4ce98a81..519c9020 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md @@ -1,8 +1,8 @@ --- title: Introduction to syslog-ng id: adm-intro +description: >- + This chapter introduces the {{ site.product.name }} application in + a non-technical manner, discussing how and why is it useful, and the + benefits it offers to an existing IT infrastructure. --- - -This chapter introduces the {{ site.product.name }} application in -a non-technical manner, discussing how and why is it useful, and the -benefits it offers to an existing IT infrastructure. From 06d6b7d4eac1feda6292844bafebd2f268fa9131 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 17:32:25 +0200 Subject: [PATCH 02/17] Added missing descriptions: Chapter 020 Signed-off-by: mrgarris0n --- .../020_The_concepts_of_syslog-ng/003_Global_objects.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md b/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md index 4c64419d..8438466f 100644 --- a/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md +++ b/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md @@ -1,6 +1,8 @@ --- title: Global objects id: adm-conc-glob +description: >- + This section explains some basic terminology used in {{ site.product.short_name }}. --- ## Source driver From f64aa1f0c5b124beba0c26d0b8eb19fdbd06f5ae Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 17:32:44 +0200 Subject: [PATCH 03/17] Added missing descriptions: Chapter 030 Signed-off-by: mrgarris0n --- .../030_Installing_syslog-ng/001_Compiling_options.md | 2 ++ .../030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md | 2 ++ .../003_Configuring_MSSQL_server.md | 6 ++++-- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md b/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md index 35078a4d..97137d5f 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md @@ -1,6 +1,8 @@ --- title: Compiling options of {{ site.product.short_name }} id: adm-inst-compopt +description: >- + This chapter describes the compiling options of {{ site.product.short_name }}. --- When compiling {{ site.product.short_name }} from source, you can use the following diff --git a/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md b/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md index 0912d02a..1b9e8631 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md @@ -1,6 +1,8 @@ --- title: Uninstalling {{ site.product.short_name }} id: adm-inst-uninst +description: >- + This chapter gives you instructions about the uninstallation of {{ site.product.short_name }}. --- If you need to uninstall {{ site.product.short_name }} for some reason, you have the diff --git a/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md b/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md index 8d4a65a7..b438233b 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md @@ -1,14 +1,16 @@ --- -title: Configuring Microsoft SQL Server to accept logs from syslog-ng +title: Configuring Microsoft SQL Server to accept logs from {{ site.product.short_name }} short_title: Configuring MSSQL Server id: adm-inst-mssql +description: >- + This chapter explains how to configure an MSSQL Server to work with {{ site.product.short_name }}. --- {% assign crumb = page.url | split: '/' %} {% assign img_folder = crumb[-2] | prepend: '/assets/images/admin-guide/'%} Complete the following steps to configure your Microsoft SQL Server to -enable remote logins and accept log messages from syslog-ng. +enable remote logins and accept log messages from {{ site.product.short_name }}. 1. Start the SQL Server Management Studio application. Select **Start \> Programs \> Microsoft SQL Server 2005 \> SQL Server From 9f1b0eaba7b3eaff40168c6cbbe26a16a6f3839b Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 17:33:02 +0200 Subject: [PATCH 04/17] Added missing descriptions: Chapter 040 Signed-off-by: mrgarris0n --- .../000_Configuring_syslog-ng_on_client_hosts.md | 4 +++- .../001_Configuring_syslog-ng_on_server_hosts.md | 4 +++- .../000_Configuring_syslog-ng_on_relay_hosts.md | 2 ++ .../002_Configuring_syslog-ng_relays/README.md | 2 +- 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md b/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md index 81548299..16197d4e 100644 --- a/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md +++ b/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md @@ -2,9 +2,11 @@ title: Configuring {{ site.product.short_name }} on client hosts id: adm-qs-client-conf description: >- - To configure {{ site.product.short_name }} on a client host, complete the following steps. + This section explains how to configure {{ site.product.short_name }} on a client host. --- +To configure {{ site.product.short_name }} on a client host, complete the following steps. + ## Steps 1. Install the {{ site.product.short_name }} application on the host. For details diff --git a/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md b/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md index 1f288277..927061b6 100644 --- a/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md +++ b/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md @@ -2,9 +2,11 @@ title: Configuring {{ site.product.short_name }} on server hosts id: adm-qs-server-conf description: >- - To configure {{ site.product.short_name }} on a server host, complete the following steps. + This section explains how to configure {{ site.product.short_name }} on a server host. --- +To configure {{ site.product.short_name }} on a server host, complete the following steps. + ## Steps 1. Install the {{ site.product.short_name }} application on the host. For details diff --git a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md index f1bc8b0d..3faae991 100644 --- a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md +++ b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md @@ -1,6 +1,8 @@ --- title: Configuring {{ site.product.short_name }} on relay hosts id: adm-qs-relay-conf +description: >- + This section explains how to configure {{ site.product.short_name }} on a relay host. --- To configure {{ site.product.short_name }} on a relay host, complete the following steps: diff --git a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md index ffc422b3..14ee93f2 100644 --- a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md +++ b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md @@ -2,5 +2,5 @@ title: Configuring {{ site.product.short_name }} relays id: adm-qs-conf description: >- - This section describes how to configure {{ site.product.short_name }} as a relay. + This chapter describes how to configure {{ site.product.short_name }} as a relay. --- From 3a1fbcf68a0594383604f8f0d819c15ef444a3cf Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 17:33:14 +0200 Subject: [PATCH 05/17] Added missing descriptions: Chapter 050 Signed-off-by: mrgarris0n --- .../000_Location_of_the_config_file.md | 6 ++++-- .../050_The_configuration_file/001_Configuration_syntax.md | 3 +++ .../050_The_configuration_file/002_Syntax_notes.md | 3 +++ .../006_Modules_in_syslog-ng/000_Loading_modules.md | 6 ++++-- doc/_admin-guide/050_The_configuration_file/README.md | 2 ++ 5 files changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/_admin-guide/050_The_configuration_file/000_Location_of_the_config_file.md b/doc/_admin-guide/050_The_configuration_file/000_Location_of_the_config_file.md index 2e1899ca..201f7d6e 100644 --- a/doc/_admin-guide/050_The_configuration_file/000_Location_of_the_config_file.md +++ b/doc/_admin-guide/050_The_configuration_file/000_Location_of_the_config_file.md @@ -2,10 +2,12 @@ title: Location of the {{ site.product.short_name }} configuration file id: adm-conf-loc description: >- - To configure {{ site.product.short_name }}, edit the syslog-ng.conf file with any - regular text editor application. + This section describes the location of {{ site.product.short_name }} configuration file. --- +To configure {{ site.product.short_name }}, edit the syslog-ng.conf file with any +regular text editor application. + The location of the configuration file depends on how you installed {{ site.product.short_name }}. Native packages of a platform (like the ones downloaded from Linux repositories) typically place the configuration file under diff --git a/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md b/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md index 8bfbe533..3cf44337 100644 --- a/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md +++ b/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md @@ -1,6 +1,9 @@ --- title: The configuration syntax in detail id: adm-conf-syn +description: >- + This chapter describes the configuration syntax of {{ site.product.short_name }}, with configuration + examples. --- Every {{ site.product.short_name }} configuration file must begin with a line containing the diff --git a/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md b/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md index 7c45db43..2122224b 100644 --- a/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md +++ b/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md @@ -1,6 +1,9 @@ --- title: Notes about the configuration syntax id: adm-conf-syn-notes +description: >- + Things to consider when editing a {{ site.product.short_name }} + configuration file. --- When you are editing the {{ site.product.short_name }} configuration file, note the diff --git a/doc/_admin-guide/050_The_configuration_file/006_Modules_in_syslog-ng/000_Loading_modules.md b/doc/_admin-guide/050_The_configuration_file/006_Modules_in_syslog-ng/000_Loading_modules.md index cac97541..2fc2a96e 100644 --- a/doc/_admin-guide/050_The_configuration_file/006_Modules_in_syslog-ng/000_Loading_modules.md +++ b/doc/_admin-guide/050_The_configuration_file/006_Modules_in_syslog-ng/000_Loading_modules.md @@ -2,10 +2,12 @@ title: Loading modules id: adm-mod-loading description: >- - The {{ site.product.name }} application loads every available - module during startup. + This chapter describes how modules are loaded in {{ site.product.name }}. --- +The {{ site.product.name }} application loads every available +module during startup. + To load a module that is not loaded automatically, include the following statement in the {{ site.product.short_name }} configuration file: diff --git a/doc/_admin-guide/050_The_configuration_file/README.md b/doc/_admin-guide/050_The_configuration_file/README.md index 40885af1..bc879503 100644 --- a/doc/_admin-guide/050_The_configuration_file/README.md +++ b/doc/_admin-guide/050_The_configuration_file/README.md @@ -2,4 +2,6 @@ title: The {{ site.product.short_name }} configuration file short_title: The configuration file id: adm-conf-file +description: >- + This chapter describes the configuration file of {{ site.product.short_name }}, with location, syntax, examples. --- From 5d2f58cb158f480b59a03c88d0dd1d79896eb922 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 17:33:25 +0200 Subject: [PATCH 06/17] Added missing descriptions: Chapter 060 Signed-off-by: mrgarris0n --- .../000_Default-network-drivers_options.md | 4 +++- .../060_Sources/010_Internal/000_Internal_options.md | 2 ++ .../060_Sources/020_File/000_File_source_options.md | 2 ++ .../020_File/002_Notes_on_reading_kernel_messages.md | 5 +++-- .../030_Wildcard-file/000_Wildcard-file_options.md | 2 ++ .../060_Sources/040_Kubernetes/000_Kubernetes_options.md | 2 ++ .../060_Sources/050_Linux-audit/000_Linux-audit_options.md | 2 ++ .../060_Sources/060_mqtt/000_mqtt_source_prerequisites.md | 2 ++ .../060_Sources/060_mqtt/001_mqtt_source_limitations.md | 2 ++ .../060_Sources/060_mqtt/002_mqtt_source_options.md | 2 ++ .../060_Sources/070_Network/000_Network_source_options.md | 2 ++ .../060_Sources/080_nodejs/000_nodejs_options.md | 2 ++ doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md | 2 ++ .../060_Sources/100_osquery/000_osquery_source_options.md | 2 ++ .../102_OpenTelemetry/000_opentelemetry_source_options.md | 2 ++ doc/_admin-guide/060_Sources/102_OpenTelemetry/README.md | 2 +- .../060_Sources/110_Pipe/000_Pipe_source_options.md | 2 ++ doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md | 2 ++ .../060_Sources/130_Program/000_Program_source_options.md | 2 ++ .../060_Sources/140_Python/002_Python_source_options.md | 2 ++ .../060_Sources/150_snmptrap/000_snmptrap_options.md | 2 ++ .../060_Sources/160_sun-streams/000_sun-streams_options.md | 2 ++ .../060_Sources/170_Syslog/000_syslog_source_options.md | 2 ++ .../060_Sources/175_syslog-otlp/000_otlp_source_options.md | 2 ++ .../060_Sources/180_System/000_System_options.md | 2 ++ .../190_systemd-journal/000_systemd-journal_options.md | 2 ++ .../200_systemd-syslog/000_systemd-syslog_options.md | 2 ++ .../000_Convert_tcp_udp_to_network_source.md | 2 ++ .../001_unixstream_source_options.md | 2 ++ doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md | 2 ++ 30 files changed, 61 insertions(+), 4 deletions(-) diff --git a/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md b/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md index c8242731..b3d99c14 100644 --- a/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md +++ b/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md @@ -2,9 +2,11 @@ title: default-network-drivers() source options max_conn_default: 10 id: adm-src-def-netw-opt +description: >- + This section describes the options of the default-network-drivers() source in {{ site.product.short_name }}. --- -The systemd-journal() driver has the following options. +The default-network-drivers() source has the following options. {% include doc/admin-guide/options/ca-dir.md %} diff --git a/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md b/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md index db03c0a6..affd3073 100644 --- a/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md +++ b/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md @@ -2,6 +2,8 @@ title: internal() source options log_iw_size: 100 id: adm-src-int-opt +description: >- + This section describes the options of the internal() source in {{ site.product.short_name }}. --- The internal() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md b/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md index 84631c77..9bd8c8a9 100644 --- a/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md +++ b/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md @@ -1,6 +1,8 @@ --- title: file() source options id: adm-src-file-opt +description: >- + This section describes the options of the file() source in {{ site.product.short_name }}. --- The file() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md b/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md index 50d7892a..7ccf4bae 100644 --- a/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md +++ b/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md @@ -1,10 +1,11 @@ --- title: Notes on reading kernel messages id: adm-src-file-note +description: >- + This section describes things to consider when reading kernel messages from various platforms. --- -Note the following points when reading kernel messages on various -platforms. +Please note the following points: - The kernel usually sends log messages to a special file (/dev/kmsg on BSDs, /proc/kmsg on Linux). The file() driver reads log messages diff --git a/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md b/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md index 23389b68..faf9e1b2 100644 --- a/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md +++ b/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md @@ -2,6 +2,8 @@ title: wildcard-file() source options src: wildcard-file id: adm-src-wild-opt +description: >- + This section describes the options of the wildcard-file() source in {{ site.product.short_name }}. --- The wildcard-file() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md b/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md index d1f507d5..08ec5e60 100644 --- a/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md +++ b/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md @@ -1,6 +1,8 @@ --- title: kubernetes() source options id: adm-src-k8s-opt +description: >- + This section describes the options of the kubernetes() source in {{ site.product.short_name }}. --- The kubernetes() source has the following options: diff --git a/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md b/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md index 1414b1cf..034798d9 100644 --- a/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md +++ b/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md @@ -3,6 +3,8 @@ title: linux-audit() source options fn_source: 'linux-audit' fn_logs: 'Linux audit logs' id: adm-src-linux-opt +description: >- + This section describes the options of the linux-audit() source in {{ site.product.short_name }}. --- The linux-audit() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md b/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md index 4d87571b..8b097fa7 100644 --- a/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md +++ b/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md @@ -1,6 +1,8 @@ --- title: Prerequisites to using the mqtt() source id: adm-src-mqtt-pre +description: >- + In this chapter you can read about the prerequisites of using the mqtt() source in {{ site.product.short_name }}. --- Using the current implementation of the mqtt() source has the diff --git a/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md b/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md index 8565eb77..93c14d59 100644 --- a/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md +++ b/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md @@ -1,6 +1,8 @@ --- title: Limitations to using the mqtt() source id: adm-src-mqtt-lim +description: >- + In this chapter you can read about the limitations of the mqtt() source in {{ site.product.short_name }}. --- Using the mqtt() source of {{ site.product.short_name }} has the following limitations: diff --git a/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md b/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md index c0420736..3f50328d 100644 --- a/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md +++ b/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md @@ -2,6 +2,8 @@ title: Options of the mqtt() source srv: 'MQTT broker' id: adm-src-mqtt-opt +description: >- + This section describes the options of the mqtt() source in {{ site.product.short_name }}. --- The mqtt() source has the following options. diff --git a/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md b/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md index 90b3ac73..6cb8d463 100644 --- a/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md +++ b/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md @@ -1,6 +1,8 @@ --- title: network() source options id: adm-src-netw-opt +description: >- + This section describes the options of the network() source in {{ site.product.short_name }}. --- The network() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md b/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md index 53cfec05..edcc0d3a 100644 --- a/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md +++ b/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md @@ -2,6 +2,8 @@ title: nodejs() source options port_default: '9003' id: adm-src-nodejs-opt +description: >- + This section describes the options of the nodejs() source in {{ site.product.short_name }}. --- The nodejs() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md b/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md index 806c66a1..31073fb6 100644 --- a/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md +++ b/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md @@ -1,6 +1,8 @@ --- title: mbox() source options id: adm-src-mbox-opt +description: >- + This section describes the options of the mbox() source in {{ site.product.short_name }}. --- The mbox() driver has the following option. diff --git a/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md b/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md index 58d775c3..d8fcf9e9 100644 --- a/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md +++ b/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md @@ -1,6 +1,8 @@ --- title: osquery() source options id: adm-src-osquery-opt +description: >- + This section describes the options of the osquery() source in {{ site.product.short_name }}. --- The osquery() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md b/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md index f9c01d26..da2921fc 100644 --- a/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md +++ b/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md @@ -1,6 +1,8 @@ --- title: opentelemetry() source options id: adm-src-optel-opt +description: >- + This section describes the options of the opentelemetry() source in {{ site.product.short_name }}. --- The following options are available for the `opentelemetry()` source. diff --git a/doc/_admin-guide/060_Sources/102_OpenTelemetry/README.md b/doc/_admin-guide/060_Sources/102_OpenTelemetry/README.md index cfc029f0..176d3355 100644 --- a/doc/_admin-guide/060_Sources/102_OpenTelemetry/README.md +++ b/doc/_admin-guide/060_Sources/102_OpenTelemetry/README.md @@ -3,7 +3,7 @@ title: 'OpenTelemetry source' short_title: OpenTelemetry id: adm-src-optel description: >- - In syslog-ng OSE 4.3 and later versions it is possible to collect logs, metrics and traces from OpenTelemetry clients. For more information see the OpenTelemetry Protocol (OTLP/gRPC). + In {{ site.product.short_name }} 4.3 and later versions it is possible to collect logs, metrics and traces from OpenTelemetry clients. For more information see the OpenTelemetry Protocol (OTLP/gRPC). --- In the example below, an OpenTelemetry source and destination are defined. The incoming data is forwarded to a receiver. diff --git a/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md b/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md index bf916c8a..ddd5aca1 100644 --- a/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md +++ b/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md @@ -1,6 +1,8 @@ --- title: pipe() source options id: adm-src-pipe-opt +description: >- + This section describes the options of the pipe() source in {{ site.product.short_name }}. --- The pipe driver has the following options: diff --git a/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md b/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md index 111abdee..7e1d0495 100644 --- a/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md +++ b/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md @@ -1,6 +1,8 @@ --- title: pacct() options id: adm-src-pacct-opt +description: >- + This section describes the options of the pacct() source in {{ site.product.short_name }}. --- The pacct() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md b/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md index 62fd6ca0..25616d69 100644 --- a/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md +++ b/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md @@ -1,6 +1,8 @@ --- title: program() source options id: adm-src-prog-opt +description: >- + This section describes the options of the program() source in {{ site.product.short_name }}. --- {% include doc/admin-guide/options/source-flags.md %} diff --git a/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md b/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md index b991edd7..ae7d8e68 100644 --- a/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md +++ b/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md @@ -4,6 +4,8 @@ python_class: MyPythonSource class_type: source time_reopen: '1' id: adm-src-python-opt +description: >- + This section describes the options of the python() and python-fetcher() sources in {{ site.product.short_name }}. --- The python() and python-fetcher() drivers have the following options. diff --git a/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md b/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md index 54582234..412e75ee 100644 --- a/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md +++ b/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md @@ -3,6 +3,8 @@ title: snmptrap() source options fn_source: snmptrapd fn_logs: traps id: adm-src-snmp-opt +description: >- + This section describes the options of the snmptrap() source in {{ site.product.short_name }}. --- The snmptrap() driver has the following options. Only the filename() diff --git a/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md b/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md index ebb4eedf..d62e46d8 100644 --- a/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md +++ b/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md @@ -1,6 +1,8 @@ --- title: sun-streams() source options id: adm-src-sun-opt +description: >- + This section describes the options of the sun-streams() source in {{ site.product.short_name }}. --- The sun-streams() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md b/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md index ef484a2e..5346333f 100644 --- a/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md +++ b/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md @@ -1,6 +1,8 @@ --- title: syslog() source options id: adm-src-syslog-opt +description: >- + This section describes the options of the syslog() source in {{ site.product.short_name }}. --- The syslog() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md b/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md index 52950ea1..ca225158 100644 --- a/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md +++ b/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md @@ -1,6 +1,8 @@ --- title: syslog-ng-otlp() source options id: adm-src-otlp-opt +description: >- + This section describes the options of the syslog-ng-otlp() source in {{ site.product.short_name }}. --- The following options are available for the `syslog-ng-otlp()` source. diff --git a/doc/_admin-guide/060_Sources/180_System/000_System_options.md b/doc/_admin-guide/060_Sources/180_System/000_System_options.md index 17ebdbb0..bb2e3ef1 100644 --- a/doc/_admin-guide/060_Sources/180_System/000_System_options.md +++ b/doc/_admin-guide/060_Sources/180_System/000_System_options.md @@ -1,6 +1,8 @@ --- title: system() source options id: adm-src-system-opt +description: >- + This section describes the options of the system() source in {{ site.product.short_name }}. --- The system() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md b/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md index 4ee6801e..c909ed5e 100644 --- a/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md +++ b/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md @@ -4,6 +4,8 @@ facility_default: 'local0' priority_default: 'notice' src: 'systemd-journal()' id: adm-src-systemd-journal-opt +description: >- + This section describes the options of the systemd-journal() source in {{ site.product.short_name }}. --- The systemd-journal() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md b/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md index da8791fe..a4bf4f6e 100644 --- a/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md +++ b/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md @@ -1,6 +1,8 @@ --- title: systemd-syslog() source options id: adm-src-systemd-syslog +description: >- + This section describes the options of the systemd-syslog() source in {{ site.product.short_name }}. --- The systemd-syslog() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md b/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md index cfdc3a3b..706e3346 100644 --- a/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md +++ b/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md @@ -3,6 +3,8 @@ title: Change an old source driver to the network() driver dors: 'source' prefix: 's' id: adm-src-tcp-convert +description: >- + This section describes how to convert an old source driver to network() driver in {{ site.product.short_name }}. --- {% include doc/admin-guide/convert-to-network.md %} diff --git a/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md b/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md index d1d4baf8..eebfd1fd 100644 --- a/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md +++ b/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md @@ -3,6 +3,8 @@ title: unix-stream() and unix-dgram() source options max_conn_default: '256' perm: '0666' id: adm-src-unix-opt +description: >- + This section describes the options of the unix-stream() and unix-dgram() sources in {{ site.product.short_name }}. --- These two drivers behave similarly: they open an AF_UNIX socket and diff --git a/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md b/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md index 34f78f7b..a6df1502 100644 --- a/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md +++ b/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md @@ -2,6 +2,8 @@ title: stdin() source options src: 'stdin' id: adm-src-stdin-opt +description: >- + This section describes the options of the stdin() source in {{ site.product.short_name }}. --- The stdin() driver has the following options: From 821c2fe29070ccb2c6df7ab04e8fc3d6ec641441 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 18:18:30 +0200 Subject: [PATCH 07/17] Added missing descriptions: Chapter 070 Signed-off-by: mrgarris0n --- .../070_Destinations/000_amqp/000_amqp_options.md | 7 +++---- .../070_Destinations/010_collectd/000_collectd_options.md | 2 ++ .../070_Destinations/020_Discord/000_Discord_options.md | 6 +++--- .../040_File/000_File_destination_options.md | 5 +++-- .../045_Google_bigQuery/000_bigquery_dest_options.md | 4 +++- .../047_Google_PubSub/000_pubsub_dest_options.md | 2 +- .../070_Destinations/050_Graphite/000_Graphite_options.md | 2 ++ .../070_Destinations/060_Graylog/000_Graylog_options.md | 2 ++ .../070_Destinations/070_HDFS/004_hdfs_options.md | 2 ++ .../070_Destinations/080_http/000_http_options.md | 2 ++ .../090_http_nonjava/000_Batch_mode_and_load_balancing.md | 2 ++ .../090_http_nonjava/001_http_nonjava_options.md | 2 ++ .../070_Destinations/100_Kafka-c/003_Kafka-c_options.md | 2 ++ .../070_Destinations/110_Loggly/000_Loggly_options.md | 2 ++ .../120_Logmatic_io/000_Logmatic_options.md | 2 ++ .../070_Destinations/125_Loki/001_Loki_options.md | 2 ++ .../070_Destinations/130_MongoDB/001_Mongodb_options.md | 2 ++ .../140_mqtt/000_mqtt_destination_prerequisites.md | 2 ++ .../140_mqtt/001_mqtt_destination_limitations.md | 2 ++ .../140_mqtt/002_mqtt_destination_options.md | 2 ++ .../140_mqtt/003_mqtt_possible_error_messages.md | 6 +++--- .../150_Network/000_Network_destination_options.md | 2 ++ .../070_Destinations/153_OpenObserve/README.md | 2 +- .../155_opensearch/001_opensearch()-destination-options.md | 2 ++ .../000_opentelemetry-destination-options.md | 2 ++ .../070_Destinations/157_OpenTelemetry/README.md | 2 +- .../160_osquery/000_osquery_destination_options.md | 2 ++ .../170_Pipe/000_Pipe_destination_options.md | 2 ++ .../180_Program/000_Program_destination_options.md | 2 ++ .../190_Pseudofile/000_Pseudofile_options.md | 2 ++ .../070_Destinations/210_Redis/001_Redis_options.md | 2 ++ .../070_Destinations/220_Riemann/000_Riemann_options.md | 2 ++ .../225_Amazon-s3/000_amazon_s3_options.md | 2 ++ .../070_Destinations/230_Slack/000_Slack_options.md | 2 ++ .../070_Destinations/240_SMTP/000_SMTP_options.md | 2 ++ .../070_Destinations/250_snmp/001_snmp_options.md | 2 ++ .../070_Destinations/260_Splunk/000_Splunk-hec-event.md | 2 +- .../270_sql/000_Using_sql_driver_with_Oracle.md | 2 ++ .../270_sql/001_Using_sql_driver_with_MSSQL.md | 2 ++ .../000_mysql_specific_interaction_methods.md | 2 ++ .../001_mssql_specific_interaction_methods.md | 2 ++ .../070_Destinations/270_sql/002_Interaction/README.md | 2 ++ .../270_sql/003_sql_destination_options.md | 2 ++ .../070_Destinations/275_stdout/000_stdout_options.md | 3 +++ .../070_Destinations/280_Stomp/000_Stomp_options.md | 2 ++ .../290_Sumologic/003_sumologic_http_options.md | 2 ++ .../290_Sumologic/004_sumologic_syslog_options.md | 2 ++ .../300_syslog/000_syslog_destination_options.md | 2 ++ .../310_syslog-ng/000_syslog-ng_destination_options.md | 2 ++ .../315_syslog-otlp/000_otlp-destination-options.md | 2 ++ .../070_Destinations/315_syslog-otlp/README.md | 2 +- .../000_Convert_tcp_udp_to_network_destination.md | 2 ++ .../070_Destinations/330_Telegram/000_Telegram_options.md | 2 ++ .../340_unix-stream_unix-dgram/000_unixstream_options.md | 2 ++ 54 files changed, 109 insertions(+), 18 deletions(-) diff --git a/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md b/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md index eb782837..f88d89c4 100644 --- a/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md +++ b/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md @@ -2,12 +2,11 @@ title: amqp() destination options srv: 'AMQP server' port: '5672' -id: adm-dest-aqmp-opt +id: adm-dest-amqp-opt +description: >- + This section describes the options of the amqp() destination in {{ site.product.short_name }}. --- -The amqp() driver publishes messages using the AMQP (Advanced Message -Queuing Protocol). - The amqp() destination has the following options: ## auth-method() diff --git a/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md b/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md index ef146488..90cad31d 100644 --- a/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md +++ b/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md @@ -1,6 +1,8 @@ --- title: collectd() destination options id: adm-dest-collectd-opt +description: >- + This section describes the options of the collectd() destination in {{ site.product.short_name }}. --- The collectd() destination has the following options. The plugin() and diff --git a/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md b/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md index 05f18a88..945c2748 100644 --- a/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md +++ b/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md @@ -3,11 +3,11 @@ title: Discord destination options batch_timeout: 'none' throttle: '5' id: adm-dest-discord-opt +description: >- + This section describes the options of the discord() destination in {{ site.product.short_name }}. --- -The discord() destination of {{ site.product.short_name }} can directly post log -messages to web services using the HTTP protocol. The discord() -destination has the following options. +The discord() destination has the following options: ## avatar-url() diff --git a/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md b/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md index fd89b6af..6d610711 100644 --- a/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md +++ b/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md @@ -2,10 +2,11 @@ title: file() destination options d_flags: 'no-multi-line, syslog-protocol, threaded' id: adm-dest-file-opt +description: >- + This section describes the options of the file() destination in {{ site.product.short_name }}. --- -The file() driver outputs messages to the specified text file, or to a -set of files. The file() destination has the following options: +The file() destination has the following options: ![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** When creating several thousands separate log files, {{ site.product.name }} diff --git a/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md b/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md index 98f0d927..66ce2b9a 100644 --- a/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md +++ b/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md @@ -2,9 +2,11 @@ title: 'bigquery() destination options' id: adm-dest-bigquery-opt description: >- - The Google bigquery() destination has the following options. + This section describes the options of the Google bigquery() destination in {{ site.product.short_name }}. --- +The Google bigquery() destination has the following options: + {% include doc/admin-guide/options/batch-bytes.md %} {% include doc/admin-guide/options/batch-timeout.md %} diff --git a/doc/_admin-guide/070_Destinations/047_Google_PubSub/000_pubsub_dest_options.md b/doc/_admin-guide/070_Destinations/047_Google_PubSub/000_pubsub_dest_options.md index 327ac3ac..ba4b96f0 100644 --- a/doc/_admin-guide/070_Destinations/047_Google_PubSub/000_pubsub_dest_options.md +++ b/doc/_admin-guide/070_Destinations/047_Google_PubSub/000_pubsub_dest_options.md @@ -2,7 +2,7 @@ title: 'pubsub() destination options' id: adm-dest-pubsub-opt description: >- - The following options are specific to the google-pubsub() destination. + The following options are specific to the google-pubsub() destination in {{ site.product.short_name }}. --- **NOTE:** Since this destination is based on the http() destination, the HTTP destination options can also be used. The `google-pubsub()` destination automatically configures some of these `http()` destination options as required by the Google Pub/Sub AP. diff --git a/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md b/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md index 0e25633b..f54c2793 100644 --- a/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md +++ b/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md @@ -3,6 +3,8 @@ title: graphite() destination options srv: Graphite server port: '2003' id: adm-dest-graphite-opt +description: >- + This section describes the options of the graphite() destination in {{ site.product.short_name }}. --- The graphite() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md b/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md index 49c7706e..6129c984 100644 --- a/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md +++ b/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md @@ -1,6 +1,8 @@ --- title: graylog2() destination options id: adm-dest-graylog-opt +description: >- + This section describes the options of the graylog2() destination in {{ site.product.short_name }}. --- The graylog2() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md b/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md index 7427ca7f..9c3c6a5c 100644 --- a/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md +++ b/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md @@ -1,6 +1,8 @@ --- title: HDFS destination options id: adm-dest-hdfs-opt +description: >- + This section describes the options of the hdfs() destination in {{ site.product.short_name }}. --- The hdfs destination stores the log messages in files on the Hadoop diff --git a/doc/_admin-guide/070_Destinations/080_http/000_http_options.md b/doc/_admin-guide/070_Destinations/080_http/000_http_options.md index 44f0d4b5..66b61b0f 100644 --- a/doc/_admin-guide/070_Destinations/080_http/000_http_options.md +++ b/doc/_admin-guide/070_Destinations/080_http/000_http_options.md @@ -1,6 +1,8 @@ --- title: HTTP destination options id: adm-dest-http-opt +description: >- + This section describes the options of the Java-based http() destination in {{ site.product.short_name }}. --- The http destination of {{ site.product.short_name }} can directly post log messages to diff --git a/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md b/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md index b546451a..75418278 100644 --- a/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md +++ b/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md @@ -1,6 +1,8 @@ --- title: Batch mode and load balancing with HTTP id: adm-dest-http-nonjava-batch +description: >- + This section describes how to send messages to multiple URLs with {{ site.product.short_name }}. --- {% include doc/admin-guide/load-balancing.md %} diff --git a/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md b/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md index 7fef90bc..2bee7bc8 100644 --- a/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md +++ b/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md @@ -2,6 +2,8 @@ title: HTTP-nonjava destination options batch_timeout: 'none' id: adm-dest-http-nonjava-opt +description: >- + This section describes the options of the http() destination in {{ site.product.short_name }}. --- The http destination of {{ site.product.short_name }} can directly post log messages to diff --git a/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md b/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md index 5b2eb6d2..62b3af8b 100644 --- a/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md +++ b/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md @@ -1,6 +1,8 @@ --- title: "Options of the kafka() destination's C implementation" id: adm-dest-kafkac-opt +description: >- + This section describes the options of the kafka() destination in {{ site.product.short_name }}. --- The C implementation of the kafka() destination of {{ site.product.short_name }} can diff --git a/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md b/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md index 50dcefbc..a263f610 100644 --- a/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md +++ b/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md @@ -3,6 +3,8 @@ title: loggly() destination options token: 'Customer Token' provider: 'Loggly.' id: adm-dest-loggly-opt +description: >- + This section describes the options of the loggly() destination in {{ site.product.short_name }}. --- The loggly() destination has the following options. You can also set diff --git a/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md b/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md index 468e198b..5e93c6c4 100644 --- a/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md +++ b/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md @@ -3,6 +3,8 @@ title: logmatic() destination options token: 'API Key' provider: 'Logmatic.io.' id: adm-dest-logmatic-opt +description: >- + This section describes the options of the logmatic() destination in {{ site.product.short_name }}. --- The logmatic() destination has the following options. You can also set diff --git a/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md b/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md index cc4c12b3..82df28d5 100644 --- a/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md +++ b/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md @@ -1,6 +1,8 @@ --- title: loki() destination options id: adm-dest-loki-opt +description: >- + This section describes the options of the loki() destination in {{ site.product.short_name }}. --- The `loki()` driver sends messages to a Loki Grafana database and has the following options: diff --git a/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md b/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md index 0f349268..16b9a1a3 100644 --- a/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md +++ b/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md @@ -1,6 +1,8 @@ --- title: mongodb() destination options id: adm-dest-mongodb-opt +description: >- + This section describes the options of the mongodb() destination in {{ site.product.short_name }}. --- The mongodb() driver sends messages to a MongoDB database. MongoDB is a diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md b/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md index 72cbdb69..8928c15b 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md @@ -1,6 +1,8 @@ --- title: Prerequisites to using the mqtt() destination id: adm-dest-mqtt-pre +description: >- + In this chapter you can read about the prerequisites of using the mqtt() destination in {{ site.product.short_name }}. --- Using the current implementation of the mqtt() destination has the diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md b/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md index 7b1b326a..eea35ad5 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md @@ -1,6 +1,8 @@ --- title: Limitations to using the mqtt() destination id: adm-dest-mqtt-lim +description: >- + In this chapter you can read about the limitations of the mqtt() destination in {{ site.product.short_name }}. --- Using the mqtt() destination of {{ site.product.short_name }} has the following diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md b/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md index 06e4b7b6..5b4b699f 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md @@ -2,6 +2,8 @@ title: Options of the mqtt() destination srv: 'MQTT Broker' id: adm-dest-mqtt-opt +description: >- + This section describes the options of the mqtt() destination in {{ site.product.short_name }}. --- The mqtt() destination has the following options. diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md b/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md index bfc069b4..00731bd0 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md @@ -2,11 +2,11 @@ title: Possible error messages you may encounter while using the mqtt() destination short_title: Possible error messages id: adm-dest-mqtt-err +description: >- + This chapter describes issues and corresponding error messages originating from the MQTT system. --- -While using the mqtt() destination, you may encounter issues and -corresponding error messages originating from the MQTT system. The -following table contains the error messages you may encounter, the +The following table contains the error messages you may encounter, the possible reasons behind them, and potential workaround methods. diff --git a/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md b/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md index f4d72d62..15d06290 100644 --- a/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md +++ b/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md @@ -1,6 +1,8 @@ --- title: network() destination options id: adm-dest-netw-opt +description: >- + This section describes the options of the network() destination in {{ site.product.short_name }}. --- The network() driver sends messages to a remote host (for example, a diff --git a/doc/_admin-guide/070_Destinations/153_OpenObserve/README.md b/doc/_admin-guide/070_Destinations/153_OpenObserve/README.md index e168a61c..4d9ec87e 100644 --- a/doc/_admin-guide/070_Destinations/153_OpenObserve/README.md +++ b/doc/_admin-guide/070_Destinations/153_OpenObserve/README.md @@ -3,7 +3,7 @@ title: 'OpenObserve: Send messages to OpenObserve' short_title: OpenObserve id: adm-dest-opobs description: >- - In syslog-ng-OSE version 4.5 and later versions it is possible to send messages to OpenObserve using OpenObserve Log Ingestion - JSON API. This API receives multiple-record batches in JSON format. + In {{ site.product.short_name }} version 4.5 and later versions it is possible to send messages to OpenObserve using OpenObserve Log Ingestion - JSON API. This API receives multiple-record batches in JSON format. --- diff --git a/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md b/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md index 9b42608e..e375ed09 100644 --- a/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md +++ b/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md @@ -1,6 +1,8 @@ --- title: OpenSearch() destination options id: adm-dest-os-opt +description: >- + This section describes the options of the opensearch() destination in {{ site.product.short_name }}. --- diff --git a/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md b/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md index 86d84be2..d2b54ad5 100644 --- a/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md +++ b/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md @@ -1,6 +1,8 @@ --- title: opentelemetry() destination options id: adm-dest-optel-opt +description: >- + This section describes the options of the opentelemetry() destination in {{ site.product.short_name }}. --- The following options are available for the opentelemetry() destination. diff --git a/doc/_admin-guide/070_Destinations/157_OpenTelemetry/README.md b/doc/_admin-guide/070_Destinations/157_OpenTelemetry/README.md index 749db5a6..d0b7c919 100644 --- a/doc/_admin-guide/070_Destinations/157_OpenTelemetry/README.md +++ b/doc/_admin-guide/070_Destinations/157_OpenTelemetry/README.md @@ -3,7 +3,7 @@ title: 'OpenTelemetry destination' short_title: OpenTelemetry id: adm-dest-optel description: >- - In syslog-ng OSE 4.3 and later versions it is possible to send logs, metrics and traces from OpenTelemetry clients. For more information see the OpenTelemetry Protocol (OTLP/gRPC). + In {{ site.product.short_name }} 4.3 and later versions it is possible to send logs, metrics and traces from OpenTelemetry clients. For more information see the OpenTelemetry Protocol (OTLP/gRPC). --- In the example below, an OpenTelemetry source and destination are defined. It receives data and forwards it to a receiver. diff --git a/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md b/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md index b1799e8b..506ae7a1 100644 --- a/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md +++ b/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md @@ -1,6 +1,8 @@ --- title: osquery() destination options id: adm-dest-osquery-opt +description: >- + This section describes the options of the osquery() destination in {{ site.product.short_name }}. --- The osquery() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md b/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md index 2671fb59..8b5c0c92 100644 --- a/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md +++ b/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md @@ -1,6 +1,8 @@ --- title: pipe() destination options id: adm-dest-pipe-opt +description: >- + This section describes the options of the pipe() destination in {{ site.product.short_name }}. --- This driver sends messages to a named pipe like /dev/xconsole. diff --git a/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md b/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md index 2fecb5ea..a8051cff 100644 --- a/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md +++ b/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md @@ -1,6 +1,8 @@ --- title: program() destination options id: adm-dest-program-opt +description: >- + This section describes the options of the program() destination in {{ site.product.short_name }}. --- This driver starts an external application or script and sends the log diff --git a/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md b/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md index 40e0c01a..dede6b50 100644 --- a/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md +++ b/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md @@ -1,6 +1,8 @@ --- title: pseudofile() destination options id: adm-dest-pseudo-opt +description: >- + This section describes the options of the pseudofile() destination in {{ site.product.short_name }}. --- The pseudofile() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md b/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md index a72e680e..7c291fbd 100644 --- a/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md +++ b/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md @@ -3,6 +3,8 @@ title: redis() destination options srv: Redis server port: '6379' id: adm-dest-redis-opt +description: >- + This section describes the options of the redis() destination in {{ site.product.short_name }}. --- The redis() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md b/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md index db7a866f..2dd2755f 100644 --- a/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md +++ b/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md @@ -3,6 +3,8 @@ title: riemann() destination options srv: Riemann server port: '5555' id: adm-dest-riemann-opt +description: >- + This section describes the options of the riemann() destination in {{ site.product.short_name }}. --- The riemann() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md b/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md index 09bad0b3..b3eb7d1d 100644 --- a/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md +++ b/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md @@ -1,6 +1,8 @@ --- title: 'Amazon s3 options' id: adm-opt-amazon +description: >- + This section describes the options of the s3() destination in {{ site.product.short_name }}. --- The following options are specific to the s3 destination. diff --git a/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md b/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md index 4958c6ed..e367ed85 100644 --- a/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md +++ b/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md @@ -1,6 +1,8 @@ --- title: Slack destination options id: adm-dest-slack-opt +description: >- + This section describes the options of the slack() destination in {{ site.product.short_name }}. --- The slack destination of {{ site.product.short_name }} can directly post log messages diff --git a/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md b/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md index 703495f6..0ec427c8 100644 --- a/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md +++ b/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md @@ -3,6 +3,8 @@ title: smtp() destination options srv: SMTP server port: '25' id: adm-dest-smtp-opt +description: >- + This section describes the options of the smtp() destination in {{ site.product.short_name }}. --- The smtp() sends email messages using SMTP, without needing external diff --git a/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md b/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md index 8db12659..bd427c70 100644 --- a/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md +++ b/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md @@ -3,6 +3,8 @@ title: snmp() destination options srv: 'SNMP server' port: '162' id: adm-dest-snmp-opt +description: >- + This section describes the options of the snmp() destination in {{ site.product.short_name }}. --- This driver sends SNMP traps using the SNMP v2c or v3 protocol. diff --git a/doc/_admin-guide/070_Destinations/260_Splunk/000_Splunk-hec-event.md b/doc/_admin-guide/070_Destinations/260_Splunk/000_Splunk-hec-event.md index 73fccc17..de47a5e3 100644 --- a/doc/_admin-guide/070_Destinations/260_Splunk/000_Splunk-hec-event.md +++ b/doc/_admin-guide/070_Destinations/260_Splunk/000_Splunk-hec-event.md @@ -2,7 +2,7 @@ title: 'splunk-hec-event: Send log messages to Splunk HEC' id: adm-dest-splunk-hec-event description: >- - In version 4.2 and later versions it is possible to send messages to the Splunk HTTP Event Collector(HEC). + In {{ site.product.short_name }} version 4.2 and later versions it is possible to send messages to the Splunk HTTP Event Collector(HEC). --- ### Prerequisites diff --git a/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md b/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md index f2e52f8a..d9e459af 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md +++ b/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md @@ -1,6 +1,8 @@ --- title: Using the sql() driver with an Oracle database id: adm-dest-sql-oracle +description: >- + This section describes how to use sql() driver of {{ site.product.short_name }} with an Oracle database. --- The Oracle sql destination has some special aspects that are important diff --git a/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md b/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md index f2e6ed29..9d8d54a6 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md +++ b/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md @@ -1,6 +1,8 @@ --- title: Using the sql() driver with a Microsoft SQL database id: adm-dest-sql-mssql +description: >- + This section describes how to use sql() driver of {{ site.product.short_name }} with an MSSQL database. --- The mssql database driver can access Microsoft SQL (MSSQL) destinations. diff --git a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md index eaedca2f..32dfe39c 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md +++ b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md @@ -1,6 +1,8 @@ --- title: MySQL-specific interaction methods id: adm-dest-sql-interact-mysql +description: >- + This section describes the MySQL-specific interaction methods in {{ site.product.short_name }}. --- To specify the socket to use, set and export the MYSQL_UNIX_PORT diff --git a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md index 8791ffcc..2f2a3240 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md +++ b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md @@ -1,6 +1,8 @@ --- title: MSSQL-specific interaction methods id: adm-dest-sql-interact-mssql +description: >- + This section describes the MSSQL-specific interaction methods in {{ site.product.short_name }}. --- In SQL Server 2005 this restriction is lifted - kind of. The total diff --git a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md index 343a8ef5..dad51882 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md +++ b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md @@ -1,6 +1,8 @@ --- title: The way {{ site.product.short_name }} interacts with the database id: adm-dest-sql-interact +description: >- + This section describes the way {{ site.product.short_name }} interacts with the database. --- ## Used SQL operations by syslog-ng diff --git a/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md b/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md index 2045df64..de1b3db8 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md +++ b/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md @@ -3,6 +3,8 @@ title: sql() destination options srv: 'database server' port: '1433 TCP for MSSQL, 3306 TCP for MySQL, 1521 for Oracle, and 5432 TCP for PostgreSQL' id: adm-dest-sql-opt +description: >- + This section describes the options of the sql() destination in {{ site.product.short_name }}. --- This driver sends messages into an SQL database. The sql() destination diff --git a/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md b/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md index cac0dc54..514fa6e8 100644 --- a/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md +++ b/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md @@ -1,7 +1,10 @@ --- title: stdout() options id: adm-opt-stdout +description: >- + This section describes the options of the sql() destination in {{ site.product.short_name }}. --- + The following options are available for an stdout destiantion. {% include doc/admin-guide/options/destination-flags.md %} diff --git a/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md b/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md index 1ccb62e6..4e72667b 100644 --- a/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md +++ b/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md @@ -2,6 +2,8 @@ title: stomp() destination options srv: STOMP server id: adm-dest-stomp-opt +description: >- + This section describes the options of the stomp() destination in {{ site.product.short_name }}. --- The stomp() driver publishes messages using the Simple (or Streaming) diff --git a/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md b/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md index d1ef8461..56fbc847 100644 --- a/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md +++ b/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md @@ -1,6 +1,8 @@ --- title: sumologic-http() destination options id: adm-dest-sumologic-http-opt +description: >- + This section describes the options of the sumologic-http() destination in {{ site.product.short_name }}. --- diff --git a/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md b/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md index 8db66100..fd613cd2 100644 --- a/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md +++ b/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md @@ -5,6 +5,8 @@ srv: 'Sumo Logic server' token: 'Cloud Syslog Cloud Token' provider: 'Sumo Logic service' id: adm-dest-sumologic-syslog-opt +description: >- + This section describes the options of the sumologic-syslog() destination in {{ site.product.short_name }}. --- The sumologic-syslog() destination supports all diff --git a/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md b/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md index cdf8455c..f53c5f24 100644 --- a/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md +++ b/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md @@ -1,6 +1,8 @@ --- title: syslog() destination options id: adm-dest-syslog-opt +description: >- + This section describes the options of the syslog() destination in {{ site.product.short_name }}. --- The syslog() driver sends messages to a remote host (for example, a diff --git a/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md b/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md index 0464e413..539b9911 100644 --- a/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md +++ b/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md @@ -1,6 +1,8 @@ --- title: syslog-ng() destination options id: adm-dest-syslogng-opt +description: >- + This section describes the options of the syslog-ng() destination in {{ site.product.short_name }}. --- The syslog-ng() destination is a special version of the network() diff --git a/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md b/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md index 1095e522..e4575cff 100644 --- a/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md +++ b/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md @@ -1,6 +1,8 @@ --- title: syslog-ng-otlp() destination options id: adm-dest-sng-otlp-opt +description: >- + This section describes the options of the syslog-ng-otlp() destination in {{ site.product.short_name }}. --- The following options are available for the `syslog-ng-otlp()` destination. diff --git a/doc/_admin-guide/070_Destinations/315_syslog-otlp/README.md b/doc/_admin-guide/070_Destinations/315_syslog-otlp/README.md index 3b9d84a6..be97670d 100644 --- a/doc/_admin-guide/070_Destinations/315_syslog-otlp/README.md +++ b/doc/_admin-guide/070_Destinations/315_syslog-otlp/README.md @@ -3,7 +3,7 @@ title: 'syslog-ng-otlp() destination' short_title: syslog-ng-otlp id: adm-dest-sng-otlp description: >- - In syslog-ng OSE 4.4 and later versions, the syslog-ng-otlp() source and destination make it possible to transfer the internal representation of log messages between syslog-ng OSE instances, using the OpenTelemetry protocol. The syslog-ng-otlp() utilizes the OpenTelemetry protocol for efficient and reliable log message transmission instead of the traditional syslog-ng() drivers, which rely on simple TCP connections. + In {{ site.product.short_name }} 4.4 and later versions, the syslog-ng-otlp() source and destination make it possible to transfer the internal representation of log messages between {{ site.product.short_name }} instances, using the OpenTelemetry protocol. The syslog-ng-otlp() utilizes the OpenTelemetry protocol for efficient and reliable log message transmission instead of the traditional syslog-ng() drivers, which rely on simple TCP connections. --- Advantages of using `syslog-ng-otlp()`: diff --git a/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md b/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md index f8d9743b..40c30875 100644 --- a/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md +++ b/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md @@ -3,6 +3,8 @@ title: Change an old destination driver to the network() driver dors: 'destination' prefix: 'd' id: adm-dest-tcp-convert +description: >- + This section describes how to convert an old destination driver to network() driver in {{ site.product.short_name }}. --- {% include doc/admin-guide/convert-to-network.md %} diff --git a/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md b/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md index b61732b3..de4841de 100644 --- a/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md +++ b/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md @@ -1,6 +1,8 @@ --- title: telegram() destination options id: adm-dest-telegram-opt +description: >- + This section describes the options of the telegram() destination in {{ site.product.short_name }}. --- The telegram() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md b/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md index a0826e6d..67789aba 100644 --- a/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md +++ b/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md @@ -1,6 +1,8 @@ --- title: unix-stream() and unix-dgram() destination options id: adm-dest-unix-opt +description: >- + This section describes the options of the unix-stream() and unix-dgram() destinations in {{ site.product.short_name }}. --- These drivers send messages to a unix socket in either SOCK_STREAM or From a905049c1a00a0c821455ba22242408f7724f343 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 18:31:38 +0200 Subject: [PATCH 08/17] Added missing descriptions: Chapter 080 Signed-off-by: mrgarris0n --- doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md | 2 ++ .../080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md | 2 ++ .../080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md | 2 ++ .../080_Log/020_Buffering/003_Enabling_memory_buffering.md | 2 ++ .../080_Log/020_Buffering/004_About_diskbuffer_files.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/000_facility.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/001_filter.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/002_host.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/003_inlist.md | 2 ++ .../030_Filters/005_Filter_functions/004_level_priority.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/005_match.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/006_message.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/007_netmask.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/008_netmask6.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/009_program.md | 2 ++ .../030_Filters/005_Filter_functions/010_rate-limit.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/011_source.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/012_tags.md | 2 ++ .../080_Log/030_Filters/005_Filter_functions/README.md | 2 ++ doc/_admin-guide/080_Log/030_Filters/README.md | 4 ++-- doc/_admin-guide/080_Log/README.md | 2 ++ 21 files changed, 42 insertions(+), 2 deletions(-) diff --git a/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md b/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md index 48b61264..e7f99ba5 100644 --- a/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md +++ b/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md @@ -2,6 +2,8 @@ title: 'if-else-elif: Conditional expressions' short_title: if-else-elif - Conditional expressions id: adm-log-cond +description: >- + This section describes how to use conditional expressions in {{ site.product.short_name }} configs. --- You can use **if {}**, **elif {}**, and **else {}** blocks to configure diff --git a/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md b/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md index 42ba3934..bb769d3c 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md +++ b/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md @@ -1,6 +1,8 @@ --- title: Enabling reliable disk-based buffering id: adm-log-diskbuff-reliable +description: >- + This section describes how to enable reliable disk-based buffering in {{ site.product.short_name }}. --- To enable reliable disk-based buffering, use the diff --git a/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md b/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md index 6e8f820b..e76aa0b3 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md +++ b/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md @@ -1,6 +1,8 @@ --- title: Enabling normal disk-based buffering id: adm-log-diskbuff-normal +description: >- + This section describes how to enable normal disk-based buffering in {{ site.product.short_name }}. --- If the reliable() option is not set, by default a normal disk-buffer is diff --git a/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md b/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md index 041ca707..37a1273c 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md +++ b/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md @@ -1,6 +1,8 @@ --- title: Enabling memory buffering id: adm-log-diskbuff-memory +description: >- + This section describes how to enable memory buffering in {{ site.product.short_name }}. --- To enable memory buffering, use the **log-fifo-size()** parameter in the diff --git a/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md b/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md index dbb32e6f..db04c821 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md +++ b/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md @@ -1,6 +1,8 @@ --- title: About disk queue files id: adm-log-diskbuff-about +description: >- + This section describes disk queue files in {{ site.product.short_name }}. --- ## Normal and reliable queue files diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md index b371d02f..6b4ce5f8 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md @@ -1,6 +1,8 @@ --- title: facility() id: adm-log-filters-facility +description: >- + This section describes facility() filter function in {{ site.product.short_name }}. --- *Synopsis:* facility(\) or facility(\) or facility(\..\) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md index 84f7a211..106f4c33 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md @@ -1,6 +1,8 @@ --- title: filter() id: adm-log-filters-filter +description: >- + This section describes filter() filter function in {{ site.product.short_name }}. --- *Synopsis:* filter(filtername) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md index 1e0108f3..06ad90e4 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md @@ -1,6 +1,8 @@ --- title: host() id: adm-log-filters-host +description: >- + This section describes host() filter function in {{ site.product.short_name }}. --- *Synopsis:* host(regexp) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md index c30840db..4204181d 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md @@ -1,6 +1,8 @@ --- title: in-list() id: adm-log-filters-inlist +description: >- + This section describes inlist() filter function in {{ site.product.short_name }}. --- *Synopsis:* in-list(\"\\", value(\"\\")) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md index f4ad277e..5a8757ce 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md @@ -1,6 +1,8 @@ --- title: level() or priority() id: adm-log-filters-level +description: >- + This section describes level() filter function in {{ site.product.short_name }}. --- *Synopsis:* level(\) or level(\..\) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md index b5752190..4f538cec 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md @@ -1,6 +1,8 @@ --- title: match() id: adm-log-filters-match +description: >- + This section describes match() filter function in {{ site.product.short_name }}. --- *Synopsis:* match(regexp) \| match(regexp value(\"MACRO\")) \| match(regexp template(\"MACROS\")) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md index fc8aadda..c0f8d4f6 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md @@ -1,6 +1,8 @@ --- title: message() id: adm-log-filters-message +description: >- + This section describes message() filter function in {{ site.product.short_name }}. --- *Synopsis:* message(regexp) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md index 067cb4fa..c2c16439 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md @@ -1,6 +1,8 @@ --- title: netmask() id: adm-log-filters-netmask +description: >- + This section describes netmask() filter function in {{ site.product.short_name }}. --- *Synopsis:* netmask(ipv4/mask) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md index 60d6bcbd..0f616c49 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md @@ -1,6 +1,8 @@ --- title: netmask6() id: adm-log-filters-netmask6 +description: >- + This section describes netmask6() filter function in {{ site.product.short_name }}. --- *Synopsis:* netmask6(ipv6/mask) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md index de2fd161..72230272 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md @@ -1,6 +1,8 @@ --- title: program() id: adm-log-filters-program +description: >- + This section describes program() filter function in {{ site.product.short_name }}. --- *Synopsis:* program(regexp) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md index 6461c70b..d6b7e291 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md @@ -1,6 +1,8 @@ --- title: rate-limit() id: adm-log-filters-ratelimit +description: >- + This section describes rate-limit() filter function in {{ site.product.short_name }}. --- *Synopsis:* rate-limit(template(${HOST}) rate(5000)) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md index 5bb2f8f7..4d0bf0ac 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md @@ -1,6 +1,8 @@ --- title: source() id: adm-log-filters-source +description: >- + This section describes source() filter function in {{ site.product.short_name }}. --- *Synopsis:* source id diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md index dd929497..ee44dae7 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md @@ -1,6 +1,8 @@ --- title: tags() id: adm-log-filters-tags +description: >- + This section describes tags() filter function in {{ site.product.short_name }}. --- *Synopsis:* tag diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md index f1b5119f..2359b823 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md @@ -1,6 +1,8 @@ --- title: Filter functions id: adm-log-filters-functions +description: >- + This section describes filter functions in {{ site.product.short_name }}. --- The following functions may be used in the filter statement, as diff --git a/doc/_admin-guide/080_Log/030_Filters/README.md b/doc/_admin-guide/080_Log/030_Filters/README.md index 77f5d2ad..5a5d478f 100644 --- a/doc/_admin-guide/080_Log/030_Filters/README.md +++ b/doc/_admin-guide/080_Log/030_Filters/README.md @@ -1,10 +1,10 @@ --- title: Filters id: adm-log-filters +description: >- + The following sections describe how to select and filter log messages in {{ site.product.short_name }}. --- -The following sections describe how to select and filter log messages. - - Using filters describes how to configure and use filters. - Combining filters with boolean operators shows diff --git a/doc/_admin-guide/080_Log/README.md b/doc/_admin-guide/080_Log/README.md index 46aff84e..4c7a866d 100644 --- a/doc/_admin-guide/080_Log/README.md +++ b/doc/_admin-guide/080_Log/README.md @@ -2,4 +2,6 @@ title: 'log: Filter and route log messages using log paths, flags, and filters' short_title: Log - Filter and route log messages id: adm-log +description: >- + This chapter is about how to filter and route log messages with log paths, flags and filters in {{ site.product.short_name }} --- From a55954800a209ee518e5092a50b7a1ce94e0988d Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 18:33:08 +0200 Subject: [PATCH 09/17] Added missing descriptions: Chapter 090 Signed-off-by: mrgarris0n --- doc/_admin-guide/090_Global_options/000_Global_options.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/_admin-guide/090_Global_options/000_Global_options.md b/doc/_admin-guide/090_Global_options/000_Global_options.md index ca4550c8..2098c5e8 100644 --- a/doc/_admin-guide/090_Global_options/000_Global_options.md +++ b/doc/_admin-guide/090_Global_options/000_Global_options.md @@ -8,12 +8,11 @@ dir_owner: 'root' dir_perm: '-1' on_error: 'drop-message' id: adm-global-opt +description: >- + The following options can be specified in the options statement, as + described in Global options of {{ site.product.short_name }}. --- - -The following options can be specified in the options statement, as -described in Global options of {{ site.product.short_name }}. - ## bad-hostname() | Accepted values:| regular expression| From ecc6af0b80c78834dbd81dec1831acc7937d31de Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 18:35:32 +0200 Subject: [PATCH 10/17] Added missing descriptions: Chapter 100 Signed-off-by: mrgarris0n --- .../000_Configuring_TLS_client.md | 2 ++ .../001_Configuring_TLS_server.md | 2 ++ .../001_Encrypting_log_messages_with_TLS/README.md | 2 +- .../000_Configuring_mutual_TLS_client.md | 2 ++ .../001_Configuring_mutual_TLS_server.md | 2 ++ 5 files changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md index 6a63107a..2f34be23 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md @@ -1,6 +1,8 @@ --- title: Configuring TLS on the {{ site.product.short_name }} clients id: adm-tls-client-conf +description: >- + This chapter describes how to configure TLS on {{ site.product.short_name }} clients --- ## Purpose diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md index 9997dff8..f0a28b0d 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md @@ -1,6 +1,8 @@ --- title: Configuring TLS on the {{ site.product.short_name }} server id: adm-tls-server-conf +description: >- + This chapter describes how to configure TLS on {{ site.product.short_name }} servers. --- ## Purpose diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/README.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/README.md index 05b2cf52..b798bed9 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/README.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/README.md @@ -2,6 +2,6 @@ title: Encrypting log messages with TLS id: adm-tls-encrypt description: >- - This section describes how to configure TLS encryption in syslog-ng. For + This section describes how to configure TLS encryption in {{ site.product.short_name }}. For the concepts of using TLS in {{ site.product.short_name }}, see Secure logging using TLS. --- diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md index f73b58f8..29dd7d1b 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md @@ -1,6 +1,8 @@ --- title: Configuring {{ site.product.short_name }} clients with mutual authentication id: adm-tls-client-conf-mutual +description: >- + This chapter describes how to configure TLS on {{ site.product.short_name }} clients with mutual authentication. --- ## Purpose diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md index 61226aee..af7c2a35 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md @@ -1,6 +1,8 @@ --- title: Configuring {{ site.product.short_name }} servers with mutual authentication id: adm-tls-server-conf-mutual +description: >- + This chapter describes how to configure TLS on {{ site.product.short_name }} servers with mutual authentication --- ## Purpose From cce25fe9ccf3a40bb5f474d65b9c9de13c4fa02d Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Thu, 6 Jun 2024 18:40:12 +0200 Subject: [PATCH 11/17] Added missing descriptions: Chapter 110 Signed-off-by: mrgarris0n --- .../002_Date_related_macros.md | 2 ++ .../000_Customize_message_format/005_Example.md | 6 +++--- .../000_Customize_message_format/README.md | 8 ++++---- .../001_Modifying_messages/000_Replace.md | 2 ++ .../001_Modifying_messages/001_Setting_fields.md | 2 ++ .../001_Modifying_messages/005_Setting_match.md | 2 ++ .../001_Modifying_messages/012_Adding_deleting_tags.md | 2 ++ 7 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md index 5da7c5dc..ec273d07 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md +++ b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md @@ -1,6 +1,8 @@ --- title: Date-related macros id: adm-temp-date-macro +description: >- + This chapter describes the date-related macros of {{ site.product.short_name }}. --- The macros related to the date of the message (for example: ${ISODATE}, diff --git a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md index 54cf24b5..b79ba174 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md +++ b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md @@ -2,11 +2,11 @@ title: 'Example use case: using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros' short_title: Example use case id: adm-temp-example +description: >- + This section describes scenarios when One Identity recommends using the + ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros. --- -This section describes scenarios when One Identity recommends using the -${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros. - Using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros is relevant when multiple sources are configured to receive messages on the {{ site.product.short_name }} side. In this case, the hostname and IP address on the diff --git a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md index 3281e4ff..430995a5 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md +++ b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md @@ -1,11 +1,11 @@ --- title: Customize message format using macros and templates id: adm-temp-custom +description: >- + The following sections describe how to customize the names of logfiles, + and also how to use templates, macros, and template functions in {{ site.product.short_name }}. --- -The following sections describe how to customize the names of logfiles, -and also how to use templates, macros, and template functions. - - Formatting messages, filenames, directories, and tablenames explains how macros work. @@ -19,5 +19,5 @@ and also how to use templates, macros, and template functions. - Using template functions explains what template functions are and how to use them. -- Template functions of {{ site.product.short_name }} +- Template functions of {{ site.product.short_name }} lists the template functions available in {{ site.product.short_name }}. diff --git a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/000_Replace.md b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/000_Replace.md index 15189150..acf1bebb 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/000_Replace.md +++ b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/000_Replace.md @@ -1,6 +1,8 @@ --- title: Replacing message parts id: adm-temp-replace +description: >- + This section describes how to replace message parts in {{ site.product.short_name }}. --- To replace a part of the log message, you have to: diff --git a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/001_Setting_fields.md b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/001_Setting_fields.md index fd412a7a..9ee13a5c 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/001_Setting_fields.md +++ b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/001_Setting_fields.md @@ -1,6 +1,8 @@ --- title: Setting message fields to specific values id: adm-temp-set +description: >- + This section describes how to set a message field in {{ site.product.short_name }}. --- To set a field of the message to a specific value, you have to: diff --git a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/005_Setting_match.md b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/005_Setting_match.md index 7ec2c40c..d07b77ab 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/005_Setting_match.md +++ b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/005_Setting_match.md @@ -2,6 +2,8 @@ title: Setting match variables with the set-matches() rewrite rule short_title: Setting match variables id: adm-temp-match +description: >- + This section describes how to set match variables in {{ site.product.short_name }}. --- Match macros (**$1, $2, \... $255**) are temporary variables. You can diff --git a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/012_Adding_deleting_tags.md b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/012_Adding_deleting_tags.md index 4cde52f2..fcf82ed8 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/012_Adding_deleting_tags.md +++ b/doc/_admin-guide/110_Template_and_rewrite/001_Modifying_messages/012_Adding_deleting_tags.md @@ -1,6 +1,8 @@ --- title: Adding and deleting tags id: adm-temp-add-del-tag +description: >- + This section describes how to add or delete a tag in {{ site.product.short_name }}. --- To add or delete a tag, you can use rewrite rules. To add a tag, use the From b1df1f3e27e2b44d6d4420559576c1cdc1103813 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Fri, 7 Jun 2024 15:59:09 +0200 Subject: [PATCH 12/17] Added missing descriptions: Chapter 120 Signed-off-by: mrgarris0n --- .../000_Syslog_parser_options.md | 2 ++ .../000_CSV_parser_options.md | 2 ++ .../000_kv_parser_options.md | 2 ++ .../003_JSON_parser/000_JSON_parser_options.md | 2 ++ .../120_Parser/004_XML_parser/000_Limitations.md | 2 ++ .../004_XML_parser/001_XML_Parser_options.md | 2 ++ .../005_Parsing_dates/000_Date_parser_options.md | 2 ++ .../000_Apache_parser_options.md | 2 ++ .../000_Linux_audit_parser_options.md | 2 ++ doc/_admin-guide/120_Parser/010_Cisco_parser.md | 4 ++-- .../014_panos_parser/001_Panos_parser_options.md | 2 ++ .../001_PostgreSQL_parser_options.md | 2 ++ .../000_metrics_probe_options.md | 2 ++ .../000_Fortigate_parser_options.md | 2 ++ .../000_regex_parser_options.md | 2 ++ .../000_Structure_of_a_patterndb.md | 2 ++ .../001_How_pattern_matching_works.md | 2 ++ .../001_Using_pattern_databases/README.md | 2 ++ .../001_Pattern_parsers.md | 2 ++ .../002_Whatsnew_in_patterndb_v5.md | 2 ++ .../003_Creating_pattern_databases/README.md | 2 ++ .../000_ruleset/000_patterns/README.md | 7 ++----- .../000_rule/000_patterns/000_urls/README.md | 8 +++----- .../000_rule/000_patterns/001_values/README.md | 12 +++++------- .../002_examples/000_example/README.md | 6 ++---- .../000_rule/000_patterns/002_examples/README.md | 10 ++++------ .../001_rules/000_rule/000_patterns/README.md | 12 +++++------- .../000_ruleset/001_rules/000_rule/README.md | 8 +++----- .../000_ruleset/001_rules/README.md | 6 ++---- .../000_action/000_create_context/README.md | 12 +++++------- .../000_ruleset/002_actions/000_action/README.md | 8 +++----- .../000_ruleset/002_actions/README.md | 10 ++++------ .../000_patterndb/000_ruleset/003_tags/README.md | 16 +++++++--------- .../000_patterndb/000_ruleset/README.md | 8 +++----- .../000_patterndb/README.md | 6 ++---- .../120_Parser/023_db_parser/README.md | 2 ++ .../120_Parser/024_opentelemetry_parser.md | 4 ++-- 37 files changed, 96 insertions(+), 83 deletions(-) diff --git a/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md b/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md index d49ff81f..bf1b1f60 100644 --- a/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md +++ b/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md @@ -1,6 +1,8 @@ --- title: Options of syslog-parser() parsers id: adm-parser-opt +description: >- + This section describes the options of the syslog-parser() in {{ site.product.short_name }}. --- The syslog-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md b/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md index 011f6c16..db58f865 100644 --- a/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md +++ b/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md @@ -1,6 +1,8 @@ --- title: Options of CSV parsers id: adm-parser-csv-opt +description: >- + This section describes the options of the csv-parser() in {{ site.product.short_name }}. --- The csv-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md b/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md index 9f3b774d..3fac32a2 100644 --- a/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md +++ b/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md @@ -3,6 +3,8 @@ title: Options of key=value parsers parser: kv-parser prefix: kv id: adm-parser-kv-opt +description: >- + This section describes the options of the kv-parser() in {{ site.product.short_name }}. --- The kv-parser has the following options. diff --git a/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md b/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md index c79a7cef..6dc495fc 100644 --- a/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md +++ b/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md @@ -1,6 +1,8 @@ --- title: Options of JSON parsers id: adm-parser-json-opt +description: >- + This section describes the options of the json-parser() in {{ site.product.short_name }}. --- The JSON parser has the following options. diff --git a/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md b/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md index 2b5a431f..dcc75574 100644 --- a/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md +++ b/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md @@ -1,6 +1,8 @@ --- title: Limitations of the XML parsers id: adm-parser-xml-lim +description: >- + This section describes the limitations of the xml-parser() in {{ site.product.short_name }}. --- The XML parser comes with certain limitations. diff --git a/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md b/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md index 6f553c01..c4f84c87 100644 --- a/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md +++ b/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md @@ -1,6 +1,8 @@ --- title: Options of the XML parsers id: adm-parser-xml-opt +description: >- + This section describes the options of the xml-parser() in {{ site.product.short_name }}. --- ## drop-invalid() diff --git a/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md b/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md index aec96fb0..8a0a52fb 100644 --- a/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md +++ b/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md @@ -1,6 +1,8 @@ --- title: Options of date-parser() parsers id: adm-parser-date-opt +description: >- + This section describes the options of the date-parser() in {{ site.product.short_name }}. --- The date-parser() parser has the following options. diff --git a/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md b/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md index fc638581..9b214531 100644 --- a/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md +++ b/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md @@ -3,6 +3,8 @@ title: Options of apache-accesslog-parser() parsers parser: apache-accesslog prefix: apache id: adm-parser-apache-opt +description: >- + This section describes the options of the apache-accesslog-parser() in {{ site.product.short_name }}. --- {% include doc/admin-guide/options/prefix.md %} diff --git a/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md b/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md index 5626b507..3f2ee10c 100644 --- a/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md +++ b/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md @@ -3,6 +3,8 @@ title: Options of linux-audit-parser() parsers parser: linux-audit prefix: auditd id: adm-parser-linux-opt +description: >- + This section describes the options of the linux-audit-parser() in {{ site.product.short_name }}. --- The linux-audit-parser() has the following options. diff --git a/doc/_admin-guide/120_Parser/010_Cisco_parser.md b/doc/_admin-guide/120_Parser/010_Cisco_parser.md index 54e64995..bf4ef938 100644 --- a/doc/_admin-guide/120_Parser/010_Cisco_parser.md +++ b/doc/_admin-guide/120_Parser/010_Cisco_parser.md @@ -2,10 +2,10 @@ title: Cisco parser parser: cisco id: adm-parser-cisco +description: >- + The Cisco parser can parse the log messages of various Cisco devices. --- -The Cisco parser can parse the log messages of various Cisco devices. - {% include doc/admin-guide/parser-intro.md %} The parser can parse variations of the following diff --git a/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md b/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md index 9604f327..7e550dfb 100644 --- a/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md +++ b/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md @@ -1,6 +1,8 @@ --- title: PAN-OS parser options id: adm-parser-panos-opt +description: >- + This section describes the options of the panos-parser() in {{ site.product.short_name }}. --- The panos-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md b/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md index 9d17cddf..c1fc588f 100644 --- a/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md +++ b/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md @@ -1,6 +1,8 @@ --- title: PostgreSQL csvlog parser options id: adm-parser-postgresql-opt +description: >- + This section describes the options of the postgresql-csvlog-parser() in {{ site.product.short_name }}. --- The postgresql-csvlog-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md b/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md index bcfa5180..1eaab700 100644 --- a/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md +++ b/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md @@ -1,6 +1,8 @@ --- title: 'metrics-probe options' id: adm-parser-metrics-opt +description: >- + This section describes the options of the metrics-probe() parser in {{ site.product.short_name }}. --- ## increment() diff --git a/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md b/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md index 0e562911..0b071347 100644 --- a/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md +++ b/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md @@ -2,6 +2,8 @@ title: Fortigate parser options parser: fortigate id: adm-parser-fortigate-opt +description: >- + This section describes the options of the fortigate-parser() in {{ site.product.short_name }}. --- The fortigate-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md b/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md index cd6d462d..c25b15c3 100644 --- a/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md +++ b/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md @@ -1,6 +1,8 @@ --- title: Options of Regular expression parsers id: adm-parser-regexp-opt +description: >- + This section describes the options of the regexp-parser() in {{ site.product.short_name }}. --- The Regular expression parser has the following options. diff --git a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md index 1e65ab04..337e51db 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md @@ -1,6 +1,8 @@ --- title: The structure of the pattern database id: adm-parser-db-struct +description: >- + This section describes the structure of a pattern database in {{ site.product.short_name }}. --- The pattern database is organized as follows: diff --git a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md index 4170ff04..ef225bd9 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md @@ -1,6 +1,8 @@ --- title: How pattern matching works id: adm-parser-db-match +description: >- + This section describes how pattern matching works in {{ site.product.short_name }}. --- ## Figure 21: Applying patterns diff --git a/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md b/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md index 1e80d43d..719169d3 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md @@ -1,6 +1,8 @@ --- title: Using pattern databases id: adm-parser-db-patterndb +description: >- + This section describes how to use pattern databases in {{ site.product.short_name }}. --- To classify messages using a pattern database, include a db-parser() diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md index b0db9616..5b45bd28 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md @@ -1,6 +1,8 @@ --- title: Pattern parsers of {{ site.product.short_name }} id: adm-parser-db-pattern-parsers +description: >- + This section describes the pattern parsers of {{ site.product.short_name }}. --- The following parsers are available in {{ site.product.short_name }}. diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md index 6a747b68..4e56862f 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md @@ -1,6 +1,8 @@ --- title: "What's new in the {{ site.product.short_name }} pattern database format V5" id: adm-parser-db-whatsnew +description: >- + This section describes the differences of V5 and V4 pattern database format in {{ site.product.short_name }}. --- The V5 database format has the following differences compared to the V4 diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md index 5fe5a086..57d1f4a2 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md @@ -1,4 +1,6 @@ --- title: Creating pattern databases id: adm-parser-db-create +description: >- + This section describes how to create pattern databases in {{ site.product.short_name }}. --- diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md index 90161fb5..0a87fda7 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md @@ -2,17 +2,14 @@ title: 'Element: patterns container' short_title: patterns id: adm-parser-db-elem-patterns-ruleset +description: >- + A container element. A \ element may contain any number of \ elements. --- ## Location / patterndb / ruleset / patterns -## Description - -A container element. A \ element may contain any number of -\ elements. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md index 87877962..422fdda5 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md @@ -2,17 +2,15 @@ title: 'Element: urls' short_title: urls id: adm-parser-db-elem-urls +description: >- + An element containing one or more URLs referring to further + information about the patterns or the matching log messages. (optional) --- ## Location / patterndb / ruleset / rules / rule / patterns / urls -## Description - -OPTIONAL --- An element containing one or more URLs referring to further -information about the patterns or the matching log messages. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md index 515c3201..15a32b60 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md @@ -2,19 +2,17 @@ title: 'Element: values' short_title: values id: adm-parser-db-elem-values +description: >- + Name-value pairs that are assigned to messages matching the + patterns, for example, the representation of the event in the message + according to the Common Event Format (CEF) or Common Event Exchange + (CEE). The names can be used as macros to reference the assigned values. (optional) --- ## Location / patterndb / ruleset / rules / rule / patterns / values -## Description - -OPTIONAL --- Name-value pairs that are assigned to messages matching the -patterns, for example, the representation of the event in the message -according to the Common Event Format (CEF) or Common Event Exchange -(CEE). The names can be used as macros to reference the assigned values. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md index 8cd518be..240e1170 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md @@ -2,16 +2,14 @@ title: 'Element: example' short_title: example id: adm-parser-db-elem-example +description: >- + A container element for a sample log message. (optional) --- ## Location / patterndb / ruleset / rules / rule / patterns / examples / example -## Description - -OPTIONAL --- A container element for a sample log message. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md index 5dace79f..32ee8749 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md @@ -2,18 +2,16 @@ title: 'Element: examples' short_title: examples id: adm-parser-db-elem-examples +description: >- + A container element for sample log messages that should be + recognized by the pattern. These messages can be used also to test the + patterns and the parsers. (optional) --- ## Location / patterndb / ruleset / rules / rule / patterns / examples -## Description - -OPTIONAL --- A container element for sample log messages that should be -recognized by the pattern. These messages can be used also to test the -patterns and the parsers. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md index 4e11aece..784a8466 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md @@ -2,19 +2,17 @@ title: 'Element: patterns' short_title: patterns id: adm-parser-db-elem-patterns-rule +description: >- + An element containing the patterns of the rule. If a *\* + element contains multiple *\* elements, the class of the + *\* is assigned to every syslog message matching any of the + patterns. --- ## Location / patterndb / ruleset / rules / rule / patterns -## Description - -An element containing the patterns of the rule. If a *\* -element contains multiple *\* elements, the class of the -*\* is assigned to every syslog message matching any of the -patterns. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md index 9b5dd63f..a9c5096a 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md @@ -2,17 +2,15 @@ title: 'Element: rule' short_title: rule id: adm-parser-db-elem-rule +description: >- + An element containing message patterns and how a message that matches + these patterns is classified. --- ## Location / patterndb / ruleset / rules / rule -## Description - -An element containing message patterns and how a message that matches -these patterns is classified. - **NOTE:** If the following characters appear in the message, they must be escaped in the rule as follows: diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md index 5d36ae43..4fd26c28 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md @@ -2,16 +2,14 @@ title: 'Element: rules' short_title: rules id: adm-parser-db-elem-rules +description: >- + A container element for the rules of the ruleset. --- ## Location / patterndb / ruleset / rules -## Description - -A container element for the rules of the ruleset. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md index d8457e64..3dddc2ae 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md @@ -2,19 +2,17 @@ title: 'Element: create-context' short_title: create-context id: adm-parser-db-elem-create-context +description: >- + Creates a new correlation context from the current message + and its associated context. This can be used to \"split\" a context. (optional) + + Available in {{ site.product.short_name }} version 3.8 and later. --- ## Location / patterndb / ruleset / actions / action / create-context -## Description - -OPTIONAL --- Creates a new correlation context from the current message -and its associated context. This can be used to \"split\" a context. - -Available in {{ site.product.short_name }} version 3.8 and later. - ## Attributes - *context-id*: OPTIONAL --- An identifier to group related log diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md index 1074ca03..e95bbdb1 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md @@ -2,17 +2,15 @@ title: 'Element: action' short_title: action id: adm-parser-db-elem-action +description: >- + A container element describing an action that is performed + when a message matching the rule is received. (optional) --- ## Location / patterndb / ruleset / actions / action -## Description - -OPTIONAL --- A container element describing an action that is performed -when a message matching the rule is received. - ## Attributes - *condition*: A {{ site.product.short_name }} filter expression. The action is performed diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md index dfae2a63..53b9ee0e 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md @@ -2,18 +2,16 @@ title: 'Element: actions' short_title: actions id: adm-parser-db-elem-actions +description: >- + A container element for actions that are performed if a + message is recognized by the pattern. For details on actions, see + Triggering actions for identified messages. (optional) --- ## Location / patterndb / ruleset / actions -## Description - -OPTIONAL --- A container element for actions that are performed if a -message is recognized by the pattern. For details on actions, see -Triggering actions for identified messages. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md index 94df2199..76d40e27 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md @@ -2,21 +2,19 @@ title: 'Element: tags' short_title: tags id: adm-parser-db-elem-tags +description: >- + An element containing custom keywords (tags) about the + messages matching the patterns. The tags can be used to label specific + events (for example, user logons). It is also possible to filter on + these tags later (for details, see Tagging messages). Starting with + {{ site.product.name }} 3.2, the list of tags assigned to a + message can be referenced with the ${TAGS} macro. (optional) --- ## Location / patterndb / ruleset / tags -## Description - -OPTIONAL --- An element containing custom keywords (tags) about the -messages matching the patterns. The tags can be used to label specific -events (for example, user logons). It is also possible to filter on -these tags later (for details, see Tagging messages). Starting with -{{ site.product.name }} 3.2, the list of tags assigned to a -message can be referenced with the ${TAGS} macro. - ## Attributes N/A diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md index f8d77595..289ab18e 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md @@ -2,17 +2,15 @@ title: 'Element: ruleset' short_title: ruleset id: adm-parser-db-elem-ruleset +description: >- + A container element to group log patterns for an application or program. + A \ element may contain any number of \ elements. --- ## Location / patterndb / ruleset -## Description - -A container element to group log patterns for an application or program. -A \ element may contain any number of \ elements. - ## Attributes - *name*: The name of the application. Note that the function of this diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md index 6d5df82d..3c54ba88 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md @@ -2,16 +2,14 @@ title: 'Element: patterndb' short_title: patterndb id: adm-parser-db-elem-patterndb +description: >- + The container element of the pattern database. --- ## Location / patterndb -## Description - -The container element of the pattern database. - ## Attributes - *version*: The schema version of the pattern database. The current diff --git a/doc/_admin-guide/120_Parser/023_db_parser/README.md b/doc/_admin-guide/120_Parser/023_db_parser/README.md index aeab0514..2345a501 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/README.md @@ -2,6 +2,8 @@ title: 'db-parser: Process message content with a pattern database (patterndb)' short_title: db-parser id: adm-parser-db +description: >- + This chapter describes the details of the db-parser() in {{ site.product.short_name }}. --- Classifying log messages diff --git a/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md b/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md index f85c9962..0b20b6a1 100644 --- a/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md +++ b/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md @@ -2,10 +2,10 @@ title: OpenTelemetry parser parser: OpenTelemetry id: adm-parser-optel +description: >- + The {{ site.product.short_name }} application does not parse the fields of the incoming messages into name-value pairs. It is only capable of forwarding messages using the OpenTelemetry destination. To parse the fields into name-value pairs, use the `opentelemetry()` parser. --- -The syslog-ng OSE application does not parse the fields of the incoming messages into name-value pairs. It is only capable of forwarding messages using the `opentelemetry()` destination. To parse the fields into name-value pairs, use the `opentelemetry()` parser. - This parser parses the fields into name-value pairs starting with the `.otel.` prefix. * The type of the message is stored in `.otel.type`. Accepted values: From 710bce092313771b15d1b603fb5a4ae6267416d4 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Fri, 7 Jun 2024 16:07:21 +0200 Subject: [PATCH 13/17] Added missing descriptions: Chapter 130-140 Signed-off-by: mrgarris0n --- .../001_Referencing_previous_messages_grouping-by.md | 2 ++ .../002_grouping-by_options.md | 2 ++ .../002_add-contextual-data_options.md | 2 ++ ...00_Referring_to_parts_of_the_message_as_a_macro.md | 11 +++++------ .../001_Using_the_geoip2_parser.md | 2 ++ .../003_geoip2_parser_options.md | 2 ++ 6 files changed, 15 insertions(+), 6 deletions(-) diff --git a/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md b/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md index ad8be8d4..34582b4a 100644 --- a/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md +++ b/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md @@ -1,6 +1,8 @@ --- title: Referencing earlier messages of the context id: adm-cor-prev +description: >- + This chapter describes how to reference earlier messages of the context in {{ site.product.short_name }} --- When creating the aggregated message, or in the various parameters of diff --git a/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md b/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md index d4b84ed1..595b1df4 100644 --- a/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md +++ b/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md @@ -1,6 +1,8 @@ --- title: Options of grouping-by parsers id: adm-cor-grouping-by-opt +description: >- + This section describes the options of the grouping-by() parser in {{ site.product.short_name }}. --- The grouping-by has the following options. diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md index e290fc1a..45fbf04b 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md @@ -1,6 +1,8 @@ --- title: Options of add-contextual-data() id: adm-enrich-add-contextual-data-opt +description: >- + This section describes the options of add-contextual-data() in {{ site.product.short_name }}. --- The add-contextual-data() has the following options. diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md index 421f0ad3..640db088 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md @@ -1,14 +1,13 @@ --- title: Referring to parts of the message as a macro id: adm-enrich-geoip-macro +description: >- + You can refer to the separated parts of the message using the key of the + value as a macro. For example, if the message contains + KEY1=value1,KEY2=value2, you can refer to the values as ${KEY1} and ${KEY2}. --- -You can refer to the separated parts of the message using the key of the -value as a macro. For example, if the message contains -KEY1=value1,KEY2=value2, you can refer to the values as ${KEY1} and -${KEY2}. - -for example, if the default prefix (.geoip2) is used, you can determine +For example, if the default prefix (.geoip2) is used, you can determine the country code using **${.geoip2.country.iso\_code}**. To look up all keys: diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md index 4ec03bb1..577f134a 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md @@ -1,6 +1,8 @@ --- title: Using the GeoIP2 parser id: adm-enrich-geoip-using +description: >- + This section describes how to use the geoip2() parser in {{ site.product.short_name }}. --- **Declaration** diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md index 60777236..62e8d822 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md @@ -2,6 +2,8 @@ title: Options of geoip2 parsers parser: geoip2 id: adm-enrich-geoip-opt +description: >- + This section describes the options of geoip2() parser in {{ site.product.short_name }}. --- The geoip2 parser has the following options. From 6914307ed344c730e82cec9e9741f76f7e1708b7 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Fri, 7 Jun 2024 16:12:16 +0200 Subject: [PATCH 14/17] Added missing descriptions: Chapter 150-170 Signed-off-by: mrgarris0n --- .../000_Metrics_and_counters.md | 2 ++ .../004_Stopping_syslog-ng.md | 10 +++++----- .../009_Error_messages.md | 4 ++-- .../170_Troubleshooting_syslog-ng/010_SELinux.md | 2 ++ .../170_Troubleshooting_syslog-ng/README.md | 2 +- 5 files changed, 12 insertions(+), 8 deletions(-) diff --git a/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md b/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md index 3e5352dd..9b8af1a1 100644 --- a/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md +++ b/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md @@ -1,6 +1,8 @@ --- title: Metrics and counters of {{ site.product.short_name }} id: adm-stats-metrics +description: >- + This section describes how to display metrics in {{ site.product.short_name }}. --- You can list all active metrics on your {{ site.product.short_name }} host using the diff --git a/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md b/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md index ef1ba4f9..ba4c383b 100644 --- a/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md +++ b/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md @@ -1,9 +1,9 @@ --- title: Stopping syslog-ng id: adm-debug-stop +description: >- + To avoid problems, always use the init scripts to stop {{ site.product.short_name }} + (`/etc/init.d/syslog-ng stop`), instead of using the kill command. + This is especially true on Solaris and HP-UX systems, here use + `/etc/init.d/syslog stop`. --- - -To avoid problems, always use the init scripts to stop syslog-ng -(`/etc/init.d/syslog-ng stop`), instead of using the kill command. -This is especially true on Solaris and HP-UX systems, here use -`/etc/init.d/syslog stop`. diff --git a/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md b/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md index c35bf643..b6d6ca4c 100644 --- a/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md +++ b/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md @@ -1,10 +1,10 @@ --- title: Error messages id: adm-debug-err +description: >- + This section describes the most common error messages of {{ site.product.short_name }}. --- -This section describes the most common error messages. - ## Destination queue full | Error message: | Destination queue full, dropping messages; queue_len='10000', log_fifo_size='10000' count='4', persist_name='afsocket_dd_qfile(stream,serverdown:514)' | diff --git a/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md b/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md index c52da260..4374d270 100644 --- a/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md +++ b/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md @@ -2,6 +2,8 @@ title: SELinux prevents {{ site.product.short_name }} from using the execmem access on a process short_title: Using execmem prevented by SELinux id: adm-debug-selinux +description: >- + This section describes how to resolve when SELinux prevents {{ site.product.short_name }} from using the execmem access on a process. --- If you are using a recent enough PCRE library, {{ site.product.short_name }} will diff --git a/doc/_admin-guide/170_Troubleshooting_syslog-ng/README.md b/doc/_admin-guide/170_Troubleshooting_syslog-ng/README.md index d1163c70..c1f2a07b 100644 --- a/doc/_admin-guide/170_Troubleshooting_syslog-ng/README.md +++ b/doc/_admin-guide/170_Troubleshooting_syslog-ng/README.md @@ -3,7 +3,7 @@ title: Troubleshooting syslog-ng id: adm-debug description: >- This chapter provides tips and guidelines about troubleshooting problems - related to syslog-ng. + related to {{ site.product.short_name }}. --- - As a general rule, first try to log the messages to a local file. From 0eadcd43e12e4c6db356929e11576013b7b951a8 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Fri, 7 Jun 2024 16:25:57 +0200 Subject: [PATCH 15/17] Added missing descriptions: Chapter 180-200 Signed-off-by: mrgarris0n --- .../000_General_recommendations.md | 7 ++++--- .../003_Collecting_logs_from_chroot.md | 8 ++++---- .../004_Configuring_log_rotation.md | 6 ++++-- .../180_Best_practices_and_examples/README.md | 3 ++- .../190_The_syslog-ng_manual_pages/000_dqtool.md | 8 +++----- .../190_The_syslog-ng_manual_pages/001_loggen.md | 6 ++---- .../190_The_syslog-ng_manual_pages/002_pdbtool.md | 8 +++----- .../003_secure_logging_manual.md | 6 ++---- .../004_slogencrypt_manual.md | 6 ++---- .../190_The_syslog-ng_manual_pages/005_slogkey_manual.md | 6 ++---- .../006_slogverify_manual.md | 6 ++---- .../007_syslog-ng_control_tool.md | 8 +++----- .../008_syslog_debun_tool.md | 6 ++---- .../009_syslog-ng_manual.md | 6 ++---- .../190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md | 6 ++---- doc/_admin-guide/200_About/002_Glossary.md | 2 ++ 16 files changed, 41 insertions(+), 57 deletions(-) diff --git a/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md b/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md index a7f6e901..34ca2cb2 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md @@ -1,11 +1,12 @@ --- title: General recommendations id: adm-pract-general +description: >- + This section provides general tips and recommendations on using + {{ site.product.short_name }}. --- -This section provides general tips and recommendations on using -syslog-ng. Some of the recommendations are detailed in the sections -below: +Some of the recommendations are detailed in the sections below: - Do not base the separation of log messages in different files on the facility parameter. As several applications and processes can use diff --git a/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md b/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md index f47feabc..5b684ad9 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md @@ -1,12 +1,12 @@ --- title: Collecting logs from chroot id: adm-pract-chroot +description: >- + This section describes how to collect logs from a chroot using a {{ site.product.short_name }} + client running on the host. --- -## Purpose - -To collect logs from a chroot using a {{ site.product.short_name }} client running on the -host, complete the following steps: +Complete the following steps: ### Figure 23: Collecting logs from chroot diff --git a/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md b/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md index 5cbfc5b9..4dfac0ad 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md @@ -1,10 +1,12 @@ --- title: Configuring log rotation id: adm-pract-rotate +description: >- + The {{ site.product.short_name }} application does not rotate logs by itself. This chapter + describes how to use {{ site.product.short_name }} for log rotation. --- -The {{ site.product.short_name }} application does not rotate logs by itself. To use -{{ site.product.short_name }} for log rotation, consider the following approaches: +Consider the following approaches: ## Use logrotate together with {{ site.product.short_name }} diff --git a/doc/_admin-guide/180_Best_practices_and_examples/README.md b/doc/_admin-guide/180_Best_practices_and_examples/README.md index 15a6eda0..f2bcde81 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/README.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/README.md @@ -1,6 +1,7 @@ --- title: Best practices and examples id: adm-pract +description: >- + This chapter discusses some special examples and recommendations regarding {{ site.product.short_name }}. --- -This chapter discusses some special examples and recommendations. diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md index ca7da5c7..333fa604 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md @@ -2,13 +2,11 @@ title: The dqtool tool manual page app: dqtool id: adm-man-dqtool +description: >- + dqtool --- Display the contents of a disk-buffer file created with + {{ site.product.short_name }}. --- -## Name - -dqtool --- Display the contents of a disk-buffer file created with -{{ site.product.short_name }}. - ## Synopsis dqtool \[command\] \[options\] diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md index 37df1255..f5077e32 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md @@ -2,12 +2,10 @@ title: The loggen manual page app: loggen id: adm-man-loggen +description: >- + loggen --- Generate syslog messages at a specified rate --- -## Name - -loggen --- Generate syslog messages at a specified rate - ## Synopsis loggen \[options\] diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md index e54ec00b..64a89d92 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md @@ -1,13 +1,11 @@ --- title: The pdbtool manual page id: adm-man-pdbtool +description: >- + pdbtool --- An application to test and convert {{ site.product.short_name }} pattern + database rules --- -## Name - -pdbtool --- An application to test and convert {{ site.product.short_name }} pattern -database rules - ## Synopsis pdbtool \[command\] \[options\] diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md index 4f705922..c6d8a904 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md @@ -1,12 +1,10 @@ --- title: The secure-logging manual page id: adm-man-sec-log +description: >- + secure-logging --- Provides forward integrity and confidentiality for system logs. --- -## Name - -`secure-logging` --- Provides forward integrity and confidentiality for system logs. - ## Synopsis ```config diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md index a2218a74..e7c0d491 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md @@ -1,12 +1,10 @@ --- title: The slogencrypt manual page id: adm-man-slogscr +description: >- + slogencrypt --- Encrypts existing plain text log files using the {{ site.product.short_name }} secure logging environment. --- -## Name - -`slogencrypt` --- Encrypts existing plain text log files using the {{ site.product.short_name }} secure logging environment. - ## Synopsis ``` diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md index a55033e0..8e921c4b 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md @@ -1,12 +1,10 @@ --- title: The slogkey manual page id: adm-man-slogkey +description: >- + slogkey --- Manages the cryptographic keys for use with the {{ site.product.short_name }} secure logging environment. --- -## Name - -`slogkey` --- Manages the cryptographic keys for use with the {{ site.product.short_name }} secure logging environment. - ## Synopsis ``` diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md index 520a58a5..34fb4253 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md @@ -1,12 +1,10 @@ --- title: The slogverify manual page id: adm-man-slogver +description: >- + slogverify --- Verifies cryptographically secured logs. --- -## Name - -`slogverify` --- Verifies cryptographically secured logs. - ## Synopsis ``` diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md index 2073ef61..9c63886e 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md @@ -2,13 +2,11 @@ title: The {{ site.product.short_name }} control tool manual page app: syslog-ng-ctl id: adm-man-ctl +description: >- + syslog-ng-ctl --- Display message statistics and enable verbose, debug + and trace modes in {{ site.product.short_name }} --- -## Name - -syslog-ng-ctl --- Display message statistics and enable verbose, debug -and trace modes in syslog-ng PE - ## Synopsis syslog-ng-ctl \[command\] \[options\] diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md index 7e04ca81..df08c317 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md @@ -2,12 +2,10 @@ title: The syslog-debun manual page app: syslog-debun id: adm-man-debun +description: >- + syslog-debun --- syslog-ng DEBUg buNdle generator --- -## Name - -syslog-debun --- syslog-ng DEBUg buNdle generator - ## Synopsis syslog-debun \[options\] diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md index 68d30846..9dd5a231 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md @@ -1,12 +1,10 @@ --- title: The {{ site.product.short_name }} manual page id: adm-man-syslogng +description: >- + syslog-ng --- syslog-ng system logger application --- -## Name - -syslog-ng --- syslog-ng system logger application - ## Synopsis syslog-ng \[options\] diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md index 55ea0cf1..7cfed95d 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md @@ -1,12 +1,10 @@ --- title: The syslog-ng.conf manual page id: adm-man-syslogng-conf +description: >- + syslog-ng.conf --- {{ site.product.short_name }} configuration file --- -## Name - -syslog-ng.conf --- {{ site.product.short_name }} configuration file - ## Synopsis syslog-ng.conf diff --git a/doc/_admin-guide/200_About/002_Glossary.md b/doc/_admin-guide/200_About/002_Glossary.md index 469e4d31..cb12cfb7 100644 --- a/doc/_admin-guide/200_About/002_Glossary.md +++ b/doc/_admin-guide/200_About/002_Glossary.md @@ -1,6 +1,8 @@ --- title: Glossary id: adm-about-glossary +description: >- + Glossary of {{ site.product.short_name }} --- ## A From 1e19ebc04dc976aca63440f96fbca19b349ca442 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Fri, 7 Jun 2024 17:04:01 +0200 Subject: [PATCH 16/17] Replaced tabs in descriptions Signed-off-by: mrgarris0n --- _data/navigation.yml | 4 ++-- .../001_What_syslog-ng_is_not.md | 12 ++++++------ .../003_Who_uses_syslog-ng.md | 6 +++--- .../004_Supported_platforms.md | 10 +++++----- .../010_Introduction_to_syslog-ng/README.md | 6 +++--- .../003_Global_objects.md | 2 +- .../001_Compiling_options.md | 2 +- .../002_Uninstalling_syslog-ng.md | 2 +- .../003_Configuring_MSSQL_server.md | 2 +- .../000_Configuring_syslog-ng_on_client_hosts.md | 2 +- .../001_Configuring_syslog-ng_on_server_hosts.md | 2 +- .../000_Configuring_syslog-ng_on_relay_hosts.md | 2 +- .../001_Configuration_syntax.md | 4 ++-- .../050_The_configuration_file/002_Syntax_notes.md | 4 ++-- .../050_The_configuration_file/README.md | 2 +- .../000_Default-network-drivers_options.md | 2 +- .../060_Sources/010_Internal/000_Internal_options.md | 2 +- .../060_Sources/020_File/000_File_source_options.md | 2 +- .../020_File/002_Notes_on_reading_kernel_messages.md | 2 +- .../030_Wildcard-file/000_Wildcard-file_options.md | 2 +- .../040_Kubernetes/000_Kubernetes_options.md | 2 +- .../050_Linux-audit/000_Linux-audit_options.md | 2 +- .../060_mqtt/000_mqtt_source_prerequisites.md | 2 +- .../060_mqtt/001_mqtt_source_limitations.md | 2 +- .../060_Sources/060_mqtt/002_mqtt_source_options.md | 2 +- .../070_Network/000_Network_source_options.md | 2 +- .../060_Sources/080_nodejs/000_nodejs_options.md | 2 +- .../060_Sources/090_mbox/000_mbox_options.md | 2 +- .../100_osquery/000_osquery_source_options.md | 2 +- .../000_opentelemetry_source_options.md | 2 +- .../060_Sources/110_Pipe/000_Pipe_source_options.md | 2 +- .../060_Sources/120_pacct/000_pacct_options.md | 2 +- .../130_Program/000_Program_source_options.md | 2 +- .../140_Python/002_Python_source_options.md | 2 +- .../060_Sources/150_snmptrap/000_snmptrap_options.md | 2 +- .../160_sun-streams/000_sun-streams_options.md | 2 +- .../170_Syslog/000_syslog_source_options.md | 2 +- .../175_syslog-otlp/000_otlp_source_options.md | 2 +- .../060_Sources/180_System/000_System_options.md | 2 +- .../000_systemd-journal_options.md | 2 +- .../200_systemd-syslog/000_systemd-syslog_options.md | 2 +- .../000_Convert_tcp_udp_to_network_source.md | 2 +- .../001_unixstream_source_options.md | 2 +- .../060_Sources/230_stdin/000_stdin_options.md | 2 +- .../070_Destinations/000_amqp/000_amqp_options.md | 2 +- .../010_collectd/000_collectd_options.md | 2 +- .../020_Discord/000_Discord_options.md | 2 +- .../040_File/000_File_destination_options.md | 2 +- .../045_Google_bigQuery/000_bigquery_dest_options.md | 2 +- .../050_Graphite/000_Graphite_options.md | 2 +- .../060_Graylog/000_Graylog_options.md | 2 +- .../070_Destinations/070_HDFS/004_hdfs_options.md | 2 +- .../070_Destinations/080_http/000_http_options.md | 2 +- .../000_Batch_mode_and_load_balancing.md | 2 +- .../090_http_nonjava/001_http_nonjava_options.md | 2 +- .../100_Kafka-c/003_Kafka-c_options.md | 2 +- .../110_Loggly/000_Loggly_options.md | 2 +- .../120_Logmatic_io/000_Logmatic_options.md | 2 +- .../070_Destinations/125_Loki/001_Loki_options.md | 2 +- .../130_MongoDB/001_Mongodb_options.md | 2 +- .../140_mqtt/000_mqtt_destination_prerequisites.md | 2 +- .../140_mqtt/001_mqtt_destination_limitations.md | 2 +- .../140_mqtt/002_mqtt_destination_options.md | 2 +- .../140_mqtt/003_mqtt_possible_error_messages.md | 2 +- .../150_Network/000_Network_destination_options.md | 2 +- .../001_opensearch()-destination-options.md | 2 +- .../000_opentelemetry-destination-options.md | 2 +- .../160_osquery/000_osquery_destination_options.md | 2 +- .../170_Pipe/000_Pipe_destination_options.md | 2 +- .../180_Program/000_Program_destination_options.md | 2 +- .../190_Pseudofile/000_Pseudofile_options.md | 2 +- .../070_Destinations/210_Redis/001_Redis_options.md | 2 +- .../220_Riemann/000_Riemann_options.md | 2 +- .../225_Amazon-s3/000_amazon_s3_options.md | 2 +- .../070_Destinations/230_Slack/000_Slack_options.md | 2 +- .../070_Destinations/240_SMTP/000_SMTP_options.md | 2 +- .../070_Destinations/250_snmp/001_snmp_options.md | 2 +- .../270_sql/000_Using_sql_driver_with_Oracle.md | 2 +- .../270_sql/001_Using_sql_driver_with_MSSQL.md | 2 +- .../000_mysql_specific_interaction_methods.md | 2 +- .../001_mssql_specific_interaction_methods.md | 2 +- .../270_sql/002_Interaction/README.md | 2 +- .../270_sql/003_sql_destination_options.md | 2 +- .../275_stdout/000_stdout_options.md | 2 +- .../070_Destinations/280_Stomp/000_Stomp_options.md | 2 +- .../290_Sumologic/003_sumologic_http_options.md | 2 +- .../290_Sumologic/004_sumologic_syslog_options.md | 2 +- .../300_syslog/000_syslog_destination_options.md | 2 +- .../000_syslog-ng_destination_options.md | 2 +- .../315_syslog-otlp/000_otlp-destination-options.md | 2 +- .../000_Convert_tcp_udp_to_network_destination.md | 2 +- .../330_Telegram/000_Telegram_options.md | 2 +- .../000_unixstream_options.md | 2 +- .../080_Log/000_Log_paths/001_if_else_elif.md | 2 +- .../000_Enabling_reliable_diskbuffer.md | 2 +- .../020_Buffering/001_Enabling_normal_diskbuffer.md | 2 +- .../020_Buffering/003_Enabling_memory_buffering.md | 2 +- .../020_Buffering/004_About_diskbuffer_files.md | 2 +- .../030_Filters/005_Filter_functions/000_facility.md | 2 +- .../030_Filters/005_Filter_functions/001_filter.md | 2 +- .../030_Filters/005_Filter_functions/002_host.md | 2 +- .../030_Filters/005_Filter_functions/003_inlist.md | 2 +- .../005_Filter_functions/004_level_priority.md | 2 +- .../030_Filters/005_Filter_functions/005_match.md | 2 +- .../030_Filters/005_Filter_functions/006_message.md | 2 +- .../030_Filters/005_Filter_functions/007_netmask.md | 2 +- .../030_Filters/005_Filter_functions/008_netmask6.md | 2 +- .../030_Filters/005_Filter_functions/009_program.md | 2 +- .../005_Filter_functions/010_rate-limit.md | 2 +- .../030_Filters/005_Filter_functions/011_source.md | 2 +- .../030_Filters/005_Filter_functions/012_tags.md | 2 +- .../030_Filters/005_Filter_functions/README.md | 2 +- doc/_admin-guide/080_Log/030_Filters/README.md | 2 +- doc/_admin-guide/080_Log/README.md | 2 +- .../090_Global_options/000_Global_options.md | 4 ++-- .../000_Configuring_TLS_client.md | 2 +- .../001_Configuring_TLS_server.md | 2 +- .../000_Configuring_mutual_TLS_client.md | 2 +- .../001_Configuring_mutual_TLS_server.md | 2 +- .../002_Date_related_macros.md | 2 +- .../000_Customize_message_format/005_Example.md | 4 ++-- .../000_Customize_message_format/README.md | 4 ++-- .../000_Syslog_parser_options.md | 2 +- .../000_CSV_parser_options.md | 2 +- .../000_kv_parser_options.md | 2 +- .../003_JSON_parser/000_JSON_parser_options.md | 2 +- .../120_Parser/004_XML_parser/000_Limitations.md | 2 +- .../004_XML_parser/001_XML_Parser_options.md | 2 +- .../005_Parsing_dates/000_Date_parser_options.md | 2 +- .../000_Apache_parser_options.md | 2 +- .../000_Linux_audit_parser_options.md | 2 +- doc/_admin-guide/120_Parser/010_Cisco_parser.md | 2 +- .../014_panos_parser/001_Panos_parser_options.md | 2 +- .../001_PostgreSQL_parser_options.md | 2 +- .../000_metrics_probe_options.md | 2 +- .../000_Fortigate_parser_options.md | 2 +- .../022_regexp_parser/000_regex_parser_options.md | 2 +- .../000_Structure_of_a_patterndb.md | 2 +- .../001_How_pattern_matching_works.md | 2 +- .../001_Using_pattern_databases/README.md | 2 +- .../001_Pattern_parsers.md | 2 +- .../002_Whatsnew_in_patterndb_v5.md | 2 +- .../003_Creating_pattern_databases/README.md | 2 +- .../000_patterndb/000_ruleset/000_patterns/README.md | 2 +- .../000_rule/000_patterns/000_urls/README.md | 4 ++-- .../000_rule/000_patterns/001_values/README.md | 8 ++++---- .../000_patterns/002_examples/000_example/README.md | 2 +- .../000_rule/000_patterns/002_examples/README.md | 6 +++--- .../001_rules/000_rule/000_patterns/README.md | 8 ++++---- .../000_ruleset/001_rules/000_rule/README.md | 4 ++-- .../000_patterndb/000_ruleset/001_rules/README.md | 2 +- .../000_action/000_create_context/README.md | 6 +++--- .../000_ruleset/002_actions/000_action/README.md | 4 ++-- .../000_patterndb/000_ruleset/002_actions/README.md | 6 +++--- .../000_patterndb/000_ruleset/003_tags/README.md | 12 ++++++------ .../000_patterndb/000_ruleset/README.md | 4 ++-- .../000_patterndb/README.md | 2 +- doc/_admin-guide/120_Parser/023_db_parser/README.md | 2 +- .../120_Parser/024_opentelemetry_parser.md | 2 +- .../001_Referencing_previous_messages_grouping-by.md | 2 +- .../002_grouping-by_options.md | 2 +- .../002_add-contextual-data_options.md | 2 +- ...0_Referring_to_parts_of_the_message_as_a_macro.md | 6 +++--- .../001_Using_the_geoip2_parser.md | 2 +- .../003_geoip2_parser_options.md | 2 +- .../000_Metrics_and_counters.md | 2 +- .../004_Stopping_syslog-ng.md | 8 ++++---- .../009_Error_messages.md | 2 +- .../170_Troubleshooting_syslog-ng/010_SELinux.md | 2 +- .../000_General_recommendations.md | 4 ++-- .../003_Collecting_logs_from_chroot.md | 4 ++-- .../004_Configuring_log_rotation.md | 4 ++-- .../180_Best_practices_and_examples/README.md | 2 +- .../190_The_syslog-ng_manual_pages/000_dqtool.md | 4 ++-- .../190_The_syslog-ng_manual_pages/001_loggen.md | 4 ++-- .../190_The_syslog-ng_manual_pages/002_pdbtool.md | 4 ++-- .../003_secure_logging_manual.md | 2 +- .../004_slogencrypt_manual.md | 2 +- .../005_slogkey_manual.md | 2 +- .../006_slogverify_manual.md | 2 +- .../007_syslog-ng_control_tool.md | 4 ++-- .../008_syslog_debun_tool.md | 2 +- .../009_syslog-ng_manual.md | 2 +- .../010_syslog-ng_conf.md | 2 +- doc/_admin-guide/200_About/002_Glossary.md | 2 +- 185 files changed, 237 insertions(+), 237 deletions(-) diff --git a/_data/navigation.yml b/_data/navigation.yml index d5da1bbd..938cf057 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -836,13 +836,13 @@ admin-guide-nav: url: /admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options - title: "Sudo parser" url: /admin-guide/120_Parser/015_sudo_parser + - title: "MariaDB parser" + url: /admin-guide/120_Parser/016_mariadb_parser - title: "PostgreSQL parser" url: /admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/README subnav: - title: "PostgreSQL csvlog parser options" url: /admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options - - title: "MariaDB parser" - url: /admin-guide/120_Parser/016_mariadb_parser - title: "metrics-probe()" url: /admin-guide/120_Parser/017_metrics_probe_parser/README subnav: diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md index 0873c27a..be7082b8 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md @@ -2,10 +2,10 @@ title: What {{ site.product.short_name }} is not id: adm-intro-whatnot description: >- - The {{ site.product.short_name }} application is not log analysis software. It can filter - log messages and select only the ones matching certain criteria. It can - even convert the messages and restructure them to a predefined format, - or parse the messages and segment them into different fields. But - {{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages, - or recognize patterns in the occurrence of different messages. + The {{ site.product.short_name }} application is not log analysis software. It can filter + log messages and select only the ones matching certain criteria. It can + even convert the messages and restructure them to a predefined format, + or parse the messages and segment them into different fields. But + {{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages, + or recognize patterns in the occurrence of different messages. --- diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md index 0b12f187..8bdbd802 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md @@ -2,9 +2,9 @@ title: Who uses {{ site.product.short_name }}? id: adm-intro-who description: >- - The {{ site.product.short_name }} application is used worldwide by companies and - institutions who collect and manage the logs of several hosts, and want - to store them in a centralized, organized way. + The {{ site.product.short_name }} application is used worldwide by companies and + institutions who collect and manage the logs of several hosts, and want + to store them in a centralized, organized way. --- Using {{ site.product.short_name }} is particularly advantageous for: diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md index 678d3c63..6b19cd3b 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md @@ -2,11 +2,11 @@ title: Supported platforms id: adm-intro-supp description: >- - The {{ site.product.short_name }} application is highly - portable and is known to run on a wide range of hardware architectures - (x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating - systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS, - Cygwin, and others. + The {{ site.product.short_name }} application is highly + portable and is known to run on a wide range of hardware architectures + (x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating + systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS, + Cygwin, and others. --- - The [[source code|gh-syslog-ng]] of {{ site.product.name }} is released under the GPLv2 license diff --git a/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md b/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md index 519c9020..f808ed95 100644 --- a/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md +++ b/doc/_admin-guide/010_Introduction_to_syslog-ng/README.md @@ -2,7 +2,7 @@ title: Introduction to syslog-ng id: adm-intro description: >- - This chapter introduces the {{ site.product.name }} application in - a non-technical manner, discussing how and why is it useful, and the - benefits it offers to an existing IT infrastructure. + This chapter introduces the {{ site.product.name }} application in + a non-technical manner, discussing how and why is it useful, and the + benefits it offers to an existing IT infrastructure. --- diff --git a/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md b/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md index 8438466f..335e9b79 100644 --- a/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md +++ b/doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md @@ -2,7 +2,7 @@ title: Global objects id: adm-conc-glob description: >- - This section explains some basic terminology used in {{ site.product.short_name }}. + This section explains some basic terminology used in {{ site.product.short_name }}. --- ## Source driver diff --git a/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md b/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md index 97137d5f..db74e225 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md @@ -2,7 +2,7 @@ title: Compiling options of {{ site.product.short_name }} id: adm-inst-compopt description: >- - This chapter describes the compiling options of {{ site.product.short_name }}. + This chapter describes the compiling options of {{ site.product.short_name }}. --- When compiling {{ site.product.short_name }} from source, you can use the following diff --git a/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md b/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md index 1b9e8631..9807a061 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md @@ -2,7 +2,7 @@ title: Uninstalling {{ site.product.short_name }} id: adm-inst-uninst description: >- - This chapter gives you instructions about the uninstallation of {{ site.product.short_name }}. + This chapter gives you instructions about the uninstallation of {{ site.product.short_name }}. --- If you need to uninstall {{ site.product.short_name }} for some reason, you have the diff --git a/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md b/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md index b438233b..a39f8c7a 100644 --- a/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md +++ b/doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md @@ -3,7 +3,7 @@ title: Configuring Microsoft SQL Server to accept logs from {{ site.product.shor short_title: Configuring MSSQL Server id: adm-inst-mssql description: >- - This chapter explains how to configure an MSSQL Server to work with {{ site.product.short_name }}. + This chapter explains how to configure an MSSQL Server to work with {{ site.product.short_name }}. --- {% assign crumb = page.url | split: '/' %} diff --git a/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md b/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md index 16197d4e..27cdf541 100644 --- a/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md +++ b/doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md @@ -2,7 +2,7 @@ title: Configuring {{ site.product.short_name }} on client hosts id: adm-qs-client-conf description: >- - This section explains how to configure {{ site.product.short_name }} on a client host. + This section explains how to configure {{ site.product.short_name }} on a client host. --- To configure {{ site.product.short_name }} on a client host, complete the following steps. diff --git a/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md b/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md index 927061b6..808161db 100644 --- a/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md +++ b/doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md @@ -2,7 +2,7 @@ title: Configuring {{ site.product.short_name }} on server hosts id: adm-qs-server-conf description: >- - This section explains how to configure {{ site.product.short_name }} on a server host. + This section explains how to configure {{ site.product.short_name }} on a server host. --- To configure {{ site.product.short_name }} on a server host, complete the following steps. diff --git a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md index 3faae991..4cadbe28 100644 --- a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md +++ b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md @@ -2,7 +2,7 @@ title: Configuring {{ site.product.short_name }} on relay hosts id: adm-qs-relay-conf description: >- - This section explains how to configure {{ site.product.short_name }} on a relay host. + This section explains how to configure {{ site.product.short_name }} on a relay host. --- To configure {{ site.product.short_name }} on a relay host, complete the following steps: diff --git a/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md b/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md index 3cf44337..628018e8 100644 --- a/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md +++ b/doc/_admin-guide/050_The_configuration_file/001_Configuration_syntax.md @@ -2,8 +2,8 @@ title: The configuration syntax in detail id: adm-conf-syn description: >- - This chapter describes the configuration syntax of {{ site.product.short_name }}, with configuration - examples. + This chapter describes the configuration syntax of {{ site.product.short_name }}, with configuration + examples. --- Every {{ site.product.short_name }} configuration file must begin with a line containing the diff --git a/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md b/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md index 2122224b..c16e945a 100644 --- a/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md +++ b/doc/_admin-guide/050_The_configuration_file/002_Syntax_notes.md @@ -2,8 +2,8 @@ title: Notes about the configuration syntax id: adm-conf-syn-notes description: >- - Things to consider when editing a {{ site.product.short_name }} - configuration file. + Things to consider when editing a {{ site.product.short_name }} + configuration file. --- When you are editing the {{ site.product.short_name }} configuration file, note the diff --git a/doc/_admin-guide/050_The_configuration_file/README.md b/doc/_admin-guide/050_The_configuration_file/README.md index bc879503..f75fc1c4 100644 --- a/doc/_admin-guide/050_The_configuration_file/README.md +++ b/doc/_admin-guide/050_The_configuration_file/README.md @@ -3,5 +3,5 @@ title: The {{ site.product.short_name }} configuration file short_title: The configuration file id: adm-conf-file description: >- - This chapter describes the configuration file of {{ site.product.short_name }}, with location, syntax, examples. + This chapter describes the configuration file of {{ site.product.short_name }}, with location, syntax, examples. --- diff --git a/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md b/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md index b3d99c14..e265ff35 100644 --- a/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md +++ b/doc/_admin-guide/060_Sources/000_Default-network-drivers/000_Default-network-drivers_options.md @@ -3,7 +3,7 @@ title: default-network-drivers() source options max_conn_default: 10 id: adm-src-def-netw-opt description: >- - This section describes the options of the default-network-drivers() source in {{ site.product.short_name }}. + This section describes the options of the default-network-drivers() source in {{ site.product.short_name }}. --- The default-network-drivers() source has the following options. diff --git a/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md b/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md index affd3073..18b68003 100644 --- a/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md +++ b/doc/_admin-guide/060_Sources/010_Internal/000_Internal_options.md @@ -3,7 +3,7 @@ title: internal() source options log_iw_size: 100 id: adm-src-int-opt description: >- - This section describes the options of the internal() source in {{ site.product.short_name }}. + This section describes the options of the internal() source in {{ site.product.short_name }}. --- The internal() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md b/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md index 9bd8c8a9..efe5fef1 100644 --- a/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md +++ b/doc/_admin-guide/060_Sources/020_File/000_File_source_options.md @@ -2,7 +2,7 @@ title: file() source options id: adm-src-file-opt description: >- - This section describes the options of the file() source in {{ site.product.short_name }}. + This section describes the options of the file() source in {{ site.product.short_name }}. --- The file() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md b/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md index 7ccf4bae..8b6ecacb 100644 --- a/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md +++ b/doc/_admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages.md @@ -2,7 +2,7 @@ title: Notes on reading kernel messages id: adm-src-file-note description: >- - This section describes things to consider when reading kernel messages from various platforms. + This section describes things to consider when reading kernel messages from various platforms. --- Please note the following points: diff --git a/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md b/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md index faf9e1b2..22abcafd 100644 --- a/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md +++ b/doc/_admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options.md @@ -3,7 +3,7 @@ title: wildcard-file() source options src: wildcard-file id: adm-src-wild-opt description: >- - This section describes the options of the wildcard-file() source in {{ site.product.short_name }}. + This section describes the options of the wildcard-file() source in {{ site.product.short_name }}. --- The wildcard-file() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md b/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md index 08ec5e60..177ed2be 100644 --- a/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md +++ b/doc/_admin-guide/060_Sources/040_Kubernetes/000_Kubernetes_options.md @@ -2,7 +2,7 @@ title: kubernetes() source options id: adm-src-k8s-opt description: >- - This section describes the options of the kubernetes() source in {{ site.product.short_name }}. + This section describes the options of the kubernetes() source in {{ site.product.short_name }}. --- The kubernetes() source has the following options: diff --git a/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md b/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md index 034798d9..83ea812b 100644 --- a/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md +++ b/doc/_admin-guide/060_Sources/050_Linux-audit/000_Linux-audit_options.md @@ -4,7 +4,7 @@ fn_source: 'linux-audit' fn_logs: 'Linux audit logs' id: adm-src-linux-opt description: >- - This section describes the options of the linux-audit() source in {{ site.product.short_name }}. + This section describes the options of the linux-audit() source in {{ site.product.short_name }}. --- The linux-audit() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md b/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md index 8b097fa7..c73845e2 100644 --- a/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md +++ b/doc/_admin-guide/060_Sources/060_mqtt/000_mqtt_source_prerequisites.md @@ -2,7 +2,7 @@ title: Prerequisites to using the mqtt() source id: adm-src-mqtt-pre description: >- - In this chapter you can read about the prerequisites of using the mqtt() source in {{ site.product.short_name }}. + In this chapter you can read about the prerequisites of using the mqtt() source in {{ site.product.short_name }}. --- Using the current implementation of the mqtt() source has the diff --git a/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md b/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md index 93c14d59..542abcfe 100644 --- a/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md +++ b/doc/_admin-guide/060_Sources/060_mqtt/001_mqtt_source_limitations.md @@ -2,7 +2,7 @@ title: Limitations to using the mqtt() source id: adm-src-mqtt-lim description: >- - In this chapter you can read about the limitations of the mqtt() source in {{ site.product.short_name }}. + In this chapter you can read about the limitations of the mqtt() source in {{ site.product.short_name }}. --- Using the mqtt() source of {{ site.product.short_name }} has the following limitations: diff --git a/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md b/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md index 3f50328d..f75425b1 100644 --- a/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md +++ b/doc/_admin-guide/060_Sources/060_mqtt/002_mqtt_source_options.md @@ -3,7 +3,7 @@ title: Options of the mqtt() source srv: 'MQTT broker' id: adm-src-mqtt-opt description: >- - This section describes the options of the mqtt() source in {{ site.product.short_name }}. + This section describes the options of the mqtt() source in {{ site.product.short_name }}. --- The mqtt() source has the following options. diff --git a/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md b/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md index 6cb8d463..abee7aca 100644 --- a/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md +++ b/doc/_admin-guide/060_Sources/070_Network/000_Network_source_options.md @@ -2,7 +2,7 @@ title: network() source options id: adm-src-netw-opt description: >- - This section describes the options of the network() source in {{ site.product.short_name }}. + This section describes the options of the network() source in {{ site.product.short_name }}. --- The network() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md b/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md index edcc0d3a..040cba88 100644 --- a/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md +++ b/doc/_admin-guide/060_Sources/080_nodejs/000_nodejs_options.md @@ -3,7 +3,7 @@ title: nodejs() source options port_default: '9003' id: adm-src-nodejs-opt description: >- - This section describes the options of the nodejs() source in {{ site.product.short_name }}. + This section describes the options of the nodejs() source in {{ site.product.short_name }}. --- The nodejs() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md b/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md index 31073fb6..b7211592 100644 --- a/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md +++ b/doc/_admin-guide/060_Sources/090_mbox/000_mbox_options.md @@ -2,7 +2,7 @@ title: mbox() source options id: adm-src-mbox-opt description: >- - This section describes the options of the mbox() source in {{ site.product.short_name }}. + This section describes the options of the mbox() source in {{ site.product.short_name }}. --- The mbox() driver has the following option. diff --git a/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md b/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md index d8fcf9e9..6928fd91 100644 --- a/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md +++ b/doc/_admin-guide/060_Sources/100_osquery/000_osquery_source_options.md @@ -2,7 +2,7 @@ title: osquery() source options id: adm-src-osquery-opt description: >- - This section describes the options of the osquery() source in {{ site.product.short_name }}. + This section describes the options of the osquery() source in {{ site.product.short_name }}. --- The osquery() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md b/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md index da2921fc..d53631a8 100644 --- a/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md +++ b/doc/_admin-guide/060_Sources/102_OpenTelemetry/000_opentelemetry_source_options.md @@ -2,7 +2,7 @@ title: opentelemetry() source options id: adm-src-optel-opt description: >- - This section describes the options of the opentelemetry() source in {{ site.product.short_name }}. + This section describes the options of the opentelemetry() source in {{ site.product.short_name }}. --- The following options are available for the `opentelemetry()` source. diff --git a/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md b/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md index ddd5aca1..daac1c01 100644 --- a/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md +++ b/doc/_admin-guide/060_Sources/110_Pipe/000_Pipe_source_options.md @@ -2,7 +2,7 @@ title: pipe() source options id: adm-src-pipe-opt description: >- - This section describes the options of the pipe() source in {{ site.product.short_name }}. + This section describes the options of the pipe() source in {{ site.product.short_name }}. --- The pipe driver has the following options: diff --git a/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md b/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md index 7e1d0495..699748d9 100644 --- a/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md +++ b/doc/_admin-guide/060_Sources/120_pacct/000_pacct_options.md @@ -2,7 +2,7 @@ title: pacct() options id: adm-src-pacct-opt description: >- - This section describes the options of the pacct() source in {{ site.product.short_name }}. + This section describes the options of the pacct() source in {{ site.product.short_name }}. --- The pacct() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md b/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md index 25616d69..81d4edbf 100644 --- a/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md +++ b/doc/_admin-guide/060_Sources/130_Program/000_Program_source_options.md @@ -2,7 +2,7 @@ title: program() source options id: adm-src-prog-opt description: >- - This section describes the options of the program() source in {{ site.product.short_name }}. + This section describes the options of the program() source in {{ site.product.short_name }}. --- {% include doc/admin-guide/options/source-flags.md %} diff --git a/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md b/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md index ae7d8e68..ebe0df1c 100644 --- a/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md +++ b/doc/_admin-guide/060_Sources/140_Python/002_Python_source_options.md @@ -5,7 +5,7 @@ class_type: source time_reopen: '1' id: adm-src-python-opt description: >- - This section describes the options of the python() and python-fetcher() sources in {{ site.product.short_name }}. + This section describes the options of the python() and python-fetcher() sources in {{ site.product.short_name }}. --- The python() and python-fetcher() drivers have the following options. diff --git a/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md b/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md index 412e75ee..618ba2ec 100644 --- a/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md +++ b/doc/_admin-guide/060_Sources/150_snmptrap/000_snmptrap_options.md @@ -4,7 +4,7 @@ fn_source: snmptrapd fn_logs: traps id: adm-src-snmp-opt description: >- - This section describes the options of the snmptrap() source in {{ site.product.short_name }}. + This section describes the options of the snmptrap() source in {{ site.product.short_name }}. --- The snmptrap() driver has the following options. Only the filename() diff --git a/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md b/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md index d62e46d8..57c04588 100644 --- a/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md +++ b/doc/_admin-guide/060_Sources/160_sun-streams/000_sun-streams_options.md @@ -2,7 +2,7 @@ title: sun-streams() source options id: adm-src-sun-opt description: >- - This section describes the options of the sun-streams() source in {{ site.product.short_name }}. + This section describes the options of the sun-streams() source in {{ site.product.short_name }}. --- The sun-streams() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md b/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md index 5346333f..5c9d7c2f 100644 --- a/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md +++ b/doc/_admin-guide/060_Sources/170_Syslog/000_syslog_source_options.md @@ -2,7 +2,7 @@ title: syslog() source options id: adm-src-syslog-opt description: >- - This section describes the options of the syslog() source in {{ site.product.short_name }}. + This section describes the options of the syslog() source in {{ site.product.short_name }}. --- The syslog() driver has the following options. diff --git a/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md b/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md index ca225158..7c3b1d72 100644 --- a/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md +++ b/doc/_admin-guide/060_Sources/175_syslog-otlp/000_otlp_source_options.md @@ -2,7 +2,7 @@ title: syslog-ng-otlp() source options id: adm-src-otlp-opt description: >- - This section describes the options of the syslog-ng-otlp() source in {{ site.product.short_name }}. + This section describes the options of the syslog-ng-otlp() source in {{ site.product.short_name }}. --- The following options are available for the `syslog-ng-otlp()` source. diff --git a/doc/_admin-guide/060_Sources/180_System/000_System_options.md b/doc/_admin-guide/060_Sources/180_System/000_System_options.md index bb2e3ef1..37ce3f9a 100644 --- a/doc/_admin-guide/060_Sources/180_System/000_System_options.md +++ b/doc/_admin-guide/060_Sources/180_System/000_System_options.md @@ -2,7 +2,7 @@ title: system() source options id: adm-src-system-opt description: >- - This section describes the options of the system() source in {{ site.product.short_name }}. + This section describes the options of the system() source in {{ site.product.short_name }}. --- The system() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md b/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md index c909ed5e..e5cb6776 100644 --- a/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md +++ b/doc/_admin-guide/060_Sources/190_systemd-journal/000_systemd-journal_options.md @@ -5,7 +5,7 @@ priority_default: 'notice' src: 'systemd-journal()' id: adm-src-systemd-journal-opt description: >- - This section describes the options of the systemd-journal() source in {{ site.product.short_name }}. + This section describes the options of the systemd-journal() source in {{ site.product.short_name }}. --- The systemd-journal() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md b/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md index a4bf4f6e..1c8a9d48 100644 --- a/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md +++ b/doc/_admin-guide/060_Sources/200_systemd-syslog/000_systemd-syslog_options.md @@ -2,7 +2,7 @@ title: systemd-syslog() source options id: adm-src-systemd-syslog description: >- - This section describes the options of the systemd-syslog() source in {{ site.product.short_name }}. + This section describes the options of the systemd-syslog() source in {{ site.product.short_name }}. --- The systemd-syslog() driver has the following options: diff --git a/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md b/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md index 706e3346..6faaddb7 100644 --- a/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md +++ b/doc/_admin-guide/060_Sources/210_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_source.md @@ -4,7 +4,7 @@ dors: 'source' prefix: 's' id: adm-src-tcp-convert description: >- - This section describes how to convert an old source driver to network() driver in {{ site.product.short_name }}. + This section describes how to convert an old source driver to network() driver in {{ site.product.short_name }}. --- {% include doc/admin-guide/convert-to-network.md %} diff --git a/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md b/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md index eebfd1fd..ce2b5398 100644 --- a/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md +++ b/doc/_admin-guide/060_Sources/220_unix-stream_unix-dgram/001_unixstream_source_options.md @@ -4,7 +4,7 @@ max_conn_default: '256' perm: '0666' id: adm-src-unix-opt description: >- - This section describes the options of the unix-stream() and unix-dgram() sources in {{ site.product.short_name }}. + This section describes the options of the unix-stream() and unix-dgram() sources in {{ site.product.short_name }}. --- These two drivers behave similarly: they open an AF_UNIX socket and diff --git a/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md b/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md index a6df1502..bdf48d3a 100644 --- a/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md +++ b/doc/_admin-guide/060_Sources/230_stdin/000_stdin_options.md @@ -3,7 +3,7 @@ title: stdin() source options src: 'stdin' id: adm-src-stdin-opt description: >- - This section describes the options of the stdin() source in {{ site.product.short_name }}. + This section describes the options of the stdin() source in {{ site.product.short_name }}. --- The stdin() driver has the following options: diff --git a/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md b/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md index f88d89c4..83a23788 100644 --- a/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md +++ b/doc/_admin-guide/070_Destinations/000_amqp/000_amqp_options.md @@ -4,7 +4,7 @@ srv: 'AMQP server' port: '5672' id: adm-dest-amqp-opt description: >- - This section describes the options of the amqp() destination in {{ site.product.short_name }}. + This section describes the options of the amqp() destination in {{ site.product.short_name }}. --- The amqp() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md b/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md index 90cad31d..66b1d93b 100644 --- a/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md +++ b/doc/_admin-guide/070_Destinations/010_collectd/000_collectd_options.md @@ -2,7 +2,7 @@ title: collectd() destination options id: adm-dest-collectd-opt description: >- - This section describes the options of the collectd() destination in {{ site.product.short_name }}. + This section describes the options of the collectd() destination in {{ site.product.short_name }}. --- The collectd() destination has the following options. The plugin() and diff --git a/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md b/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md index 945c2748..20524db9 100644 --- a/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md +++ b/doc/_admin-guide/070_Destinations/020_Discord/000_Discord_options.md @@ -4,7 +4,7 @@ batch_timeout: 'none' throttle: '5' id: adm-dest-discord-opt description: >- - This section describes the options of the discord() destination in {{ site.product.short_name }}. + This section describes the options of the discord() destination in {{ site.product.short_name }}. --- The discord() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md b/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md index 6d610711..9ca27c2c 100644 --- a/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md +++ b/doc/_admin-guide/070_Destinations/040_File/000_File_destination_options.md @@ -3,7 +3,7 @@ title: file() destination options d_flags: 'no-multi-line, syslog-protocol, threaded' id: adm-dest-file-opt description: >- - This section describes the options of the file() destination in {{ site.product.short_name }}. + This section describes the options of the file() destination in {{ site.product.short_name }}. --- The file() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md b/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md index 66ce2b9a..5549cf6f 100644 --- a/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md +++ b/doc/_admin-guide/070_Destinations/045_Google_bigQuery/000_bigquery_dest_options.md @@ -2,7 +2,7 @@ title: 'bigquery() destination options' id: adm-dest-bigquery-opt description: >- - This section describes the options of the Google bigquery() destination in {{ site.product.short_name }}. + This section describes the options of the Google bigquery() destination in {{ site.product.short_name }}. --- The Google bigquery() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md b/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md index f54c2793..f70eaa09 100644 --- a/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md +++ b/doc/_admin-guide/070_Destinations/050_Graphite/000_Graphite_options.md @@ -4,7 +4,7 @@ srv: Graphite server port: '2003' id: adm-dest-graphite-opt description: >- - This section describes the options of the graphite() destination in {{ site.product.short_name }}. + This section describes the options of the graphite() destination in {{ site.product.short_name }}. --- The graphite() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md b/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md index 6129c984..1020b2ff 100644 --- a/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md +++ b/doc/_admin-guide/070_Destinations/060_Graylog/000_Graylog_options.md @@ -2,7 +2,7 @@ title: graylog2() destination options id: adm-dest-graylog-opt description: >- - This section describes the options of the graylog2() destination in {{ site.product.short_name }}. + This section describes the options of the graylog2() destination in {{ site.product.short_name }}. --- The graylog2() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md b/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md index 9c3c6a5c..ebab7edc 100644 --- a/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md +++ b/doc/_admin-guide/070_Destinations/070_HDFS/004_hdfs_options.md @@ -2,7 +2,7 @@ title: HDFS destination options id: adm-dest-hdfs-opt description: >- - This section describes the options of the hdfs() destination in {{ site.product.short_name }}. + This section describes the options of the hdfs() destination in {{ site.product.short_name }}. --- The hdfs destination stores the log messages in files on the Hadoop diff --git a/doc/_admin-guide/070_Destinations/080_http/000_http_options.md b/doc/_admin-guide/070_Destinations/080_http/000_http_options.md index 66b61b0f..3b560081 100644 --- a/doc/_admin-guide/070_Destinations/080_http/000_http_options.md +++ b/doc/_admin-guide/070_Destinations/080_http/000_http_options.md @@ -2,7 +2,7 @@ title: HTTP destination options id: adm-dest-http-opt description: >- - This section describes the options of the Java-based http() destination in {{ site.product.short_name }}. + This section describes the options of the Java-based http() destination in {{ site.product.short_name }}. --- The http destination of {{ site.product.short_name }} can directly post log messages to diff --git a/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md b/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md index 75418278..b83433ad 100644 --- a/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md +++ b/doc/_admin-guide/070_Destinations/090_http_nonjava/000_Batch_mode_and_load_balancing.md @@ -2,7 +2,7 @@ title: Batch mode and load balancing with HTTP id: adm-dest-http-nonjava-batch description: >- - This section describes how to send messages to multiple URLs with {{ site.product.short_name }}. + This section describes how to send messages to multiple URLs with {{ site.product.short_name }}. --- {% include doc/admin-guide/load-balancing.md %} diff --git a/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md b/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md index 2bee7bc8..1d279d48 100644 --- a/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md +++ b/doc/_admin-guide/070_Destinations/090_http_nonjava/001_http_nonjava_options.md @@ -3,7 +3,7 @@ title: HTTP-nonjava destination options batch_timeout: 'none' id: adm-dest-http-nonjava-opt description: >- - This section describes the options of the http() destination in {{ site.product.short_name }}. + This section describes the options of the http() destination in {{ site.product.short_name }}. --- The http destination of {{ site.product.short_name }} can directly post log messages to diff --git a/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md b/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md index 62b3af8b..4ccf901d 100644 --- a/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md +++ b/doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md @@ -2,7 +2,7 @@ title: "Options of the kafka() destination's C implementation" id: adm-dest-kafkac-opt description: >- - This section describes the options of the kafka() destination in {{ site.product.short_name }}. + This section describes the options of the kafka() destination in {{ site.product.short_name }}. --- The C implementation of the kafka() destination of {{ site.product.short_name }} can diff --git a/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md b/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md index a263f610..9986c239 100644 --- a/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md +++ b/doc/_admin-guide/070_Destinations/110_Loggly/000_Loggly_options.md @@ -4,7 +4,7 @@ token: 'Customer Token' provider: 'Loggly.' id: adm-dest-loggly-opt description: >- - This section describes the options of the loggly() destination in {{ site.product.short_name }}. + This section describes the options of the loggly() destination in {{ site.product.short_name }}. --- The loggly() destination has the following options. You can also set diff --git a/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md b/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md index 5e93c6c4..624b00a4 100644 --- a/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md +++ b/doc/_admin-guide/070_Destinations/120_Logmatic_io/000_Logmatic_options.md @@ -4,7 +4,7 @@ token: 'API Key' provider: 'Logmatic.io.' id: adm-dest-logmatic-opt description: >- - This section describes the options of the logmatic() destination in {{ site.product.short_name }}. + This section describes the options of the logmatic() destination in {{ site.product.short_name }}. --- The logmatic() destination has the following options. You can also set diff --git a/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md b/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md index 82df28d5..f42bc0bb 100644 --- a/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md +++ b/doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md @@ -2,7 +2,7 @@ title: loki() destination options id: adm-dest-loki-opt description: >- - This section describes the options of the loki() destination in {{ site.product.short_name }}. + This section describes the options of the loki() destination in {{ site.product.short_name }}. --- The `loki()` driver sends messages to a Loki Grafana database and has the following options: diff --git a/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md b/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md index 16b9a1a3..c0898e3d 100644 --- a/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md +++ b/doc/_admin-guide/070_Destinations/130_MongoDB/001_Mongodb_options.md @@ -2,7 +2,7 @@ title: mongodb() destination options id: adm-dest-mongodb-opt description: >- - This section describes the options of the mongodb() destination in {{ site.product.short_name }}. + This section describes the options of the mongodb() destination in {{ site.product.short_name }}. --- The mongodb() driver sends messages to a MongoDB database. MongoDB is a diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md b/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md index 8928c15b..a1b589b7 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/000_mqtt_destination_prerequisites.md @@ -2,7 +2,7 @@ title: Prerequisites to using the mqtt() destination id: adm-dest-mqtt-pre description: >- - In this chapter you can read about the prerequisites of using the mqtt() destination in {{ site.product.short_name }}. + In this chapter you can read about the prerequisites of using the mqtt() destination in {{ site.product.short_name }}. --- Using the current implementation of the mqtt() destination has the diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md b/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md index eea35ad5..b2838dc4 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/001_mqtt_destination_limitations.md @@ -2,7 +2,7 @@ title: Limitations to using the mqtt() destination id: adm-dest-mqtt-lim description: >- - In this chapter you can read about the limitations of the mqtt() destination in {{ site.product.short_name }}. + In this chapter you can read about the limitations of the mqtt() destination in {{ site.product.short_name }}. --- Using the mqtt() destination of {{ site.product.short_name }} has the following diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md b/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md index 5b4b699f..b586a4fd 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/002_mqtt_destination_options.md @@ -3,7 +3,7 @@ title: Options of the mqtt() destination srv: 'MQTT Broker' id: adm-dest-mqtt-opt description: >- - This section describes the options of the mqtt() destination in {{ site.product.short_name }}. + This section describes the options of the mqtt() destination in {{ site.product.short_name }}. --- The mqtt() destination has the following options. diff --git a/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md b/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md index 00731bd0..a3f9bcae 100644 --- a/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md +++ b/doc/_admin-guide/070_Destinations/140_mqtt/003_mqtt_possible_error_messages.md @@ -3,7 +3,7 @@ title: Possible error messages you may encounter while using the mqtt() destinat short_title: Possible error messages id: adm-dest-mqtt-err description: >- - This chapter describes issues and corresponding error messages originating from the MQTT system. + This chapter describes issues and corresponding error messages originating from the MQTT system. --- The following table contains the error messages you may encounter, the diff --git a/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md b/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md index 15d06290..96f7b8d6 100644 --- a/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md +++ b/doc/_admin-guide/070_Destinations/150_Network/000_Network_destination_options.md @@ -2,7 +2,7 @@ title: network() destination options id: adm-dest-netw-opt description: >- - This section describes the options of the network() destination in {{ site.product.short_name }}. + This section describes the options of the network() destination in {{ site.product.short_name }}. --- The network() driver sends messages to a remote host (for example, a diff --git a/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md b/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md index e375ed09..d21d92ea 100644 --- a/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md +++ b/doc/_admin-guide/070_Destinations/155_opensearch/001_opensearch()-destination-options.md @@ -2,7 +2,7 @@ title: OpenSearch() destination options id: adm-dest-os-opt description: >- - This section describes the options of the opensearch() destination in {{ site.product.short_name }}. + This section describes the options of the opensearch() destination in {{ site.product.short_name }}. --- diff --git a/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md b/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md index d2b54ad5..8b0b1bde 100644 --- a/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md +++ b/doc/_admin-guide/070_Destinations/157_OpenTelemetry/000_opentelemetry-destination-options.md @@ -2,7 +2,7 @@ title: opentelemetry() destination options id: adm-dest-optel-opt description: >- - This section describes the options of the opentelemetry() destination in {{ site.product.short_name }}. + This section describes the options of the opentelemetry() destination in {{ site.product.short_name }}. --- The following options are available for the opentelemetry() destination. diff --git a/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md b/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md index 506ae7a1..c2d69234 100644 --- a/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md +++ b/doc/_admin-guide/070_Destinations/160_osquery/000_osquery_destination_options.md @@ -2,7 +2,7 @@ title: osquery() destination options id: adm-dest-osquery-opt description: >- - This section describes the options of the osquery() destination in {{ site.product.short_name }}. + This section describes the options of the osquery() destination in {{ site.product.short_name }}. --- The osquery() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md b/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md index 8b5c0c92..a491ba1a 100644 --- a/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md +++ b/doc/_admin-guide/070_Destinations/170_Pipe/000_Pipe_destination_options.md @@ -2,7 +2,7 @@ title: pipe() destination options id: adm-dest-pipe-opt description: >- - This section describes the options of the pipe() destination in {{ site.product.short_name }}. + This section describes the options of the pipe() destination in {{ site.product.short_name }}. --- This driver sends messages to a named pipe like /dev/xconsole. diff --git a/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md b/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md index a8051cff..ffecf7c5 100644 --- a/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md +++ b/doc/_admin-guide/070_Destinations/180_Program/000_Program_destination_options.md @@ -2,7 +2,7 @@ title: program() destination options id: adm-dest-program-opt description: >- - This section describes the options of the program() destination in {{ site.product.short_name }}. + This section describes the options of the program() destination in {{ site.product.short_name }}. --- This driver starts an external application or script and sends the log diff --git a/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md b/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md index dede6b50..e310eadd 100644 --- a/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md +++ b/doc/_admin-guide/070_Destinations/190_Pseudofile/000_Pseudofile_options.md @@ -2,7 +2,7 @@ title: pseudofile() destination options id: adm-dest-pseudo-opt description: >- - This section describes the options of the pseudofile() destination in {{ site.product.short_name }}. + This section describes the options of the pseudofile() destination in {{ site.product.short_name }}. --- The pseudofile() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md b/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md index 7c291fbd..0d4f3833 100644 --- a/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md +++ b/doc/_admin-guide/070_Destinations/210_Redis/001_Redis_options.md @@ -4,7 +4,7 @@ srv: Redis server port: '6379' id: adm-dest-redis-opt description: >- - This section describes the options of the redis() destination in {{ site.product.short_name }}. + This section describes the options of the redis() destination in {{ site.product.short_name }}. --- The redis() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md b/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md index 2dd2755f..70a7245a 100644 --- a/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md +++ b/doc/_admin-guide/070_Destinations/220_Riemann/000_Riemann_options.md @@ -4,7 +4,7 @@ srv: Riemann server port: '5555' id: adm-dest-riemann-opt description: >- - This section describes the options of the riemann() destination in {{ site.product.short_name }}. + This section describes the options of the riemann() destination in {{ site.product.short_name }}. --- The riemann() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md b/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md index b3eb7d1d..67d8a855 100644 --- a/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md +++ b/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md @@ -2,7 +2,7 @@ title: 'Amazon s3 options' id: adm-opt-amazon description: >- - This section describes the options of the s3() destination in {{ site.product.short_name }}. + This section describes the options of the s3() destination in {{ site.product.short_name }}. --- The following options are specific to the s3 destination. diff --git a/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md b/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md index e367ed85..270c90a2 100644 --- a/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md +++ b/doc/_admin-guide/070_Destinations/230_Slack/000_Slack_options.md @@ -2,7 +2,7 @@ title: Slack destination options id: adm-dest-slack-opt description: >- - This section describes the options of the slack() destination in {{ site.product.short_name }}. + This section describes the options of the slack() destination in {{ site.product.short_name }}. --- The slack destination of {{ site.product.short_name }} can directly post log messages diff --git a/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md b/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md index 0ec427c8..b0d51d83 100644 --- a/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md +++ b/doc/_admin-guide/070_Destinations/240_SMTP/000_SMTP_options.md @@ -4,7 +4,7 @@ srv: SMTP server port: '25' id: adm-dest-smtp-opt description: >- - This section describes the options of the smtp() destination in {{ site.product.short_name }}. + This section describes the options of the smtp() destination in {{ site.product.short_name }}. --- The smtp() sends email messages using SMTP, without needing external diff --git a/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md b/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md index bd427c70..960a3af3 100644 --- a/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md +++ b/doc/_admin-guide/070_Destinations/250_snmp/001_snmp_options.md @@ -4,7 +4,7 @@ srv: 'SNMP server' port: '162' id: adm-dest-snmp-opt description: >- - This section describes the options of the snmp() destination in {{ site.product.short_name }}. + This section describes the options of the snmp() destination in {{ site.product.short_name }}. --- This driver sends SNMP traps using the SNMP v2c or v3 protocol. diff --git a/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md b/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md index d9e459af..8dfcc07a 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md +++ b/doc/_admin-guide/070_Destinations/270_sql/000_Using_sql_driver_with_Oracle.md @@ -2,7 +2,7 @@ title: Using the sql() driver with an Oracle database id: adm-dest-sql-oracle description: >- - This section describes how to use sql() driver of {{ site.product.short_name }} with an Oracle database. + This section describes how to use sql() driver of {{ site.product.short_name }} with an Oracle database. --- The Oracle sql destination has some special aspects that are important diff --git a/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md b/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md index 9d8d54a6..a1ff0ee0 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md +++ b/doc/_admin-guide/070_Destinations/270_sql/001_Using_sql_driver_with_MSSQL.md @@ -2,7 +2,7 @@ title: Using the sql() driver with a Microsoft SQL database id: adm-dest-sql-mssql description: >- - This section describes how to use sql() driver of {{ site.product.short_name }} with an MSSQL database. + This section describes how to use sql() driver of {{ site.product.short_name }} with an MSSQL database. --- The mssql database driver can access Microsoft SQL (MSSQL) destinations. diff --git a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md index 32dfe39c..e3603d02 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md +++ b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/000_mysql_specific_interaction_methods.md @@ -2,7 +2,7 @@ title: MySQL-specific interaction methods id: adm-dest-sql-interact-mysql description: >- - This section describes the MySQL-specific interaction methods in {{ site.product.short_name }}. + This section describes the MySQL-specific interaction methods in {{ site.product.short_name }}. --- To specify the socket to use, set and export the MYSQL_UNIX_PORT diff --git a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md index 2f2a3240..de555a4e 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md +++ b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/001_mssql_specific_interaction_methods.md @@ -2,7 +2,7 @@ title: MSSQL-specific interaction methods id: adm-dest-sql-interact-mssql description: >- - This section describes the MSSQL-specific interaction methods in {{ site.product.short_name }}. + This section describes the MSSQL-specific interaction methods in {{ site.product.short_name }}. --- In SQL Server 2005 this restriction is lifted - kind of. The total diff --git a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md index dad51882..27dae828 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md +++ b/doc/_admin-guide/070_Destinations/270_sql/002_Interaction/README.md @@ -2,7 +2,7 @@ title: The way {{ site.product.short_name }} interacts with the database id: adm-dest-sql-interact description: >- - This section describes the way {{ site.product.short_name }} interacts with the database. + This section describes the way {{ site.product.short_name }} interacts with the database. --- ## Used SQL operations by syslog-ng diff --git a/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md b/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md index de1b3db8..2a960fdb 100644 --- a/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md +++ b/doc/_admin-guide/070_Destinations/270_sql/003_sql_destination_options.md @@ -4,7 +4,7 @@ srv: 'database server' port: '1433 TCP for MSSQL, 3306 TCP for MySQL, 1521 for Oracle, and 5432 TCP for PostgreSQL' id: adm-dest-sql-opt description: >- - This section describes the options of the sql() destination in {{ site.product.short_name }}. + This section describes the options of the sql() destination in {{ site.product.short_name }}. --- This driver sends messages into an SQL database. The sql() destination diff --git a/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md b/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md index 514fa6e8..9d958251 100644 --- a/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md +++ b/doc/_admin-guide/070_Destinations/275_stdout/000_stdout_options.md @@ -2,7 +2,7 @@ title: stdout() options id: adm-opt-stdout description: >- - This section describes the options of the sql() destination in {{ site.product.short_name }}. + This section describes the options of the sql() destination in {{ site.product.short_name }}. --- The following options are available for an stdout destiantion. diff --git a/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md b/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md index 4e72667b..b86980dd 100644 --- a/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md +++ b/doc/_admin-guide/070_Destinations/280_Stomp/000_Stomp_options.md @@ -3,7 +3,7 @@ title: stomp() destination options srv: STOMP server id: adm-dest-stomp-opt description: >- - This section describes the options of the stomp() destination in {{ site.product.short_name }}. + This section describes the options of the stomp() destination in {{ site.product.short_name }}. --- The stomp() driver publishes messages using the Simple (or Streaming) diff --git a/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md b/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md index 56fbc847..dc381d83 100644 --- a/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md +++ b/doc/_admin-guide/070_Destinations/290_Sumologic/003_sumologic_http_options.md @@ -2,7 +2,7 @@ title: sumologic-http() destination options id: adm-dest-sumologic-http-opt description: >- - This section describes the options of the sumologic-http() destination in {{ site.product.short_name }}. + This section describes the options of the sumologic-http() destination in {{ site.product.short_name }}. --- diff --git a/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md b/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md index fd613cd2..e31c666a 100644 --- a/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md +++ b/doc/_admin-guide/070_Destinations/290_Sumologic/004_sumologic_syslog_options.md @@ -6,7 +6,7 @@ token: 'Cloud Syslog Cloud Token' provider: 'Sumo Logic service' id: adm-dest-sumologic-syslog-opt description: >- - This section describes the options of the sumologic-syslog() destination in {{ site.product.short_name }}. + This section describes the options of the sumologic-syslog() destination in {{ site.product.short_name }}. --- The sumologic-syslog() destination supports all diff --git a/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md b/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md index f53c5f24..05a2f4f3 100644 --- a/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md +++ b/doc/_admin-guide/070_Destinations/300_syslog/000_syslog_destination_options.md @@ -2,7 +2,7 @@ title: syslog() destination options id: adm-dest-syslog-opt description: >- - This section describes the options of the syslog() destination in {{ site.product.short_name }}. + This section describes the options of the syslog() destination in {{ site.product.short_name }}. --- The syslog() driver sends messages to a remote host (for example, a diff --git a/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md b/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md index 539b9911..feb0c223 100644 --- a/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md +++ b/doc/_admin-guide/070_Destinations/310_syslog-ng/000_syslog-ng_destination_options.md @@ -2,7 +2,7 @@ title: syslog-ng() destination options id: adm-dest-syslogng-opt description: >- - This section describes the options of the syslog-ng() destination in {{ site.product.short_name }}. + This section describes the options of the syslog-ng() destination in {{ site.product.short_name }}. --- The syslog-ng() destination is a special version of the network() diff --git a/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md b/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md index e4575cff..e0697f0f 100644 --- a/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md +++ b/doc/_admin-guide/070_Destinations/315_syslog-otlp/000_otlp-destination-options.md @@ -2,7 +2,7 @@ title: syslog-ng-otlp() destination options id: adm-dest-sng-otlp-opt description: >- - This section describes the options of the syslog-ng-otlp() destination in {{ site.product.short_name }}. + This section describes the options of the syslog-ng-otlp() destination in {{ site.product.short_name }}. --- The following options are available for the `syslog-ng-otlp()` destination. diff --git a/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md b/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md index 40c30875..82c544b6 100644 --- a/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md +++ b/doc/_admin-guide/070_Destinations/320_tcp_tcp6_udp_udp6/000_Convert_tcp_udp_to_network_destination.md @@ -4,7 +4,7 @@ dors: 'destination' prefix: 'd' id: adm-dest-tcp-convert description: >- - This section describes how to convert an old destination driver to network() driver in {{ site.product.short_name }}. + This section describes how to convert an old destination driver to network() driver in {{ site.product.short_name }}. --- {% include doc/admin-guide/convert-to-network.md %} diff --git a/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md b/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md index de4841de..8a8552ea 100644 --- a/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md +++ b/doc/_admin-guide/070_Destinations/330_Telegram/000_Telegram_options.md @@ -2,7 +2,7 @@ title: telegram() destination options id: adm-dest-telegram-opt description: >- - This section describes the options of the telegram() destination in {{ site.product.short_name }}. + This section describes the options of the telegram() destination in {{ site.product.short_name }}. --- The telegram() destination has the following options: diff --git a/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md b/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md index 67789aba..78975b23 100644 --- a/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md +++ b/doc/_admin-guide/070_Destinations/340_unix-stream_unix-dgram/000_unixstream_options.md @@ -2,7 +2,7 @@ title: unix-stream() and unix-dgram() destination options id: adm-dest-unix-opt description: >- - This section describes the options of the unix-stream() and unix-dgram() destinations in {{ site.product.short_name }}. + This section describes the options of the unix-stream() and unix-dgram() destinations in {{ site.product.short_name }}. --- These drivers send messages to a unix socket in either SOCK_STREAM or diff --git a/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md b/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md index e7f99ba5..21e2dafb 100644 --- a/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md +++ b/doc/_admin-guide/080_Log/000_Log_paths/001_if_else_elif.md @@ -3,7 +3,7 @@ title: 'if-else-elif: Conditional expressions' short_title: if-else-elif - Conditional expressions id: adm-log-cond description: >- - This section describes how to use conditional expressions in {{ site.product.short_name }} configs. + This section describes how to use conditional expressions in {{ site.product.short_name }} configs. --- You can use **if {}**, **elif {}**, and **else {}** blocks to configure diff --git a/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md b/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md index bb769d3c..df4b9ee3 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md +++ b/doc/_admin-guide/080_Log/020_Buffering/000_Enabling_reliable_diskbuffer.md @@ -2,7 +2,7 @@ title: Enabling reliable disk-based buffering id: adm-log-diskbuff-reliable description: >- - This section describes how to enable reliable disk-based buffering in {{ site.product.short_name }}. + This section describes how to enable reliable disk-based buffering in {{ site.product.short_name }}. --- To enable reliable disk-based buffering, use the diff --git a/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md b/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md index e76aa0b3..e210b2ac 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md +++ b/doc/_admin-guide/080_Log/020_Buffering/001_Enabling_normal_diskbuffer.md @@ -2,7 +2,7 @@ title: Enabling normal disk-based buffering id: adm-log-diskbuff-normal description: >- - This section describes how to enable normal disk-based buffering in {{ site.product.short_name }}. + This section describes how to enable normal disk-based buffering in {{ site.product.short_name }}. --- If the reliable() option is not set, by default a normal disk-buffer is diff --git a/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md b/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md index 37a1273c..7fc25cb3 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md +++ b/doc/_admin-guide/080_Log/020_Buffering/003_Enabling_memory_buffering.md @@ -2,7 +2,7 @@ title: Enabling memory buffering id: adm-log-diskbuff-memory description: >- - This section describes how to enable memory buffering in {{ site.product.short_name }}. + This section describes how to enable memory buffering in {{ site.product.short_name }}. --- To enable memory buffering, use the **log-fifo-size()** parameter in the diff --git a/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md b/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md index db04c821..a03d118a 100644 --- a/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md +++ b/doc/_admin-guide/080_Log/020_Buffering/004_About_diskbuffer_files.md @@ -2,7 +2,7 @@ title: About disk queue files id: adm-log-diskbuff-about description: >- - This section describes disk queue files in {{ site.product.short_name }}. + This section describes disk queue files in {{ site.product.short_name }}. --- ## Normal and reliable queue files diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md index 6b4ce5f8..7a616d17 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/000_facility.md @@ -2,7 +2,7 @@ title: facility() id: adm-log-filters-facility description: >- - This section describes facility() filter function in {{ site.product.short_name }}. + This section describes facility() filter function in {{ site.product.short_name }}. --- *Synopsis:* facility(\) or facility(\) or facility(\..\) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md index 106f4c33..876f7f6a 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/001_filter.md @@ -2,7 +2,7 @@ title: filter() id: adm-log-filters-filter description: >- - This section describes filter() filter function in {{ site.product.short_name }}. + This section describes filter() filter function in {{ site.product.short_name }}. --- *Synopsis:* filter(filtername) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md index 06ad90e4..fccc4d28 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/002_host.md @@ -2,7 +2,7 @@ title: host() id: adm-log-filters-host description: >- - This section describes host() filter function in {{ site.product.short_name }}. + This section describes host() filter function in {{ site.product.short_name }}. --- *Synopsis:* host(regexp) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md index 4204181d..178bd441 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/003_inlist.md @@ -2,7 +2,7 @@ title: in-list() id: adm-log-filters-inlist description: >- - This section describes inlist() filter function in {{ site.product.short_name }}. + This section describes inlist() filter function in {{ site.product.short_name }}. --- *Synopsis:* in-list(\"\\", value(\"\\")) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md index 5a8757ce..a70706d1 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/004_level_priority.md @@ -2,7 +2,7 @@ title: level() or priority() id: adm-log-filters-level description: >- - This section describes level() filter function in {{ site.product.short_name }}. + This section describes level() filter function in {{ site.product.short_name }}. --- *Synopsis:* level(\) or level(\..\) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md index 4f538cec..403bd819 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/005_match.md @@ -2,7 +2,7 @@ title: match() id: adm-log-filters-match description: >- - This section describes match() filter function in {{ site.product.short_name }}. + This section describes match() filter function in {{ site.product.short_name }}. --- *Synopsis:* match(regexp) \| match(regexp value(\"MACRO\")) \| match(regexp template(\"MACROS\")) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md index c0f8d4f6..8686d5c6 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/006_message.md @@ -2,7 +2,7 @@ title: message() id: adm-log-filters-message description: >- - This section describes message() filter function in {{ site.product.short_name }}. + This section describes message() filter function in {{ site.product.short_name }}. --- *Synopsis:* message(regexp) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md index c2c16439..f30157ac 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/007_netmask.md @@ -2,7 +2,7 @@ title: netmask() id: adm-log-filters-netmask description: >- - This section describes netmask() filter function in {{ site.product.short_name }}. + This section describes netmask() filter function in {{ site.product.short_name }}. --- *Synopsis:* netmask(ipv4/mask) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md index 0f616c49..fef3030b 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/008_netmask6.md @@ -2,7 +2,7 @@ title: netmask6() id: adm-log-filters-netmask6 description: >- - This section describes netmask6() filter function in {{ site.product.short_name }}. + This section describes netmask6() filter function in {{ site.product.short_name }}. --- *Synopsis:* netmask6(ipv6/mask) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md index 72230272..f3d48016 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/009_program.md @@ -2,7 +2,7 @@ title: program() id: adm-log-filters-program description: >- - This section describes program() filter function in {{ site.product.short_name }}. + This section describes program() filter function in {{ site.product.short_name }}. --- *Synopsis:* program(regexp) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md index d6b7e291..c1d7011c 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/010_rate-limit.md @@ -2,7 +2,7 @@ title: rate-limit() id: adm-log-filters-ratelimit description: >- - This section describes rate-limit() filter function in {{ site.product.short_name }}. + This section describes rate-limit() filter function in {{ site.product.short_name }}. --- *Synopsis:* rate-limit(template(${HOST}) rate(5000)) diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md index 4d0bf0ac..0599498e 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/011_source.md @@ -2,7 +2,7 @@ title: source() id: adm-log-filters-source description: >- - This section describes source() filter function in {{ site.product.short_name }}. + This section describes source() filter function in {{ site.product.short_name }}. --- *Synopsis:* source id diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md index ee44dae7..6a19ef91 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/012_tags.md @@ -2,7 +2,7 @@ title: tags() id: adm-log-filters-tags description: >- - This section describes tags() filter function in {{ site.product.short_name }}. + This section describes tags() filter function in {{ site.product.short_name }}. --- *Synopsis:* tag diff --git a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md index 2359b823..479ee2bc 100644 --- a/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md +++ b/doc/_admin-guide/080_Log/030_Filters/005_Filter_functions/README.md @@ -2,7 +2,7 @@ title: Filter functions id: adm-log-filters-functions description: >- - This section describes filter functions in {{ site.product.short_name }}. + This section describes filter functions in {{ site.product.short_name }}. --- The following functions may be used in the filter statement, as diff --git a/doc/_admin-guide/080_Log/030_Filters/README.md b/doc/_admin-guide/080_Log/030_Filters/README.md index 5a5d478f..4f3f3f67 100644 --- a/doc/_admin-guide/080_Log/030_Filters/README.md +++ b/doc/_admin-guide/080_Log/030_Filters/README.md @@ -2,7 +2,7 @@ title: Filters id: adm-log-filters description: >- - The following sections describe how to select and filter log messages in {{ site.product.short_name }}. + The following sections describe how to select and filter log messages in {{ site.product.short_name }}. --- - Using filters describes how to configure and use filters. diff --git a/doc/_admin-guide/080_Log/README.md b/doc/_admin-guide/080_Log/README.md index 4c7a866d..2b60469d 100644 --- a/doc/_admin-guide/080_Log/README.md +++ b/doc/_admin-guide/080_Log/README.md @@ -3,5 +3,5 @@ title: 'log: Filter and route log messages using log paths, flags, and filters' short_title: Log - Filter and route log messages id: adm-log description: >- - This chapter is about how to filter and route log messages with log paths, flags and filters in {{ site.product.short_name }} + This chapter is about how to filter and route log messages with log paths, flags and filters in {{ site.product.short_name }} --- diff --git a/doc/_admin-guide/090_Global_options/000_Global_options.md b/doc/_admin-guide/090_Global_options/000_Global_options.md index 2098c5e8..e8ec96d4 100644 --- a/doc/_admin-guide/090_Global_options/000_Global_options.md +++ b/doc/_admin-guide/090_Global_options/000_Global_options.md @@ -9,8 +9,8 @@ dir_perm: '-1' on_error: 'drop-message' id: adm-global-opt description: >- - The following options can be specified in the options statement, as - described in Global options of {{ site.product.short_name }}. + The following options can be specified in the options statement, as + described in Global options of {{ site.product.short_name }}. --- ## bad-hostname() diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md index 2f34be23..c5879a94 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/000_Configuring_TLS_client.md @@ -2,7 +2,7 @@ title: Configuring TLS on the {{ site.product.short_name }} clients id: adm-tls-client-conf description: >- - This chapter describes how to configure TLS on {{ site.product.short_name }} clients + This chapter describes how to configure TLS on {{ site.product.short_name }} clients --- ## Purpose diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md index f0a28b0d..ace9531c 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/001_Encrypting_log_messages_with_TLS/001_Configuring_TLS_server.md @@ -2,7 +2,7 @@ title: Configuring TLS on the {{ site.product.short_name }} server id: adm-tls-server-conf description: >- - This chapter describes how to configure TLS on {{ site.product.short_name }} servers. + This chapter describes how to configure TLS on {{ site.product.short_name }} servers. --- ## Purpose diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md index 29dd7d1b..a25b6015 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/000_Configuring_mutual_TLS_client.md @@ -2,7 +2,7 @@ title: Configuring {{ site.product.short_name }} clients with mutual authentication id: adm-tls-client-conf-mutual description: >- - This chapter describes how to configure TLS on {{ site.product.short_name }} clients with mutual authentication. + This chapter describes how to configure TLS on {{ site.product.short_name }} clients with mutual authentication. --- ## Purpose diff --git a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md index af7c2a35..876fe1f0 100644 --- a/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md +++ b/doc/_admin-guide/100_TLS-encrypted_message_transfer/002_Mutual_authentication_using_TLS/001_Configuring_mutual_TLS_server.md @@ -2,7 +2,7 @@ title: Configuring {{ site.product.short_name }} servers with mutual authentication id: adm-tls-server-conf-mutual description: >- - This chapter describes how to configure TLS on {{ site.product.short_name }} servers with mutual authentication + This chapter describes how to configure TLS on {{ site.product.short_name }} servers with mutual authentication --- ## Purpose diff --git a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md index ec273d07..34744b7d 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md +++ b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/002_Date_related_macros.md @@ -2,7 +2,7 @@ title: Date-related macros id: adm-temp-date-macro description: >- - This chapter describes the date-related macros of {{ site.product.short_name }}. + This chapter describes the date-related macros of {{ site.product.short_name }}. --- The macros related to the date of the message (for example: ${ISODATE}, diff --git a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md index b79ba174..c470f802 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md +++ b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/005_Example.md @@ -3,8 +3,8 @@ title: 'Example use case: using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} short_title: Example use case id: adm-temp-example description: >- - This section describes scenarios when One Identity recommends using the - ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros. + This section describes scenarios when One Identity recommends using the + ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros. --- Using the ${DESTIP}, the ${DESTPORT}, and the ${PROTO} macros is relevant diff --git a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md index 430995a5..77c3e931 100644 --- a/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md +++ b/doc/_admin-guide/110_Template_and_rewrite/000_Customize_message_format/README.md @@ -2,8 +2,8 @@ title: Customize message format using macros and templates id: adm-temp-custom description: >- - The following sections describe how to customize the names of logfiles, - and also how to use templates, macros, and template functions in {{ site.product.short_name }}. + The following sections describe how to customize the names of logfiles, + and also how to use templates, macros, and template functions in {{ site.product.short_name }}. --- - Formatting messages, filenames, directories, and tablenames diff --git a/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md b/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md index bf1b1f60..0615c900 100644 --- a/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md +++ b/doc/_admin-guide/120_Parser/000_Parsing_syslog_messages/000_Syslog_parser_options.md @@ -2,7 +2,7 @@ title: Options of syslog-parser() parsers id: adm-parser-opt description: >- - This section describes the options of the syslog-parser() in {{ site.product.short_name }}. + This section describes the options of the syslog-parser() in {{ site.product.short_name }}. --- The syslog-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md b/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md index db58f865..ab6c9312 100644 --- a/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md +++ b/doc/_admin-guide/120_Parser/001_Parsing_messages_with_comma/000_CSV_parser_options.md @@ -2,7 +2,7 @@ title: Options of CSV parsers id: adm-parser-csv-opt description: >- - This section describes the options of the csv-parser() in {{ site.product.short_name }}. + This section describes the options of the csv-parser() in {{ site.product.short_name }}. --- The csv-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md b/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md index 3fac32a2..98c517d1 100644 --- a/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md +++ b/doc/_admin-guide/120_Parser/002_Parsing_key-value_pairs/000_kv_parser_options.md @@ -4,7 +4,7 @@ parser: kv-parser prefix: kv id: adm-parser-kv-opt description: >- - This section describes the options of the kv-parser() in {{ site.product.short_name }}. + This section describes the options of the kv-parser() in {{ site.product.short_name }}. --- The kv-parser has the following options. diff --git a/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md b/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md index 6dc495fc..6b21b63c 100644 --- a/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md +++ b/doc/_admin-guide/120_Parser/003_JSON_parser/000_JSON_parser_options.md @@ -2,7 +2,7 @@ title: Options of JSON parsers id: adm-parser-json-opt description: >- - This section describes the options of the json-parser() in {{ site.product.short_name }}. + This section describes the options of the json-parser() in {{ site.product.short_name }}. --- The JSON parser has the following options. diff --git a/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md b/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md index dcc75574..dd66703f 100644 --- a/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md +++ b/doc/_admin-guide/120_Parser/004_XML_parser/000_Limitations.md @@ -2,7 +2,7 @@ title: Limitations of the XML parsers id: adm-parser-xml-lim description: >- - This section describes the limitations of the xml-parser() in {{ site.product.short_name }}. + This section describes the limitations of the xml-parser() in {{ site.product.short_name }}. --- The XML parser comes with certain limitations. diff --git a/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md b/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md index c4f84c87..b9ef01a1 100644 --- a/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md +++ b/doc/_admin-guide/120_Parser/004_XML_parser/001_XML_Parser_options.md @@ -2,7 +2,7 @@ title: Options of the XML parsers id: adm-parser-xml-opt description: >- - This section describes the options of the xml-parser() in {{ site.product.short_name }}. + This section describes the options of the xml-parser() in {{ site.product.short_name }}. --- ## drop-invalid() diff --git a/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md b/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md index 8a0a52fb..326ac43a 100644 --- a/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md +++ b/doc/_admin-guide/120_Parser/005_Parsing_dates/000_Date_parser_options.md @@ -2,7 +2,7 @@ title: Options of date-parser() parsers id: adm-parser-date-opt description: >- - This section describes the options of the date-parser() in {{ site.product.short_name }}. + This section describes the options of the date-parser() in {{ site.product.short_name }}. --- The date-parser() parser has the following options. diff --git a/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md b/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md index 9b214531..fa4edee2 100644 --- a/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md +++ b/doc/_admin-guide/120_Parser/008_Apache_access_log_parser/000_Apache_parser_options.md @@ -4,7 +4,7 @@ parser: apache-accesslog prefix: apache id: adm-parser-apache-opt description: >- - This section describes the options of the apache-accesslog-parser() in {{ site.product.short_name }}. + This section describes the options of the apache-accesslog-parser() in {{ site.product.short_name }}. --- {% include doc/admin-guide/options/prefix.md %} diff --git a/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md b/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md index 3f2ee10c..db912387 100644 --- a/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md +++ b/doc/_admin-guide/120_Parser/009_Linux_audit_parser/000_Linux_audit_parser_options.md @@ -4,7 +4,7 @@ parser: linux-audit prefix: auditd id: adm-parser-linux-opt description: >- - This section describes the options of the linux-audit-parser() in {{ site.product.short_name }}. + This section describes the options of the linux-audit-parser() in {{ site.product.short_name }}. --- The linux-audit-parser() has the following options. diff --git a/doc/_admin-guide/120_Parser/010_Cisco_parser.md b/doc/_admin-guide/120_Parser/010_Cisco_parser.md index bf4ef938..22bbdd90 100644 --- a/doc/_admin-guide/120_Parser/010_Cisco_parser.md +++ b/doc/_admin-guide/120_Parser/010_Cisco_parser.md @@ -3,7 +3,7 @@ title: Cisco parser parser: cisco id: adm-parser-cisco description: >- - The Cisco parser can parse the log messages of various Cisco devices. + The Cisco parser can parse the log messages of various Cisco devices. --- {% include doc/admin-guide/parser-intro.md %} diff --git a/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md b/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md index 7e550dfb..49619e2c 100644 --- a/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md +++ b/doc/_admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options.md @@ -2,7 +2,7 @@ title: PAN-OS parser options id: adm-parser-panos-opt description: >- - This section describes the options of the panos-parser() in {{ site.product.short_name }}. + This section describes the options of the panos-parser() in {{ site.product.short_name }}. --- The panos-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md b/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md index c1fc588f..c63f2481 100644 --- a/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md +++ b/doc/_admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options.md @@ -2,7 +2,7 @@ title: PostgreSQL csvlog parser options id: adm-parser-postgresql-opt description: >- - This section describes the options of the postgresql-csvlog-parser() in {{ site.product.short_name }}. + This section describes the options of the postgresql-csvlog-parser() in {{ site.product.short_name }}. --- The postgresql-csvlog-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md b/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md index 1eaab700..c5b51f7b 100644 --- a/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md +++ b/doc/_admin-guide/120_Parser/017_metrics_probe_parser/000_metrics_probe_options.md @@ -2,7 +2,7 @@ title: 'metrics-probe options' id: adm-parser-metrics-opt description: >- - This section describes the options of the metrics-probe() parser in {{ site.product.short_name }}. + This section describes the options of the metrics-probe() parser in {{ site.product.short_name }}. --- ## increment() diff --git a/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md b/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md index 0b071347..e41c5bf7 100644 --- a/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md +++ b/doc/_admin-guide/120_Parser/020_Fortigate_parser/000_Fortigate_parser_options.md @@ -3,7 +3,7 @@ title: Fortigate parser options parser: fortigate id: adm-parser-fortigate-opt description: >- - This section describes the options of the fortigate-parser() in {{ site.product.short_name }}. + This section describes the options of the fortigate-parser() in {{ site.product.short_name }}. --- The fortigate-parser() has the following options: diff --git a/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md b/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md index c25b15c3..3ee2b847 100644 --- a/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md +++ b/doc/_admin-guide/120_Parser/022_regexp_parser/000_regex_parser_options.md @@ -2,7 +2,7 @@ title: Options of Regular expression parsers id: adm-parser-regexp-opt description: >- - This section describes the options of the regexp-parser() in {{ site.product.short_name }}. + This section describes the options of the regexp-parser() in {{ site.product.short_name }}. --- The Regular expression parser has the following options. diff --git a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md index 337e51db..61d89043 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/000_Structure_of_a_patterndb.md @@ -2,7 +2,7 @@ title: The structure of the pattern database id: adm-parser-db-struct description: >- - This section describes the structure of a pattern database in {{ site.product.short_name }}. + This section describes the structure of a pattern database in {{ site.product.short_name }}. --- The pattern database is organized as follows: diff --git a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md index ef225bd9..1f84b1ce 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/000_Classifying_log_messages/001_How_pattern_matching_works.md @@ -2,7 +2,7 @@ title: How pattern matching works id: adm-parser-db-match description: >- - This section describes how pattern matching works in {{ site.product.short_name }}. + This section describes how pattern matching works in {{ site.product.short_name }}. --- ## Figure 21: Applying patterns diff --git a/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md b/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md index 719169d3..3e3c57b5 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/001_Using_pattern_databases/README.md @@ -2,7 +2,7 @@ title: Using pattern databases id: adm-parser-db-patterndb description: >- - This section describes how to use pattern databases in {{ site.product.short_name }}. + This section describes how to use pattern databases in {{ site.product.short_name }}. --- To classify messages using a pattern database, include a db-parser() diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md index 5b45bd28..bfc51963 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/001_Pattern_parsers.md @@ -2,7 +2,7 @@ title: Pattern parsers of {{ site.product.short_name }} id: adm-parser-db-pattern-parsers description: >- - This section describes the pattern parsers of {{ site.product.short_name }}. + This section describes the pattern parsers of {{ site.product.short_name }}. --- The following parsers are available in {{ site.product.short_name }}. diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md index 4e56862f..be275856 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/002_Whatsnew_in_patterndb_v5.md @@ -2,7 +2,7 @@ title: "What's new in the {{ site.product.short_name }} pattern database format V5" id: adm-parser-db-whatsnew description: >- - This section describes the differences of V5 and V4 pattern database format in {{ site.product.short_name }}. + This section describes the differences of V5 and V4 pattern database format in {{ site.product.short_name }}. --- The V5 database format has the following differences compared to the V4 diff --git a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md index 57d1f4a2..7d8246e5 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/003_Creating_pattern_databases/README.md @@ -2,5 +2,5 @@ title: Creating pattern databases id: adm-parser-db-create description: >- - This section describes how to create pattern databases in {{ site.product.short_name }}. + This section describes how to create pattern databases in {{ site.product.short_name }}. --- diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md index 0a87fda7..7f752747 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/000_patterns/README.md @@ -3,7 +3,7 @@ title: 'Element: patterns container' short_title: patterns id: adm-parser-db-elem-patterns-ruleset description: >- - A container element. A \ element may contain any number of \ elements. + A container element. A \ element may contain any number of \ elements. --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md index 422fdda5..486ba055 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/000_urls/README.md @@ -3,8 +3,8 @@ title: 'Element: urls' short_title: urls id: adm-parser-db-elem-urls description: >- - An element containing one or more URLs referring to further - information about the patterns or the matching log messages. (optional) + An element containing one or more URLs referring to further + information about the patterns or the matching log messages. (optional) --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md index 15a32b60..689f7a9c 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/001_values/README.md @@ -3,10 +3,10 @@ title: 'Element: values' short_title: values id: adm-parser-db-elem-values description: >- - Name-value pairs that are assigned to messages matching the - patterns, for example, the representation of the event in the message - according to the Common Event Format (CEF) or Common Event Exchange - (CEE). The names can be used as macros to reference the assigned values. (optional) + Name-value pairs that are assigned to messages matching the + patterns, for example, the representation of the event in the message + according to the Common Event Format (CEF) or Common Event Exchange + (CEE). The names can be used as macros to reference the assigned values. (optional) --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md index 240e1170..af4ead2d 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/000_example/README.md @@ -3,7 +3,7 @@ title: 'Element: example' short_title: example id: adm-parser-db-elem-example description: >- - A container element for a sample log message. (optional) + A container element for a sample log message. (optional) --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md index 32ee8749..cd1fee26 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/002_examples/README.md @@ -3,9 +3,9 @@ title: 'Element: examples' short_title: examples id: adm-parser-db-elem-examples description: >- - A container element for sample log messages that should be - recognized by the pattern. These messages can be used also to test the - patterns and the parsers. (optional) + A container element for sample log messages that should be + recognized by the pattern. These messages can be used also to test the + patterns and the parsers. (optional) --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md index 784a8466..49205b74 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/000_patterns/README.md @@ -3,10 +3,10 @@ title: 'Element: patterns' short_title: patterns id: adm-parser-db-elem-patterns-rule description: >- - An element containing the patterns of the rule. If a *\* - element contains multiple *\* elements, the class of the - *\* is assigned to every syslog message matching any of the - patterns. + An element containing the patterns of the rule. If a *\* + element contains multiple *\* elements, the class of the + *\* is assigned to every syslog message matching any of the + patterns. --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md index a9c5096a..11ec2b20 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/000_rule/README.md @@ -3,8 +3,8 @@ title: 'Element: rule' short_title: rule id: adm-parser-db-elem-rule description: >- - An element containing message patterns and how a message that matches - these patterns is classified. + An element containing message patterns and how a message that matches + these patterns is classified. --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md index 4fd26c28..431b22a2 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/001_rules/README.md @@ -3,7 +3,7 @@ title: 'Element: rules' short_title: rules id: adm-parser-db-elem-rules description: >- - A container element for the rules of the ruleset. + A container element for the rules of the ruleset. --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md index 3dddc2ae..c38a64d1 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/000_create_context/README.md @@ -3,10 +3,10 @@ title: 'Element: create-context' short_title: create-context id: adm-parser-db-elem-create-context description: >- - Creates a new correlation context from the current message - and its associated context. This can be used to \"split\" a context. (optional) + Creates a new correlation context from the current message + and its associated context. This can be used to \"split\" a context. (optional) - Available in {{ site.product.short_name }} version 3.8 and later. + Available in {{ site.product.short_name }} version 3.8 and later. --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md index e95bbdb1..d5c911bd 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/000_action/README.md @@ -3,8 +3,8 @@ title: 'Element: action' short_title: action id: adm-parser-db-elem-action description: >- - A container element describing an action that is performed - when a message matching the rule is received. (optional) + A container element describing an action that is performed + when a message matching the rule is received. (optional) --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md index 53b9ee0e..c6130bc7 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/002_actions/README.md @@ -3,9 +3,9 @@ title: 'Element: actions' short_title: actions id: adm-parser-db-elem-actions description: >- - A container element for actions that are performed if a - message is recognized by the pattern. For details on actions, see - Triggering actions for identified messages. (optional) + A container element for actions that are performed if a + message is recognized by the pattern. For details on actions, see + Triggering actions for identified messages. (optional) --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md index 76d40e27..2d5dbeb3 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/003_tags/README.md @@ -3,12 +3,12 @@ title: 'Element: tags' short_title: tags id: adm-parser-db-elem-tags description: >- - An element containing custom keywords (tags) about the - messages matching the patterns. The tags can be used to label specific - events (for example, user logons). It is also possible to filter on - these tags later (for details, see Tagging messages). Starting with - {{ site.product.name }} 3.2, the list of tags assigned to a - message can be referenced with the ${TAGS} macro. (optional) + An element containing custom keywords (tags) about the + messages matching the patterns. The tags can be used to label specific + events (for example, user logons). It is also possible to filter on + these tags later (for details, see Tagging messages). Starting with + {{ site.product.name }} 3.2, the list of tags assigned to a + message can be referenced with the ${TAGS} macro. (optional) --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md index 289ab18e..6e60559c 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/000_ruleset/README.md @@ -3,8 +3,8 @@ title: 'Element: ruleset' short_title: ruleset id: adm-parser-db-elem-ruleset description: >- - A container element to group log patterns for an application or program. - A \ element may contain any number of \ elements. + A container element to group log patterns for an application or program. + A \ element may contain any number of \ elements. --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md index 3c54ba88..2da90931 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/004_The_syslog-ng_patterndb_format/000_patterndb/README.md @@ -3,7 +3,7 @@ title: 'Element: patterndb' short_title: patterndb id: adm-parser-db-elem-patterndb description: >- - The container element of the pattern database. + The container element of the pattern database. --- ## Location diff --git a/doc/_admin-guide/120_Parser/023_db_parser/README.md b/doc/_admin-guide/120_Parser/023_db_parser/README.md index 2345a501..de15a62c 100644 --- a/doc/_admin-guide/120_Parser/023_db_parser/README.md +++ b/doc/_admin-guide/120_Parser/023_db_parser/README.md @@ -3,7 +3,7 @@ title: 'db-parser: Process message content with a pattern database (patterndb)' short_title: db-parser id: adm-parser-db description: >- - This chapter describes the details of the db-parser() in {{ site.product.short_name }}. + This chapter describes the details of the db-parser() in {{ site.product.short_name }}. --- Classifying log messages diff --git a/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md b/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md index 0b20b6a1..35933dad 100644 --- a/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md +++ b/doc/_admin-guide/120_Parser/024_opentelemetry_parser.md @@ -3,7 +3,7 @@ title: OpenTelemetry parser parser: OpenTelemetry id: adm-parser-optel description: >- - The {{ site.product.short_name }} application does not parse the fields of the incoming messages into name-value pairs. It is only capable of forwarding messages using the OpenTelemetry destination. To parse the fields into name-value pairs, use the `opentelemetry()` parser. + The {{ site.product.short_name }} application does not parse the fields of the incoming messages into name-value pairs. It is only capable of forwarding messages using the OpenTelemetry destination. To parse the fields into name-value pairs, use the `opentelemetry()` parser. --- This parser parses the fields into name-value pairs starting with the `.otel.` prefix. diff --git a/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md b/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md index 34582b4a..1d0afa7a 100644 --- a/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md +++ b/doc/_admin-guide/130_Correlating_log_messages/001_Referencing_previous_messages_grouping-by.md @@ -2,7 +2,7 @@ title: Referencing earlier messages of the context id: adm-cor-prev description: >- - This chapter describes how to reference earlier messages of the context in {{ site.product.short_name }} + This chapter describes how to reference earlier messages of the context in {{ site.product.short_name }} --- When creating the aggregated message, or in the various parameters of diff --git a/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md b/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md index 595b1df4..a920370d 100644 --- a/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md +++ b/doc/_admin-guide/130_Correlating_log_messages/002_grouping-by_options.md @@ -2,7 +2,7 @@ title: Options of grouping-by parsers id: adm-cor-grouping-by-opt description: >- - This section describes the options of the grouping-by() parser in {{ site.product.short_name }}. + This section describes the options of the grouping-by() parser in {{ site.product.short_name }}. --- The grouping-by has the following options. diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md index 45fbf04b..683f47fb 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/000_Adding_metadata_from_external_file/002_add-contextual-data_options.md @@ -2,7 +2,7 @@ title: Options of add-contextual-data() id: adm-enrich-add-contextual-data-opt description: >- - This section describes the options of add-contextual-data() in {{ site.product.short_name }}. + This section describes the options of add-contextual-data() in {{ site.product.short_name }}. --- The add-contextual-data() has the following options. diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md index 640db088..f277cd4c 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/000_Referring_to_parts_of_the_message_as_a_macro.md @@ -2,9 +2,9 @@ title: Referring to parts of the message as a macro id: adm-enrich-geoip-macro description: >- - You can refer to the separated parts of the message using the key of the - value as a macro. For example, if the message contains - KEY1=value1,KEY2=value2, you can refer to the values as ${KEY1} and ${KEY2}. + You can refer to the separated parts of the message using the key of the + value as a macro. For example, if the message contains + KEY1=value1,KEY2=value2, you can refer to the values as ${KEY1} and ${KEY2}. --- For example, if the default prefix (.geoip2) is used, you can determine diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md index 577f134a..bbc34cdb 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/001_Using_the_geoip2_parser.md @@ -2,7 +2,7 @@ title: Using the GeoIP2 parser id: adm-enrich-geoip-using description: >- - This section describes how to use the geoip2() parser in {{ site.product.short_name }}. + This section describes how to use the geoip2() parser in {{ site.product.short_name }}. --- **Declaration** diff --git a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md index 62e8d822..c4a0ae30 100644 --- a/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md +++ b/doc/_admin-guide/140_Enriching_log_messages_with_external_data/001_Looking_up_geoip2_data/003_geoip2_parser_options.md @@ -3,7 +3,7 @@ title: Options of geoip2 parsers parser: geoip2 id: adm-enrich-geoip-opt description: >- - This section describes the options of geoip2() parser in {{ site.product.short_name }}. + This section describes the options of geoip2() parser in {{ site.product.short_name }}. --- The geoip2 parser has the following options. diff --git a/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md b/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md index 9b8af1a1..74956385 100644 --- a/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md +++ b/doc/_admin-guide/150_Statistics_of_syslog-ng/000_Metrics_and_counters.md @@ -2,7 +2,7 @@ title: Metrics and counters of {{ site.product.short_name }} id: adm-stats-metrics description: >- - This section describes how to display metrics in {{ site.product.short_name }}. + This section describes how to display metrics in {{ site.product.short_name }}. --- You can list all active metrics on your {{ site.product.short_name }} host using the diff --git a/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md b/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md index ba4c383b..5a97435b 100644 --- a/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md +++ b/doc/_admin-guide/170_Troubleshooting_syslog-ng/004_Stopping_syslog-ng.md @@ -2,8 +2,8 @@ title: Stopping syslog-ng id: adm-debug-stop description: >- - To avoid problems, always use the init scripts to stop {{ site.product.short_name }} - (`/etc/init.d/syslog-ng stop`), instead of using the kill command. - This is especially true on Solaris and HP-UX systems, here use - `/etc/init.d/syslog stop`. + To avoid problems, always use the init scripts to stop {{ site.product.short_name }} + (`/etc/init.d/syslog-ng stop`), instead of using the kill command. + This is especially true on Solaris and HP-UX systems, here use + `/etc/init.d/syslog stop`. --- diff --git a/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md b/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md index b6d6ca4c..c6dd8dd0 100644 --- a/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md +++ b/doc/_admin-guide/170_Troubleshooting_syslog-ng/009_Error_messages.md @@ -2,7 +2,7 @@ title: Error messages id: adm-debug-err description: >- - This section describes the most common error messages of {{ site.product.short_name }}. + This section describes the most common error messages of {{ site.product.short_name }}. --- ## Destination queue full diff --git a/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md b/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md index 4374d270..9a462a92 100644 --- a/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md +++ b/doc/_admin-guide/170_Troubleshooting_syslog-ng/010_SELinux.md @@ -3,7 +3,7 @@ title: SELinux prevents {{ site.product.short_name }} from using the execmem acc short_title: Using execmem prevented by SELinux id: adm-debug-selinux description: >- - This section describes how to resolve when SELinux prevents {{ site.product.short_name }} from using the execmem access on a process. + This section describes how to resolve when SELinux prevents {{ site.product.short_name }} from using the execmem access on a process. --- If you are using a recent enough PCRE library, {{ site.product.short_name }} will diff --git a/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md b/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md index 34ca2cb2..d282c44e 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/000_General_recommendations.md @@ -2,8 +2,8 @@ title: General recommendations id: adm-pract-general description: >- - This section provides general tips and recommendations on using - {{ site.product.short_name }}. + This section provides general tips and recommendations on using + {{ site.product.short_name }}. --- Some of the recommendations are detailed in the sections below: diff --git a/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md b/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md index 5b684ad9..24d55b19 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/003_Collecting_logs_from_chroot.md @@ -2,8 +2,8 @@ title: Collecting logs from chroot id: adm-pract-chroot description: >- - This section describes how to collect logs from a chroot using a {{ site.product.short_name }} - client running on the host. + This section describes how to collect logs from a chroot using a {{ site.product.short_name }} + client running on the host. --- Complete the following steps: diff --git a/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md b/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md index 4dfac0ad..4c3cfffc 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/004_Configuring_log_rotation.md @@ -2,8 +2,8 @@ title: Configuring log rotation id: adm-pract-rotate description: >- - The {{ site.product.short_name }} application does not rotate logs by itself. This chapter - describes how to use {{ site.product.short_name }} for log rotation. + The {{ site.product.short_name }} application does not rotate logs by itself. This chapter + describes how to use {{ site.product.short_name }} for log rotation. --- Consider the following approaches: diff --git a/doc/_admin-guide/180_Best_practices_and_examples/README.md b/doc/_admin-guide/180_Best_practices_and_examples/README.md index f2bcde81..fd1c5f29 100644 --- a/doc/_admin-guide/180_Best_practices_and_examples/README.md +++ b/doc/_admin-guide/180_Best_practices_and_examples/README.md @@ -2,6 +2,6 @@ title: Best practices and examples id: adm-pract description: >- - This chapter discusses some special examples and recommendations regarding {{ site.product.short_name }}. + This chapter discusses some special examples and recommendations regarding {{ site.product.short_name }}. --- diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md index 333fa604..7d45126b 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md @@ -3,8 +3,8 @@ title: The dqtool tool manual page app: dqtool id: adm-man-dqtool description: >- - dqtool --- Display the contents of a disk-buffer file created with - {{ site.product.short_name }}. + dqtool --- Display the contents of a disk-buffer file created with + {{ site.product.short_name }}. --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md index f5077e32..fe6483de 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md @@ -3,7 +3,7 @@ title: The loggen manual page app: loggen id: adm-man-loggen description: >- - loggen --- Generate syslog messages at a specified rate + loggen --- Generate syslog messages at a specified rate --- ## Synopsis @@ -175,7 +175,7 @@ statistics: Use the new IETF-syslog message format. By default, loggen uses the legacy BSD-syslog message format. - See also the \--no-framing option. + See also the \--no-framing option. - \--unix \ or -x \ diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md index 64a89d92..2aa3b614 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md @@ -2,8 +2,8 @@ title: The pdbtool manual page id: adm-man-pdbtool description: >- - pdbtool --- An application to test and convert {{ site.product.short_name }} pattern - database rules + pdbtool --- An application to test and convert {{ site.product.short_name }} pattern + database rules --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md index c6d8a904..afad5f97 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md @@ -2,7 +2,7 @@ title: The secure-logging manual page id: adm-man-sec-log description: >- - secure-logging --- Provides forward integrity and confidentiality for system logs. + secure-logging --- Provides forward integrity and confidentiality for system logs. --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md index e7c0d491..3b971c32 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md @@ -2,7 +2,7 @@ title: The slogencrypt manual page id: adm-man-slogscr description: >- - slogencrypt --- Encrypts existing plain text log files using the {{ site.product.short_name }} secure logging environment. + slogencrypt --- Encrypts existing plain text log files using the {{ site.product.short_name }} secure logging environment. --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md index 8e921c4b..4cc8a9d7 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md @@ -2,7 +2,7 @@ title: The slogkey manual page id: adm-man-slogkey description: >- - slogkey --- Manages the cryptographic keys for use with the {{ site.product.short_name }} secure logging environment. + slogkey --- Manages the cryptographic keys for use with the {{ site.product.short_name }} secure logging environment. --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md index 34fb4253..f1d2e020 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md @@ -2,7 +2,7 @@ title: The slogverify manual page id: adm-man-slogver description: >- - slogverify --- Verifies cryptographically secured logs. + slogverify --- Verifies cryptographically secured logs. --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md index 9c63886e..19b18086 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool.md @@ -3,8 +3,8 @@ title: The {{ site.product.short_name }} control tool manual page app: syslog-ng-ctl id: adm-man-ctl description: >- - syslog-ng-ctl --- Display message statistics and enable verbose, debug - and trace modes in {{ site.product.short_name }} + syslog-ng-ctl --- Display message statistics and enable verbose, debug + and trace modes in {{ site.product.short_name }} --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md index df08c317..bb2e2828 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool.md @@ -3,7 +3,7 @@ title: The syslog-debun manual page app: syslog-debun id: adm-man-debun description: >- - syslog-debun --- syslog-ng DEBUg buNdle generator + syslog-debun --- syslog-ng DEBUg buNdle generator --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md index 9dd5a231..98219b04 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual.md @@ -2,7 +2,7 @@ title: The {{ site.product.short_name }} manual page id: adm-man-syslogng description: >- - syslog-ng --- syslog-ng system logger application + syslog-ng --- syslog-ng system logger application --- ## Synopsis diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md index 7cfed95d..b1bdbe57 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf.md @@ -2,7 +2,7 @@ title: The syslog-ng.conf manual page id: adm-man-syslogng-conf description: >- - syslog-ng.conf --- {{ site.product.short_name }} configuration file + syslog-ng.conf --- {{ site.product.short_name }} configuration file --- ## Synopsis diff --git a/doc/_admin-guide/200_About/002_Glossary.md b/doc/_admin-guide/200_About/002_Glossary.md index cb12cfb7..a21f8cbc 100644 --- a/doc/_admin-guide/200_About/002_Glossary.md +++ b/doc/_admin-guide/200_About/002_Glossary.md @@ -2,7 +2,7 @@ title: Glossary id: adm-about-glossary description: >- - Glossary of {{ site.product.short_name }} + Glossary of {{ site.product.short_name }} --- ## A From 089f446256a0e677a1172dd053ce84b597c8bd10 Mon Sep 17 00:00:00 2001 From: mrgarris0n Date: Mon, 16 Sep 2024 16:17:28 +0200 Subject: [PATCH 17/17] Review note: merged relay section Signed-off-by: mrgarris0n --- ...00_Configuring_syslog-ng_on_relay_hosts.md | 81 ------------------- .../README.md | 79 +++++++++++++++++- 2 files changed, 77 insertions(+), 83 deletions(-) delete mode 100644 doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md diff --git a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md deleted file mode 100644 index 4cadbe28..00000000 --- a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Configuring {{ site.product.short_name }} on relay hosts -id: adm-qs-relay-conf -description: >- - This section explains how to configure {{ site.product.short_name }} on a relay host. ---- - -To configure {{ site.product.short_name }} on a relay host, complete the following steps: - -1. Install the {{ site.product.short_name }} application on the host. For details on - installing {{ site.product.short_name }} on specific operating systems, see - Installing syslog-ng. -2. Configure the network sources that collect the log messages sent by - the clients. - -3. Create a network destination that points to the {{ site.product.short_name }} server. - -4. Create a log statement connecting the network sources to the - {{ site.product.short_name }} server. - -5. Configure the local sources that collect the log messages of the - relay host. - -6. Create a log statement connecting the local sources to the syslog-ng - server. - -7. Enable the keep-hostname() and disable the chain-hostnames() - options. (For details on how these options work, see - chain-hostnames() - - **NOTE:** It is recommended to use these options on your {{ site.product.short_name }} - server as well. - {: .notice--info} - -8. Set filters and options (for example, TLS encryption) as necessary. - - **NOTE:** By default, the {{ site.product.short_name }} server will treat the relayed - messages as if they were created by the relay host, not the host - that originally sent them to the relay. In order to use the original - hostname on the {{ site.product.short_name }} server, use the **keep-hostname(yes)** - option both on the {{ site.product.short_name }} relay and the {{ site.product.short_name }} server. This - option can be set individually for every source if needed. - {: .notice--info} - - If you are relaying log messages and want to resolve IP addresses to - hostnames, configure the first relay to do the name resolution. - - Example: A simple configuration for relays - - The following is a simple configuration file that collects local and - incoming log messages and forwards them to a logserver using the - IETF-syslog protocol. - - ```config - @version: 3.38 - @include "scl.conf" - - options { - time-reap(30); - mark-freq(10); - keep-hostname(yes); - chain-hostnames(no); - }; - - source s_local { - system(); internal(); - }; - - source s_network { - syslog(transport(tcp)); - }; - - destination d_syslog_tcp { - syslog("192.168.1.5" transport("tcp") port(2010)); - }; - - log { - source(s_local); source(s_network); - destination(d_syslog_tcp); - }; - ``` diff --git a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md index 14ee93f2..7735d55c 100644 --- a/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md +++ b/doc/_admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README.md @@ -1,6 +1,81 @@ --- title: Configuring {{ site.product.short_name }} relays -id: adm-qs-conf +id: adm-qs-relay-conf description: >- - This chapter describes how to configure {{ site.product.short_name }} as a relay. + This section describes how to configure {{ site.product.short_name }} as a relay. --- + +To configure {{ site.product.short_name }} as a relay, complete the following steps: + +1. Install the {{ site.product.short_name }} application on the host. For details on + installing {{ site.product.short_name }} on specific operating systems, see + Installing syslog-ng. +2. Configure the network sources that collect the log messages sent by + the clients. + +3. Create a network destination that points to the {{ site.product.short_name }} server. + +4. Create a log statement connecting the network sources to the + {{ site.product.short_name }} server. + +5. Configure the local sources that collect the log messages of the + relay host. + +6. Create a log statement connecting the local sources to the syslog-ng + server. + +7. Enable the keep-hostname() and disable the chain-hostnames() + options. (For details on how these options work, see + chain-hostnames() + + **NOTE:** It is recommended to use these options on your {{ site.product.short_name }} + server as well. + {: .notice--info} + +8. Set filters and options (for example, TLS encryption) as necessary. + + **NOTE:** By default, the {{ site.product.short_name }} server will treat the relayed + messages as if they were created by the relay host, not the host + that originally sent them to the relay. In order to use the original + hostname on the {{ site.product.short_name }} server, use the **keep-hostname(yes)** + option both on the {{ site.product.short_name }} relay and the {{ site.product.short_name }} server. This + option can be set individually for every source if needed. + {: .notice--info} + + If you are relaying log messages and want to resolve IP addresses to + hostnames, configure the first relay to do the name resolution. + + Example: A simple configuration for relays + + The following is a simple configuration file that collects local and + incoming log messages and forwards them to a logserver using the + IETF-syslog protocol. + + ```config + @version: 3.38 + @include "scl.conf" + + options { + time-reap(30); + mark-freq(10); + keep-hostname(yes); + chain-hostnames(no); + }; + + source s_local { + system(); internal(); + }; + + source s_network { + syslog(transport(tcp)); + }; + + destination d_syslog_tcp { + syslog("192.168.1.5" transport("tcp") port(2010)); + }; + + log { + source(s_local); source(s_network); + destination(d_syslog_tcp); + }; + ```