From 87451e468eae338dd12367c70d5ba97805d26b41 Mon Sep 17 00:00:00 2001 From: Bence Csati Date: Tue, 23 Dec 2025 08:20:14 +0100 Subject: [PATCH] chore: cleanup docs Signed-off-by: Bence Csati --- .../plugins/filters/enhance_k8s.md | 139 ------------ .../plugins/filters/sumologic.md | 200 ------------------ .../plugins/outputs/sumologic.md | 176 --------------- .../plugins/syslogng/filters/match.md | 102 --------- .../plugins/syslogng/filters/parser.md | 57 ----- .../plugins/syslogng/filters/rewrite.md | 123 ----------- .../plugins/syslogng/outputs/disk_buffer.md | 58 ----- .../plugins/syslogng/outputs/file.md | 61 ------ .../plugins/syslogng/outputs/loggly.md | 38 ---- .../syslogng/outputs/sumologic_http.md | 70 ------ .../syslogng/outputs/sumologic_syslog.md | 54 ----- .../plugins/syslogng/outputs/syslog.md | 100 --------- .../plugins/syslogng/outputs/tls.md | 50 ----- 13 files changed, 1228 deletions(-) delete mode 100644 docs/configuration/plugins/filters/enhance_k8s.md delete mode 100644 docs/configuration/plugins/filters/sumologic.md delete mode 100644 docs/configuration/plugins/outputs/sumologic.md delete mode 100644 docs/configuration/plugins/syslogng/filters/match.md delete mode 100644 docs/configuration/plugins/syslogng/filters/parser.md delete mode 100644 docs/configuration/plugins/syslogng/filters/rewrite.md delete mode 100644 docs/configuration/plugins/syslogng/outputs/disk_buffer.md delete mode 100644 docs/configuration/plugins/syslogng/outputs/file.md delete mode 100644 docs/configuration/plugins/syslogng/outputs/loggly.md delete mode 100644 docs/configuration/plugins/syslogng/outputs/sumologic_http.md delete mode 100644 docs/configuration/plugins/syslogng/outputs/sumologic_syslog.md delete mode 100644 docs/configuration/plugins/syslogng/outputs/syslog.md delete mode 100644 docs/configuration/plugins/syslogng/outputs/tls.md diff --git a/docs/configuration/plugins/filters/enhance_k8s.md b/docs/configuration/plugins/filters/enhance_k8s.md deleted file mode 100644 index 2dc6e9510..000000000 --- a/docs/configuration/plugins/filters/enhance_k8s.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: Enhance K8s Metadata -weight: 200 -generated_file: true ---- - -# [Enhance K8s Metadata](https://github.com/SumoLogic/sumologic-kubernetes-fluentd/tree/main/fluent-plugin-enhance-k8s-metadata) -## Overview - Fluentd Filter plugin to fetch several metadata for a Pod - -## Configuration -## EnhanceK8s - -### api_groups ([]string, optional) {#enhancek8s-api_groups} - -Kubernetes resources api groups - -Default: `["apps/v1", "extensions/v1beta1"]` - -### bearer_token_file (string, optional) {#enhancek8s-bearer_token_file} - -Bearer token path - -Default: nil - -### ca_file (secret.Secret, optional) {#enhancek8s-ca_file} - -Kubernetes API CA file - -Default: nil - -### cache_refresh (int, optional) {#enhancek8s-cache_refresh} - -Cache refresh - -Default: 60*60 - -### cache_refresh_variation (int, optional) {#enhancek8s-cache_refresh_variation} - -Cache refresh variation - -Default: 60*15 - -### cache_size (int, optional) {#enhancek8s-cache_size} - -Cache size - -Default: 1000 - -### cache_ttl (int, optional) {#enhancek8s-cache_ttl} - -Cache TTL - -Default: 60*60*2 - -### client_cert (secret.Secret, optional) {#enhancek8s-client_cert} - -Kubernetes API Client certificate - -Default: nil - -### client_key (secret.Secret, optional) {#enhancek8s-client_key} - -// Kubernetes API Client certificate key - -Default: nil - -### core_api_versions ([]string, optional) {#enhancek8s-core_api_versions} - -Kubernetes core API version (for different Kubernetes versions) - -Default: ['v1'] - -### data_type (string, optional) {#enhancek8s-data_type} - -Sumologic data type - -Default: metrics - -### in_namespace_path ([]string, optional) {#enhancek8s-in_namespace_path} - -parameters for read/write record - -Default: `['$.namespace']` - -### in_pod_path ([]string, optional) {#enhancek8s-in_pod_path} - -Default: `['$.pod','$.pod_name']` - -### kubernetes_url (string, optional) {#enhancek8s-kubernetes_url} - -Kubernetes API URL - -Default: nil - -### ssl_partial_chain (*bool, optional) {#enhancek8s-ssl_partial_chain} - -If `ca_file` is for an intermediate CA, or otherwise we do not have the root CA and want to trust the intermediate CA certs we do have, set this to `true` - this corresponds to the openssl s_client -partial_chain flag and X509_V_FLAG_PARTIAL_CHAIN - -Default: false - -### secret_dir (string, optional) {#enhancek8s-secret_dir} - -Service account directory - -Default: /var/run/secrets/kubernetes.io/serviceaccount - -### verify_ssl (*bool, optional) {#enhancek8s-verify_ssl} - -Verify SSL - -Default: true - - - - -## Example `EnhanceK8s` filter configurations - -{{< highlight yaml >}} -apiVersion: logging.banzaicloud.io/v1beta1 -kind: Logging -metadata: - name: demo-flow -spec: - globalFilters: - - enhanceK8s: {} -{{}} - -Fluentd config result: - -{{< highlight xml >}} - - @type enhance_k8s_metadata - @id test_enhanceK8s - -{{}} - - ---- diff --git a/docs/configuration/plugins/filters/sumologic.md b/docs/configuration/plugins/filters/sumologic.md deleted file mode 100644 index eb6ec3873..000000000 --- a/docs/configuration/plugins/filters/sumologic.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -title: SumoLogic -weight: 200 -generated_file: true ---- - -# Sumo Logic collection solution for Kubernetes -## Overview - More info at https://github.com/SumoLogic/sumologic-kubernetes-collection - -## Configuration -## SumoLogic - -### collector_key_name (string, optional) {#sumologic-collector_key_name} - -CollectorKey Name - -Default: `_collector` - -### collector_value (string, optional) {#sumologic-collector_value} - -Collector Value - -Default: "undefined" - -### exclude_container_regex (string, optional) {#sumologic-exclude_container_regex} - -Exclude Container Regex - -Default: "" - -### exclude_facility_regex (string, optional) {#sumologic-exclude_facility_regex} - -Exclude Facility Regex - -Default: "" - -### exclude_host_regex (string, optional) {#sumologic-exclude_host_regex} - -Exclude Host Regex - -Default: "" - -### exclude_namespace_regex (string, optional) {#sumologic-exclude_namespace_regex} - -Exclude Namespace Regex - -Default: "" - -### exclude_pod_regex (string, optional) {#sumologic-exclude_pod_regex} - -Exclude Pod Regex - -Default: "" - -### exclude_priority_regex (string, optional) {#sumologic-exclude_priority_regex} - -Exclude Priority Regex - -Default: "" - -### exclude_unit_regex (string, optional) {#sumologic-exclude_unit_regex} - -Exclude Unit Regex - -Default: "" - -### log_format (string, optional) {#sumologic-log_format} - -Log Format - -Default: json - -### source_category (string, optional) {#sumologic-source_category} - -Source Category - -Default: `%{namespace}/%{pod_name}` - -### source_category_key_name (string, optional) {#sumologic-source_category_key_name} - -Source CategoryKey Name - -Default: `_sourceCategory` - -### source_category_prefix (string, optional) {#sumologic-source_category_prefix} - -Source Category Prefix - -Default: kubernetes/ - -### source_category_replace_dash (string, optional) {#sumologic-source_category_replace_dash} - -Source Category Replace Dash - -Default: "/" - -### source_host (string, optional) {#sumologic-source_host} - -Source Host - -Default: "" - -### source_host_key_name (string, optional) {#sumologic-source_host_key_name} - -Source HostKey Name - -Default: `_sourceHost` - -### source_name (string, optional) {#sumologic-source_name} - -Source Name - -Default: `%{namespace}.%{pod}.%{container}` - -### source_name_key_name (string, optional) {#sumologic-source_name_key_name} - -Source NameKey Name - -Default: `_sourceName` - -### tracing_annotation_prefix (string, optional) {#sumologic-tracing_annotation_prefix} - -Tracing Annotation Prefix - -Default: `pod_annotation_` - -### tracing_container_name (string, optional) {#sumologic-tracing_container_name} - -Tracing Container Name - -Default: "container_name" - -### tracing_format (*bool, optional) {#sumologic-tracing_format} - -Tracing Format - -Default: false - -### tracing_host (string, optional) {#sumologic-tracing_host} - -Tracing Host - -Default: "hostname" - -### tracing_label_prefix (string, optional) {#sumologic-tracing_label_prefix} - -Tracing Label Prefix - -Default: `pod_label_` - -### tracing_namespace (string, optional) {#sumologic-tracing_namespace} - -Tracing Namespace - -Default: "namespace" - -### tracing_pod (string, optional) {#sumologic-tracing_pod} - -Tracing Pod - -Default: "pod" - -### tracing_pod_id (string, optional) {#sumologic-tracing_pod_id} - -Tracing Pod ID - -Default: "pod_id" - - - - -## Example `Parser` filter configurations - -{{< highlight yaml >}} -apiVersion: logging.banzaicloud.io/v1beta1 -kind: Flow -metadata: - name: demo-flow -spec: - filters: - - sumologic: - source_name: "elso" - selectors: {} - localOutputRefs: - - demo-output -{{}} - -Fluentd config result: - -{{< highlight xml >}} - - @type kubernetes_sumologic - @id test_sumologic - source_name elso - -{{}} - - ---- diff --git a/docs/configuration/plugins/outputs/sumologic.md b/docs/configuration/plugins/outputs/sumologic.md deleted file mode 100644 index 837e159e2..000000000 --- a/docs/configuration/plugins/outputs/sumologic.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -title: SumoLogic -weight: 200 -generated_file: true ---- - -# SumoLogic output plugin for Fluentd -## Overview - -This plugin has been designed to output logs or metrics to SumoLogic via a HTTP collector endpoint -For details, see [https://github.com/SumoLogic/fluentd-output-sumologic](https://github.com/SumoLogic/fluentd-output-sumologic). - -## Example secret for HTTP input URL: - -``` -export URL='https://endpoint1.collection.eu.sumologic.com/receiver/v1/http/' -kubectl create secret generic sumo-output --from-literal "endpoint=$URL" -``` - -## Example ClusterOutput - -```yaml -apiVersion: logging.banzaicloud.io/v1beta1 -kind: ClusterOutput -metadata: - name: sumo-output -spec: - sumologic: - buffer: - flush_interval: 10s - flush_mode: interval - compress: true - endpoint: - valueFrom: - secretKeyRef: - key: endpoint - name: sumo-output - source_name: test1 -``` - - -## Configuration -## Output Config - -### add_timestamp (bool, optional) {#output config-add_timestamp} - -Add timestamp (or timestamp_key) field to logs before sending to SumoLogic - -Default: true - -### buffer (*Buffer, optional) {#output config-buffer} - -[Buffer](../buffer/) - - -### compress (*bool, optional) {#output config-compress} - -Compress payload - -Default: false - -### compress_encoding (string, optional) {#output config-compress_encoding} - -Encoding method of compression (either gzip or deflate) - -Default: gzip - -### custom_dimensions (string, optional) {#output config-custom_dimensions} - -Dimensions string (eg "cluster=payment, service=credit_card") which is going to be added to every metric record. - - -### custom_fields ([]string, optional) {#output config-custom_fields} - -Comma-separated key=value list of fields to apply to every log. [More information](https://help.sumologic.com/Manage/Fields#http-source-fields) - - -### data_type (string, optional) {#output config-data_type} - -The type of data that will be sent to Sumo Logic, either logs or metrics - -Default: logs - -### delimiter (string, optional) {#output config-delimiter} - -Delimiter - -Default: . - -### disable_cookies (bool, optional) {#output config-disable_cookies} - -Option to disable cookies on the HTTP Client. - -Default: false - -### endpoint (*secret.Secret, required) {#output config-endpoint} - -SumoLogic HTTP Collector URL - - -### log_format (string, optional) {#output config-log_format} - -Format to post logs into Sumo. - -Default: json - -### log_key (string, optional) {#output config-log_key} - -Used to specify the key when merging json or sending logs in text format - -Default: message - -### metric_data_format (string, optional) {#output config-metric_data_format} - -The format of metrics you will be sending, either graphite or carbon2 or prometheus - -Default: graphite - -### open_timeout (int, optional) {#output config-open_timeout} - -Set timeout seconds to wait until connection is opened. - -Default: 60 - -### proxy_uri (string, optional) {#output config-proxy_uri} - -Add the uri of the proxy environment if present. - - -### slow_flush_log_threshold (string, optional) {#output config-slow_flush_log_threshold} - -The threshold for chunk flush performance check. Parameter type is float, not time, default: 20.0 (seconds) If chunk flush takes longer time than this threshold, fluentd logs warning message and increases metric fluentd_output_status_slow_flush_count. - - -### source_category (string, optional) {#output config-source_category} - -Set _sourceCategory metadata field within SumoLogic - -Default: nil - -### source_host (string, optional) {#output config-source_host} - -Set _sourceHost metadata field within SumoLogic - -Default: nil - -### source_name (string, required) {#output config-source_name} - -Set _sourceName metadata field within SumoLogic - overrides source_name_key (default is nil) - - -### source_name_key (string, optional) {#output config-source_name_key} - -Set as source::path_key's value so that the source_name can be extracted from Fluentd's buffer - -Default: source_name - -### sumo_client (string, optional) {#output config-sumo_client} - -Name of sumo client which is send as X-Sumo-Client header - -Default: fluentd-output - -### timestamp_key (string, optional) {#output config-timestamp_key} - -Field name when add_timestamp is on - -Default: timestamp - -### verify_ssl (bool, optional) {#output config-verify_ssl} - -Verify ssl certificate. - -Default: true - - diff --git a/docs/configuration/plugins/syslogng/filters/match.md b/docs/configuration/plugins/syslogng/filters/match.md deleted file mode 100644 index 2eb648b3f..000000000 --- a/docs/configuration/plugins/syslogng/filters/match.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: Syslog-NG match -weight: 200 -generated_file: true ---- - -# [Syslog-NG Match Filter](https://docs.fluentd.org/filter/grep) -## Overview - The match filter can be used to selectively keep records - -## Configuration -## MatchExpr - -### and ([]MatchExpr, optional) {#matchexpr-and} - -[And Directive](#And-Directive) - -Default: - - -### not (*MatchExpr, optional) {#matchexpr-not} - -[Not Directive](#Exclude-Directive) - -Default: - - -### regexp (*RegexpMatchExpr, optional) {#matchexpr-regexp} - -[Regexp Directive](#Regexp-Directive) - -Default: - - -### or ([]MatchExpr, optional) {#matchexpr-or} - -[Or Directive](#Or-Directive) - -Default: - - - -## [Regexp Directive](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/68#TOPIC-1829171) {#Regexp-Directive} - -Specify filtering rule. - -### pattern (string, required) {#[regexp directive](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/68#topic-1829171) {#regexp-directive}-pattern} - -Pattern expression to evaluate - -Default: - - -### template (string, optional) {#[regexp directive](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/68#topic-1829171) {#regexp-directive}-template} - -Specify a template of the record fields to match against. - -Default: - - -### value (string, optional) {#[regexp directive](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/68#topic-1829171) {#regexp-directive}-value} - -Specify a field name of the record to match against the value of. - -Default: - - -### flags ([]string, optional) {#[regexp directive](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/68#topic-1829171) {#regexp-directive}-flags} - -Pattern flags - -Default: - - -### type (string, optional) {#[regexp directive](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/68#topic-1829171) {#regexp-directive}-type} - -Pattern type - -Default: - - - - #### Example `Regexp` filter configurations - ```yaml -apiVersion: logging.banzaicloud.io/v1beta1 -kind: Flow -metadata: - name: demo-flow -spec: - filters: - - match: - regexp: - - value: first - pattern: ^5\d\d$ - match: {} - localOutputRefs: - - demo-output - ``` - - #### Syslog-NG Config Result - ``` - log { - source(main_input); - filter { - match("^5\d\d$" value("first")); - }; - destination(output_default_demo-output); - }; - ``` - ---- diff --git a/docs/configuration/plugins/syslogng/filters/parser.md b/docs/configuration/plugins/syslogng/filters/parser.md deleted file mode 100644 index a8eefc6ee..000000000 --- a/docs/configuration/plugins/syslogng/filters/parser.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Syslog-NG parser -weight: 200 -generated_file: true ---- - -# [Syslog-NG Parser Filter](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/90) -## Overview - -## Configuration -## [Parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/82#TOPIC-1768819) - -### regexp (*RegexpParser, optional) {#[parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/82#topic-1768819)-regexp} - -Default: - - -### syslog-parser (*SyslogParser, optional) {#[parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/82#topic-1768819)-syslog-parser} - -Default: - - - -## [Regexp parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/90) - -### patterns ([]string, required) {#[regexp parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/90)-patterns} - -The regular expression patterns that you want to find a match. regexp-parser() supports multiple patterns, and stops the processing at the first successful match. - -Default: - - -### prefix (string, optional) {#[regexp parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/90)-prefix} - -Insert a prefix before the name part of the parsed name-value pairs to help further processing. - -Default: - - -### template (string, optional) {#[regexp parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/90)-template} - -Specify a template of the record fields to match against. - -Default: - - -### flags ([]string, optional) {#[regexp parser](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.36/administration-guide/90)-flags} - -Pattern flags - -Default: - - - -## SyslogParser - -### flags ([]string, optional) {#syslogparser-flags} - -Pattern flags - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/filters/rewrite.md b/docs/configuration/plugins/syslogng/filters/rewrite.md deleted file mode 100644 index 45a018a2a..000000000 --- a/docs/configuration/plugins/syslogng/filters/rewrite.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: Syslog-NG rewrite -weight: 200 -generated_file: true ---- - -# [Syslog-NG Rewrite Filter](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/77) -## Overview - The syslog-ng rewrite filter can be used to replace message parts. - -## Configuration -## RewriteConfig - -### group_unset (*GroupUnsetConfig, optional) {#rewriteconfig-group_unset} - -Default: - - -### rename (*RenameConfig, optional) {#rewriteconfig-rename} - -Default: - - -### set (*SetConfig, optional) {#rewriteconfig-set} - -Default: - - -### subst (*SubstituteConfig, optional) {#rewriteconfig-subst} - -Default: - - -### unset (*UnsetConfig, optional) {#rewriteconfig-unset} - -Default: - - - -## RenameConfig - -https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/78#TOPIC-1829213 - -### oldName (string, required) {#renameconfig-oldname} - -Default: - - -### newName (string, required) {#renameconfig-newname} - -Default: - - -### condition (*MatchExpr, optional) {#renameconfig-condition} - -Default: - - - -## SetConfig - -https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/77#TOPIC-1829207 - -### field (string, required) {#setconfig-field} - -Default: - - -### value (string, required) {#setconfig-value} - -Default: - - -### condition (*MatchExpr, optional) {#setconfig-condition} - -Default: - - - -## SubstituteConfig - -https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/77#TOPIC-1829206 - -### pattern (string, required) {#substituteconfig-pattern} - -Default: - - -### replace (string, required) {#substituteconfig-replace} - -Default: - - -### field (string, required) {#substituteconfig-field} - -Default: - - -### flags ([]string, optional) {#substituteconfig-flags} - -Default: - - -### type (string, optional) {#substituteconfig-type} - -Default: - - -### condition (*MatchExpr, optional) {#substituteconfig-condition} - -Default: - - - -## UnsetConfig - -https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/78#TOPIC-1829212 - -### field (string, required) {#unsetconfig-field} - -Default: - - -### condition (*MatchExpr, optional) {#unsetconfig-condition} - -Default: - - - -## GroupUnsetConfig - -https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/78#TOPIC-1829212 - -### pattern (string, required) {#groupunsetconfig-pattern} - -Default: - - -### condition (*MatchExpr, optional) {#groupunsetconfig-condition} - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/outputs/disk_buffer.md b/docs/configuration/plugins/syslogng/outputs/disk_buffer.md deleted file mode 100644 index 15b8f149b..000000000 --- a/docs/configuration/plugins/syslogng/outputs/disk_buffer.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: Syslog-ng DiskBuffer -weight: 200 -generated_file: true ---- - -# disk_buffer -## Overview - More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/32#kanchor2338 - -## Configuration -## DiskBuffer - -Documentation: https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#TOPIC-1829124 - -### disk_buf_size (int64, required) {#diskbuffer-disk_buf_size} - -This is a required option. The maximum size of the disk-buffer in bytes. The minimum value is 1048576 bytes. - -Default: - - -### reliable (bool, required) {#diskbuffer-reliable} - -If set to yes, syslog-ng OSE cannot lose logs in case of reload/restart, unreachable destination or syslog-ng OSE crash. This solution provides a slower, but reliable disk-buffer option. - -Default: - - -### compaction (*bool, optional) {#diskbuffer-compaction} - -Prunes the unused space in the LogMessage representation - -Default: - - -### dir (string, optional) {#diskbuffer-dir} - -Description: Defines the folder where the disk-buffer files are stored. - -Default: - - -### mem_buf_length (*int64, optional) {#diskbuffer-mem_buf_length} - -Use this option if the option reliable() is set to no. This option contains the number of messages stored in overflow queue. - -Default: - - -### mem_buf_size (*int64, optional) {#diskbuffer-mem_buf_size} - -Use this option if the option reliable() is set to yes. This option contains the size of the messages in bytes that is used in the memory part of the disk buffer. - -Default: - - -### qout_size (*int64, optional) {#diskbuffer-qout_size} - -The number of messages stored in the output buffer of the destination. - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/outputs/file.md b/docs/configuration/plugins/syslogng/outputs/file.md deleted file mode 100644 index 1ba23069b..000000000 --- a/docs/configuration/plugins/syslogng/outputs/file.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: File -weight: 200 -generated_file: true ---- - -# File output plugin for syslog-ng -## Overview - Storing messages in plain-text files - More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#TOPIC-1829124 - -## Configuration -## FileOutput - -Documentation: https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/36#TOPIC-1829044 - -### path (string, required) {#fileoutput-path} - -Store file path - -Default: - - -### create_dirs (bool, optional) {#fileoutput-create_dirs} - -Enable creating non-existing directories. - -Default: false - -### dir_group (string, optional) {#fileoutput-dir_group} - -The group of the directories created by syslog-ng. To preserve the original properties of an existing directory, use the option without specifying an attribute: dir-group(). - -Default: Use the global settings - -### dir_owner (string, optional) {#fileoutput-dir_owner} - -The owner of the directories created by syslog-ng. To preserve the original properties of an existing directory, use the option without specifying an attribute: dir-owner(). - -Default: Use the global settings - -### dir_perm (int, optional) {#fileoutput-dir_perm} - -The permission mask of directories created by syslog-ng. Log directories are only created if a file after macro expansion refers to a non-existing directory, and directory creation is enabled (see also the create-dirs() option). For octal numbers prefix the number with 0, for example use 0755 for rwxr-xr-x. - -Default: Use the global settings - -### disk_buffer (*DiskBuffer, optional) {#fileoutput-disk_buffer} - -This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. - -Default: false - -### template (string, optional) {#fileoutput-template} - -Default: - - -### persist_name (string, optional) {#fileoutput-persist_name} - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/outputs/loggly.md b/docs/configuration/plugins/syslogng/outputs/loggly.md deleted file mode 100644 index c279622ea..000000000 --- a/docs/configuration/plugins/syslogng/outputs/loggly.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Loggly output -weight: 200 -generated_file: true ---- - -# Loggly output plugin for syslog-ng -## Overview - More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/43#TOPIC-1829072 - -## Configuration -## Loggly - -### host (string, optional) {#loggly-host} - -Address of the destination host - -Default: - - -### tag (string, optional) {#loggly-tag} - -Event tag [more information](https://documentation.solarwinds.com/en/success_center/loggly/content/admin/tags.htm) - -Default: - - -### token (*secret.Secret, required) {#loggly-token} - -Your Customer Token that you received from Loggly [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/43#loggly-option-token) - -Default: - - -### (SyslogOutput, required) {#loggly-} - -syslog output configuration - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/outputs/sumologic_http.md b/docs/configuration/plugins/syslogng/outputs/sumologic_http.md deleted file mode 100644 index 507c2c2f9..000000000 --- a/docs/configuration/plugins/syslogng/outputs/sumologic_http.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Sumo Logic HTTP -weight: 200 -generated_file: true ---- - -# Storing messages in Sumo Logic over http -## Overview - More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/55 - -## Configuration -## SumologicHTTPOutput - -### collector (*secret.Secret, optional) {#sumologichttpoutput-collector} - -The Cloud Syslog Cloud Token that you received from the Sumo Logic service while configuring your cloud syslog source. - -Default: empty - -### deployment (string, optional) {#sumologichttpoutput-deployment} - -This option specifies your Sumo Logic deployment.https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security - -Default: empty - -### headers ([]string, optional) {#sumologichttpoutput-headers} - -Custom HTTP headers to include in the request, for example, headers("HEADER1: header1", "HEADER2: header2"). - -Default: empty - -### time_reopen (int, optional) {#sumologichttpoutput-time_reopen} - -The time to wait in seconds before a dead connection is reestablished. - -Default: 60 - -### tls (*TLS, optional) {#sumologichttpoutput-tls} - -This option sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. TLS can be used only with tcp-based transport protocols. For details, see https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#TOPIC-1829193 - -Default: - - -### disk_buffer (*DiskBuffer, optional) {#sumologichttpoutput-disk_buffer} - -This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. - -Default: false - -### body (string, optional) {#sumologichttpoutput-body} - -Default: - - -### batch-lines (int, optional) {#sumologichttpoutput-batch-lines} - -Default: - - -### batch-bytes (int, optional) {#sumologichttpoutput-batch-bytes} - -Default: - - -### batch-timeout (int, optional) {#sumologichttpoutput-batch-timeout} - -Default: - - -### persist_name (string, optional) {#sumologichttpoutput-persist_name} - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/outputs/sumologic_syslog.md b/docs/configuration/plugins/syslogng/outputs/sumologic_syslog.md deleted file mode 100644 index a9b5e955a..000000000 --- a/docs/configuration/plugins/syslogng/outputs/sumologic_syslog.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Sumo Logic HTTP -weight: 200 -generated_file: true ---- - -# Storing messages in Sumo Logic over http -## Overview - More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#TOPIC-1829122 - -## Configuration -## SumologicSyslogOutput - -### port (int, optional) {#sumologicsyslogoutput-port} - -This option sets the port number of the Sumo Logic server to connect to. - -Default: 6514 - -### deployment (string, optional) {#sumologicsyslogoutput-deployment} - -This option specifies your Sumo Logic deployment.https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-by-Deployment-and-Firewall-Security - -Default: empty - -### tag (string, optional) {#sumologicsyslogoutput-tag} - -This option specifies the list of tags to add as the tags fields of Sumo Logic messages. If not specified, syslog-ng OSE automatically adds the tags already assigned to the message. If you set the tag() option, only the tags you specify will be added to the messages. - -Default: tag - -### token (int, optional) {#sumologicsyslogoutput-token} - -The Cloud Syslog Cloud Token that you received from the Sumo Logic service while configuring your cloud syslog source. https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-Syslog-Source#configure-a-cloud%C2%A0syslog%C2%A0source - -Default: - - -### tls (*TLS, optional) {#sumologicsyslogoutput-tls} - -This option sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. TLS can be used only with tcp-based transport protocols. For details, see https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#TOPIC-1829193 - -Default: - - -### disk_buffer (*DiskBuffer, optional) {#sumologicsyslogoutput-disk_buffer} - -This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. - -Default: false - -### persist_name (string, optional) {#sumologicsyslogoutput-persist_name} - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/outputs/syslog.md b/docs/configuration/plugins/syslogng/outputs/syslog.md deleted file mode 100644 index e3cbcf40d..000000000 --- a/docs/configuration/plugins/syslogng/outputs/syslog.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: syslog-ng syslog (rfc5424) output -weight: 200 -generated_file: true ---- - -# Syslog output configuration -## Overview - More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/32#kanchor2338 - -## Configuration -## SyslogOutput - -Documentation: https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#TOPIC-1829124 - -### host (string, optional) {#syslogoutput-host} - -Address of the destination host - -Default: - - -### port (int, optional) {#syslogoutput-port} - -The port number to connect to. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor895) - -Default: - - -### transport (string, optional) {#syslogoutput-transport} - -Specifies the protocol used to send messages to the destination server. [more information]() [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor911) - -Default: - - -### close_on_input (*bool, optional) {#syslogoutput-close_on_input} - -By default, syslog-ng OSE closes destination sockets if it receives any input from the socket (for example, a reply). If this option is set to no, syslog-ng OSE just ignores the input, but does not close the socket. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor859) - -Default: - - -### flags ([]string, optional) {#syslogoutput-flags} - -Flags influence the behavior of the destination driver. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor877) - -Default: - - -### flush_lines (int, optional) {#syslogoutput-flush_lines} - -Specifies how many lines are flushed to a destination at a time. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor880) - -Default: - - -### so_keepalive (*bool, optional) {#syslogoutput-so_keepalive} - -Enables keep-alive messages, keeping the socket open. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor897) - -Default: - - -### suppress (int, optional) {#syslogoutput-suppress} - -Specifies the number of seconds syslog-ng waits for identical messages. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor901) - -Default: - - -### template (string, optional) {#syslogoutput-template} - -Specifies a template defining the logformat to be used in the destination. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor905) - -Default: 0 - -### template_escape (*bool, optional) {#syslogoutput-template_escape} - -Turns on escaping for the ', ", and backspace characters in templated output files. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor906) - -Default: - - -### tls (*TLS, optional) {#syslogoutput-tls} - -Sets various options related to TLS encryption, for example, key/certificate files and trusted CA locations. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor910) - -Default: - - -### ts_format (string, optional) {#syslogoutput-ts_format} - -Override the global timestamp format (set in the global ts-format() parameter) for the specific destination. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor912) - -Default: - - -### disk_buffer (*DiskBuffer, optional) {#syslogoutput-disk_buffer} - -Enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/56#kanchor860) - -Default: - - -### persist_name (string, optional) {#syslogoutput-persist_name} - -Unique name for the syslog-ng driver [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.16/administration-guide/persist-name) - -Default: - - - diff --git a/docs/configuration/plugins/syslogng/outputs/tls.md b/docs/configuration/plugins/syslogng/outputs/tls.md deleted file mode 100644 index 962e00bea..000000000 --- a/docs/configuration/plugins/syslogng/outputs/tls.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: TLS config for syslog-ng outputs -weight: 200 -generated_file: true ---- - -# TLS config for syslog-ng outputs -## Overview - More info at https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/32#kanchor2338 - -## Configuration -## TLS - -### ca_dir (*secret.Secret, optional) {#tls-ca_dir} - -The name of a directory that contains a set of trusted CA certificates in PEM format. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3142) - -Default: - - -### ca_file (*secret.Secret, optional) {#tls-ca_file} - -The name of a file that contains a set of trusted CA certificates in PEM format. (Optional) [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3144) - -Default: - - -### key_file (*secret.Secret, optional) {#tls-key_file} - -The name of a file that contains an unencrypted private key in PEM format, suitable as a TLS key. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3163) - -Default: - - -### cert_file (*secret.Secret, optional) {#tls-cert_file} - -Name of a file, that contains an X.509 certificate (or a certificate chain) in PEM format, suitable as a TLS certificate, matching the private key set in the key-file() option. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#kanchor3146) - -Default: - - -### peer_verify (string, optional) {#tls-peer_verify} - -Verification method of the peer. [more information](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/73#tls-options-peer-verify) - -Default: - - -### use-system-cert-store (*bool, optional) {#tls-use-system-cert-store} - -Use the certificate store of the system for verifying HTTPS certificates. [more information](https://curl.se/docs/sslcerts.html) - -Default: - - -