Generated doc fixes 4.5 (kube-logging#1619)

Signed-off-by: Peter Wilcsinszky <[email protected]> Signed-off-by: Robert Fekete <[email protected]> Co-authored-by: Peter Wilcsinszky <[email protected]>
h4wkmoon · Jan 16, 2024 · 12220f1 · 12220f1
1 parent fc1658a
commit 12220f1
Show file tree

Hide file tree

Showing 93 changed files with 430 additions and 334 deletions.
diff --git a/docs/configuration/crds/v1beta1/fluentbit_types.md b/docs/configuration/crds/v1beta1/fluentbit_types.md
@@ -76,7 +76,7 @@ Default: 24576
 
 ### customParsers (string, optional) {#fluentbitspec-customparsers}
 
-Available in Logging operator version 4.2 and later. Specify a custom parser file to load in addition to the default parsers file. It must be a valid key in the configmap specified by customConfig 
+Available in Logging operator version 4.2 and later. Specify a custom parser file to load in addition to the default parsers file. It must be a valid key in the configmap specified by customConfig. 
 
 
 ### dnsConfig (*corev1.PodDNSConfig, optional) {#fluentbitspec-dnsconfig}
@@ -124,13 +124,13 @@ Default: 1
 
 ### grace (int32, optional) {#fluentbitspec-grace}
 
-Set the grace time in seconds as Integer value. The engine loop uses a Grace timeout to define wait time on exit (default: 5) 
+Set the grace time in seconds as Integer value. The engine loop uses a Grace timeout to define wait time on exit. 
 
 Default: 5
 
 ### healthCheck (*HealthCheck, optional) {#fluentbitspec-healthcheck}
 
-The following example defines a [Fluentd parser]({{< relref "/docs/configuration/plugins/filters/parser.md" >}}) that places the parsed containerd log messages into the `log` field instead of the `message` field. 
+Available in Logging operator version 4.4 and later. 
 
 
 ### HostNetwork (bool, optional) {#fluentbitspec-hostnetwork}
@@ -153,7 +153,7 @@ The following example defines a [Fluentd parser]({{< relref "/docs/configuration
 
 ### logLevel (string, optional) {#fluentbitspec-loglevel}
 
-Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug.  Note that trace mode is only available if Fluent Bit was built with the WITH_TRACE option enabled. (default: info) 
+Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug.  Note that trace mode is only available if Fluent Bit was built with the WITH_TRACE option enabled. 
 
 Default: info
 
@@ -353,7 +353,7 @@ Default: normal
 
 ## HealthCheck
 
-HealthCheck configuration
+HealthCheck configuration. Available in Logging operator version 4.4 and later.
 
 ### hcErrorsCount (int, optional) {#healthcheck-hcerrorscount}
 
@@ -634,7 +634,7 @@ Default: 600
 
 ### Kube_URL (string, optional) {#filterkubernetes-kube_url}
 
-API Server end-point (default: `https://kubernetes.default.svc:443`) 
+API Server end-point. 
 
 Default: https://kubernetes.default.svc:443
 
@@ -968,7 +968,7 @@ ForwardOptions defines custom forward output plugin options, see https://docs.fl
 
 ### Workers (*int, optional) {#forwardoptions-workers}
 
-Enables dedicated thread(s) for this output. Default value (2) is set since version 1.8.13. For previous versions is 0. 
+Available in Logging operator version 4.4 and later. Enables dedicated thread(s) for this output. Default value (2) is set since version 1.8.13. For previous versions is 0. 
 
 
 
diff --git a/docs/configuration/crds/v1beta1/fluentd_types.md b/docs/configuration/crds/v1beta1/fluentd_types.md
@@ -147,6 +147,8 @@ Fluentd port inside the container (24240 by default). The headless service port
 
 ### sidecarContainers ([]corev1.Container, optional) {#fluentdspec-sidecarcontainers}
 
+Available in Logging operator version 4.5 and later. Configure sidecar container in Fluentd pods, for example: [https://github.com/kube-logging/logging-operator/config/samples/logging_logging_fluentd_sidecars.yaml](https://github.com/kube-logging/logging-operator/config/samples/logging_logging_fluentd_sidecars.yaml). 
+
 
 ### statefulsetAnnotations (map[string]string, optional) {#fluentdspec-statefulsetannotations}
 

diff --git a/docs/configuration/crds/v1beta1/logging_types.md b/docs/configuration/crds/v1beta1/logging_types.md
@@ -129,7 +129,7 @@ Result of the config check. Under normal conditions there is a single item in th
 
 ### fluentdConfigName (string, optional) {#loggingstatus-fluentdconfigname}
 
-Name of the matched detached fluentd configuration object 
+Available in Logging operator version 4.5 and later. Name of the matched detached fluentd configuration object. 
 
 
 ### problems ([]string, optional) {#loggingstatus-problems}
@@ -144,7 +144,7 @@ Count of problems for printcolumn
 
 ### syslogNGConfigName (string, optional) {#loggingstatus-syslogngconfigname}
 
-Name of the matched detached SyslogNG configuration object 
+Available in Logging operator version 4.5 and later. Name of the matched detached SyslogNG configuration object. 
 
 
 ### watchNamespaces ([]string, optional) {#loggingstatus-watchnamespaces}

diff --git a/docs/configuration/crds/v1beta1/syslogng_clusterflow_types.md b/docs/configuration/crds/v1beta1/syslogng_clusterflow_types.md
@@ -39,6 +39,8 @@ SyslogNGClusterFlowSpec is the Kubernetes spec for Flows
 
 ### outputMetrics ([]filter.MetricsProbe, optional) {#syslogngclusterflowspec-outputmetrics}
 
+Output metrics are applied before the log reaches the destination and contain output metadata like: `name,` `namespace` and `scope`. Scope shows whether the output is a local or global one. Available in Logging operator version 4.5 and later. 
+
 
 
 ## SyslogNGClusterFlowList

diff --git a/docs/configuration/crds/v1beta1/syslogng_flow_types.md b/docs/configuration/crds/v1beta1/syslogng_flow_types.md
@@ -25,6 +25,8 @@ SyslogNGFlowSpec is the Kubernetes spec for SyslogNGFlows
 
 ### outputMetrics ([]filter.MetricsProbe, optional) {#syslogngflowspec-outputmetrics}
 
+Output metrics are applied before the log reaches the destination and contain output metadata like: `name,` `namespace` and `scope`. Scope shows whether the output is a local or global one. Available in Logging operator version 4.5 and later. 
+
 
 
 ## SyslogNGFilter

diff --git a/docs/configuration/crds/v1beta1/syslogng_types.md b/docs/configuration/crds/v1beta1/syslogng_types.md
@@ -31,6 +31,8 @@ SyslogNGSpec defines the desired state of SyslogNG
 
 ### maxConnections (int, optional) {#syslogngspec-maxconnections}
 
+Available in Logging operator version 4.5 and later. Set the maximum number of connections for the source. For details, see [documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-routing-filters/concepts-flow-control/configuring-flow-control/). 
+
 
 ### metrics (*Metrics, optional) {#syslogngspec-metrics}
 
@@ -52,11 +54,13 @@ SyslogNGSpec defines the desired state of SyslogNG
 
 ### sourceDateParser (*SourceDateParser, optional) {#syslogngspec-sourcedateparser}
 
-Parses date automatically from the timestamp registered by the container runtime. Note: json key prefix and delimiter are respected 
+Available in Logging operator version 4.5 and later. Parses date automatically from the timestamp registered by the container runtime. Note: `jsonKeyPrefix` and `jsonKeyDelim` are respected. 
 
 
 ### sourceMetrics ([]filter.MetricsProbe, optional) {#syslogngspec-sourcemetrics}
 
+Available in Logging operator version 4.5 and later. Create [custom log metrics for sources and outputs]({{< relref "/docs/examples/custom-syslog-ng-metrics.md" >}}). 
+
 
 ### statefulSet (*typeoverride.StatefulSet, optional) {#syslogngspec-statefulset}
 
@@ -67,6 +71,15 @@ Parses date automatically from the timestamp registered by the container runtime
 
 ## SourceDateParser
 
+
+
+Available in Logging operator version 4.5 and later.
+
+Parses date automatically from the timestamp registered by the container runtime.
+Note: `jsonKeyPrefix` and `jsonKeyDelim` are respected.
+It is disabled by default, but if enabled, then the default settings parse the timestamp written by the container runtime and parsed by Fluent Bit using the `cri` or the `docker` parser.
+
+
 ### format (*string, optional) {#sourcedateparser-format}
 
 Default: "%FT%T.%f%z" 

diff --git a/docs/configuration/plugins/_index.md b/docs/configuration/plugins/_index.md
@@ -61,7 +61,7 @@ For more information please click on the plugin name
 | **[Syslog-NG Parser](syslogng-filters/parser/)** | syslogng-filters | Parse data from records | GA | [more info](https://axoflow.com/docs/axosyslog-core/chapter-parsers/) |
 | **[Syslog-NG Rewrite](syslogng-filters/rewrite/)** | syslogng-filters | Rewrite parts of the message | GA | [more info](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/77) |
 | **[Authentication config for syslog-ng outputs](syslogng-outputs/auth/)** | syslogng-outputs | Authentication config for syslog-ng outputs | Testing | []() |
-| **[disk-buffer configuration](syslogng-outputs/disk_buffer/)** | syslogng-outputs | disk-buffer configuration | Testing | [](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/3.37/administration-guide/32#kanchor2338) |
+| **[disk-buffer configuration](syslogng-outputs/disk_buffer/)** | syslogng-outputs | disk-buffer configuration | Testing | [](https://axoflow.com/docs/axosyslog-core/chapter-routing-filters/concepts-diskbuffer/) |
 | **[Elasticsearch](syslogng-outputs/elasticsearch/)** | syslogng-outputs | Sending messages over Elasticsearch | Testing | [](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-elasticsearch-http/) |
 | **[File](syslogng-outputs/file/)** | syslogng-outputs | SStoring messages in plain-text files | Testing | [](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-file/) |
 | **[HTTP](syslogng-outputs/http/)** | syslogng-outputs | Sending messages over HTTP | Testing | [](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-http-nonjava/) |

diff --git a/docs/configuration/plugins/filters/concat.md b/docs/configuration/plugins/filters/concat.md
@@ -110,9 +110,10 @@ Use partial metadata to concatenate multiple records
 
 
 
- ## Example `Concat` filter configurations
 
 
+## Example `Concat` filter configurations
+
 {{< highlight yaml >}}
 apiVersion: logging.banzaicloud.io/v1beta1
 kind: Flow
@@ -142,5 +143,4 @@ Fluentd config result:
 {{</ highlight >}}
 
 
-
 ---
diff --git a/docs/configuration/plugins/filters/dedot.md b/docs/configuration/plugins/filters/dedot.md
@@ -25,7 +25,9 @@ Default: _
 
 
 
+
 ## Example `Dedot` filter configurations
+
 {{< highlight yaml >}}
 apiVersion: logging.banzaicloud.io/v1beta1
 kind: Flow
@@ -41,8 +43,7 @@ spec:
     - demo-output
 {{</ highlight >}}
 
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
 <filter **>

diff --git a/docs/configuration/plugins/filters/detect_exceptions.md b/docs/configuration/plugins/filters/detect_exceptions.md
@@ -6,19 +6,20 @@ generated_file: true
 
 # Exception Detector
 ## Overview
- This filter plugin consumes a log stream of JSON objects which contain single-line log messages. If a consecutive sequence of log messages form an exception stack trace, they forwarded as a single, combined JSON object. Otherwise, the input log data is forwarded as is.
- More info at https://github.com/GoogleCloudPlatform/fluent-plugin-detect-exceptions
 
- > Note: As Tag management is not supported yet, this Plugin is **mutually exclusive** with [Tag normaliser](../tagnormaliser)
+This filter plugin consumes a log stream of JSON objects which contain single-line log messages. If a consecutive sequence of log messages form an exception stack trace, they forwarded as a single, combined JSON object. Otherwise, the input log data is forwarded as is. More info at https://github.com/GoogleCloudPlatform/fluent-plugin-detect-exceptions
 
- ## Example output configurations
- ```yaml
- filters:
-   - detectExceptions:
-     languages: java, python
-     multiline_flush_interval: 0.1
+> Note: As Tag management is not supported yet, this Plugin is **mutually exclusive** with [Tag normaliser](../tagnormaliser)
+
+## Example output configurations
+
+```yaml
+filters:
+  - detectExceptions:
+    languages: java, python
+    multiline_flush_interval: 0.1
+```
 
- ```
 
 ## Configuration
 ## DetectExceptions
@@ -79,7 +80,9 @@ Default: ""
 
 
 
+
 ## Example `Exception Detector` filter configurations
+
 {{< highlight yaml >}}
 apiVersion: logging.banzaicloud.io/v1beta1
 kind: Flow
@@ -97,8 +100,7 @@ spec:
     - demo-output
 {{</ highlight >}}
 
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
 <match kubernetes.**>

diff --git a/docs/configuration/plugins/filters/elasticsearch_genid.md b/docs/configuration/plugins/filters/elasticsearch_genid.md
@@ -7,8 +7,8 @@ generated_file: true
 # ElasticSearch GenId
 ## Overview
 
-TODO: FILL
-// ## Example `Elasticsearch Genid` filter configurations
+## Example `Elasticsearch Genid` filter configurations
+
 {{< highlight yaml >}}
 apiVersion: logging.banzaicloud.io/v1beta1
 kind: Flow
@@ -21,8 +21,11 @@ spec:
  selectors: {}
  localOutputRefs:
    - demo-output
+{{</ highlight >}}
+
+Fluentd Config Result
 
-#### Fluentd Config Result
+{{< highlight xml >}}
 <filter **>
  @type elasticsearch_genid
  @id test_elasticsearch_genid

diff --git a/docs/configuration/plugins/filters/enhance_k8s.md b/docs/configuration/plugins/filters/enhance_k8s.md
@@ -113,6 +113,7 @@ Default: true
 
 
 
+
 ## Example `EnhanceK8s` filter configurations
 
 {{< highlight yaml >}}
@@ -125,8 +126,7 @@ spec:
     - enhanceK8s: {}
 {{</ highlight >}}
 
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
 <filter **>

diff --git a/docs/configuration/plugins/filters/geoip.md b/docs/configuration/plugins/filters/geoip.md
@@ -46,6 +46,7 @@ Default: true
 
 
 
+
 ## Example `GeoIP` filter configurations
 
 {{< highlight yaml >}}
@@ -68,8 +69,7 @@ spec:
     - demo-output
 {{</ highlight >}}
 
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
 <filter **>

diff --git a/docs/configuration/plugins/filters/grep.md b/docs/configuration/plugins/filters/grep.md
@@ -48,6 +48,7 @@ Pattern expression to evaluate
 
 
 
+
 ## Example `Regexp` filter configurations
 
 {{< highlight yaml >}}
@@ -66,8 +67,7 @@ spec:
     - demo-output
 {{</ highlight >}}
 
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
   <filter **>
@@ -98,6 +98,7 @@ Pattern expression to evaluate
 
 
 
+
 ## Example `Exclude` filter configurations
 
 {{< highlight yaml >}}
@@ -116,9 +117,7 @@ spec:
     - demo-output
 {{</ highlight >}}
 
-
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
   <filter **>
@@ -149,6 +148,7 @@ Specify filtering rule (as described in the [Fluentd documentation](https://docs
 
 
 
+
 ## Example `Or` filter configurations
 
 {{< highlight yaml >}}
@@ -171,8 +171,7 @@ spec:
     - demo-output
 {{</ highlight >}}
 
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
 <or>
@@ -205,6 +204,7 @@ Specify filtering rule (as described in the [Fluentd documentation](https://docs
 
 
 
+
 ## Example `And` filter configurations
 
 {{< highlight yaml >}}
@@ -227,8 +227,7 @@ spec:
     - demo-output
 {{</ highlight >}}
 
-
-Fluentd #### config result:
+Fluentd config result:
 
 {{< highlight xml >}}
 	<and>

diff --git a/docs/configuration/plugins/filters/kube_events_timestamp.md b/docs/configuration/plugins/filters/kube_events_timestamp.md
@@ -25,6 +25,7 @@ Default: event.eventTime, event.lastTimestamp, event.firstTimestamp
 
 
 
+
 ## Example `Kubernetes Events Timestamp` filter configurations
 
 {{< highlight yaml >}}
@@ -45,8 +46,7 @@ spec:
     - es-output
 {{</ highlight >}}
 
-
-#### Fluentd config result:
+Fluentd config result:
 
 {{< highlight xml >}}
  <filter **>