Sync generated docs

fekete-robert · fekete-robert · commit 8e2474cff97c · 2025-06-11T11:22:21.000+02:00
diff --git a/content/docs/configuration/crds/v1beta1/axosyslog_types.md b/content/docs/configuration/crds/v1beta1/axosyslog_types.md
@@ -0,0 +1,118 @@
+## AxoSyslog
+
+AxoSyslog is the Schema for the AxoSyslogs API.
+
+Available in Logging operator version 5.4 and later.
+
+###  (metav1.TypeMeta, required) {#axosyslog-}
+
+
+### metadata (metav1.ObjectMeta, optional) {#axosyslog-metadata}
+
+
+### spec (AxoSyslogSpec, optional) {#axosyslog-spec}
+
+
+### status (AxoSyslogStatus, optional) {#axosyslog-status}
+
+
+
+## AxoSyslogSpec
+
+AxoSyslogSpec defines the desired state of AxoSyslog
+
+### destinations ([]Destination, optional) {#axosyslogspec-destinations}
+
+Destinations is a list of destinations to be rendered in the AxoSyslog configuration 
+
+
+### logPaths ([]LogPath, optional) {#axosyslogspec-logpaths}
+
+LogPaths is a list of log paths to be rendered in the AxoSyslog configuration 
+
+
+
+## LogPath
+
+LogPath defines a single log path that will be rendered in the AxoSyslog configuration
+
+### destination (string, optional) {#logpath-destination}
+
+name of a destination to be used in the log path 
+
+
+### filterx (string, optional) {#logpath-filterx}
+
+filterx block to be rendered within the log path 
+
+
+
+## Destination
+
+Destination defines a single destination that will be rendered in the AxoSyslog configuration
+
+### config (string, optional) {#destination-config}
+
+Config is the configuration for the destination 
+
+
+### name (string, optional) {#destination-name}
+
+Name of the destination 
+
+
+
+## AxoSyslogStatus
+
+AxoSyslogStatus defines the observed state of AxoSyslog
+
+### problems ([]string, optional) {#axosyslogstatus-problems}
+
+Problems with the AxoSyslog resource 
+
+
+### problemsCount (int, optional) {#axosyslogstatus-problemscount}
+
+Count of problems with the AxoSyslog resource 
+
+
+### sources ([]Source, optional) {#axosyslogstatus-sources}
+
+Sources configured for AxoSyslog 
+
+
+
+## Source
+
+Source represents the source of logs for AxoSyslog
+
+### otlp (*OTLPSource, optional) {#source-otlp}
+
+OTLP specific configuration 
+
+
+
+## OTLPSource
+
+OTLPSource contains configuration for OpenTelemetry Protocol sources
+
+### endpoint (string, optional) {#otlpsource-endpoint}
+
+Endpoint for the OTLP source 
+
+
+
+## AxoSyslogList
+
+AxoSyslogList contains a list of AxoSyslog
+
+###  (metav1.TypeMeta, required) {#axosysloglist-}
+
+
+### metadata (metav1.ListMeta, optional) {#axosysloglist-metadata}
+
+
+### items ([]AxoSyslog, required) {#axosysloglist-items}
+
+
+
diff --git a/content/docs/configuration/crds/v1beta1/fluentbit_types.md b/content/docs/configuration/crds/v1beta1/fluentbit_types.md
@@ -127,9 +127,16 @@ Disable Kubernetes metadata filter
 
 ### disableVarLibDockerContainers (*bool, optional) {#fluentbitspec-disablevarlibdockercontainers}
 
+Available in Logging operator version 5.4 and later.
+
 DisableVarLibDockerContainers controls whether the /var/lib/docker/containers volume is mounted. If true, the volume is NOT mounted. If false (default), the volume is mounted.
 
 
+### disableVarLog (*bool, optional) {#fluentbitspec-disablevarlog}
+
+DisableVarLog controls whether the /var/log volume is mounted. If true, the volume is NOT mounted. If false (default), the volume is mounted. 
+
+
 ### enableUpstream (bool, optional) {#fluentbitspec-enableupstream}
 
 
@@ -675,6 +682,30 @@ Allow Kubernetes Pods to suggest a pre-defined Parser (read more about it in Kub
 
 Default: Off
 
+Important: When enabling this setting, you must also configure
+`inputTail.multiline.parser` with appropriate parsers (typically including `cri` for
+Container Runtime Interface logs). Without this configuration, the annotation-based
+parsing will not work correctly.
+
+#### Example Configuration
+
+```yaml
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: FluentbitAgent
+metadata:
+ name: example-fluentbit
+spec:
+ inputTail:
+   multiline.parser: [cri]  # Required when K8S-Logging.Parser is enabled
+ filterKubernetes:
+   K8S-Logging.Parser: "On"
+   Merge_Log_Key: "parsed"  # Optional but recommended to prevent key conflicts
+
+   # Once configured, you can use annotations on your pods:
+   annotations:
+     fluentbit.io/parser: "my-custom-parser"
+```
+
 ### Keep_Log (string, optional) {#filterkubernetes-keep_log}
 
 When Keep_Log is disabled, the log field is removed from the incoming message once it has been successfully merged (Merge_Log must be enabled as well).
diff --git a/content/docs/configuration/crds/v1beta1/output_types.md b/content/docs/configuration/crds/v1beta1/output_types.md
@@ -47,6 +47,9 @@ OutputSpec defines the desired state of Output
 ### kinesisStream (*output.KinesisStreamOutputConfig, optional) {#outputspec-kinesisstream}
 
 
+### lmLogs (*output.LMLogsOutputConfig, optional) {#outputspec-lmlogs}
+
+
 ### logdna (*output.LogDNAOutput, optional) {#outputspec-logdna}
 
 
diff --git a/content/docs/configuration/plugins/outputs/elasticsearch.md b/content/docs/configuration/plugins/outputs/elasticsearch.md
@@ -109,6 +109,12 @@ Specify an existing index template for the data stream. If not present, a new te
 
 Default: data_stream_name
 
+### data_stream_template_use_index_patterns_wildcard (*bool, optional) {#elasticsearch-data_stream_template_use_index_patterns_wildcard}
+
+https://github.com/uken/fluent-plugin-elasticsearch?tab=readme-ov-file#data_stream_template_use_index_patterns_wildcard 
+
+Default: true
+
 ### default_elasticsearch_version (string, optional) {#elasticsearch-default_elasticsearch_version}
 
 This parameter changes that ES plugin assumes default Elasticsearch version.
diff --git a/content/docs/configuration/plugins/outputs/forward.md b/content/docs/configuration/plugins/outputs/forward.md
@@ -17,6 +17,11 @@ Default: 190
 [Buffer](../buffer/) 
 
 
+### compress (string, optional) {#forwardoutput-compress}
+
+Fluentd supports transparent data compression, the only value accepted is "gzip" 
+
+
 ### connect_timeout (int, optional) {#forwardoutput-connect_timeout}
 
 The timeout time for socket connect. When the connection timed out during establishment, Errno::ETIMEDOUT is raised. 
diff --git a/content/docs/configuration/plugins/outputs/lm_logs.md b/content/docs/configuration/plugins/outputs/lm_logs.md
@@ -0,0 +1,115 @@
+---
+title: LogicMonitor Logs
+weight: 200
+generated_file: true
+---
+
+# LogicMonitor Logs output plugin for Fluentd
+## Overview
+
+LogicMonitor Logs output plugin for Fluentd
+
+Sends log records to LogicMonitor Logs via the LM API.
+
+For details, see [https://github.com/logicmonitor/lm-logs-fluentd](https://github.com/logicmonitor/lm-logs-fluentd).
+
+## Example output configurations
+
+```yaml
+spec:
+  lmLogs:
+    company_name: mycompany
+    access_id:
+      valueFrom:
+        secretKeyRef:
+          name: lm-credentials
+          key: access_id
+    access_key:
+      valueFrom:
+        secretKeyRef:
+          name: lm-credentials
+          key: access_key
+    resource_mapping: '{"kubernetes.host": "system.hostname"}'
+    flush_interval: 60s
+    debug: false
+```
+
+
+## Configuration
+## LogicMonitorLogs
+
+### access_id (*secret.Secret, optional) {#logicmonitorlogs-access_id}
+
+LM API Token access ID [Secret](../secret/) 
+
+
+### access_key (*secret.Secret, optional) {#logicmonitorlogs-access_key}
+
+LM API Token access key [Secret](../secret/) 
+
+
+### bearer_token (*secret.Secret, optional) {#logicmonitorlogs-bearer_token}
+
+LM API Bearer Token. Either specify access_id and access_key both or bearer_token. If all specified, LMv1 token(access_id and access_key) will be used for authentication with LogicMonitor [Secret](../secret/) 
+
+
+### buffer (*Buffer, optional) {#logicmonitorlogs-buffer}
+
+[Buffer](../buffer/) 
+
+
+### company_domain (string, optional) {#logicmonitorlogs-company_domain}
+
+LogicMonitor account domain. For eg. for url test.logicmonitor.com, company_domain is logicmonitor.com (default: logicmonitor.com) 
+
+Default: logicmonitor.com
+
+### company_name (string, required) {#logicmonitorlogs-company_name}
+
+LogicMonitor account name 
+
+
+### debug (*bool, optional) {#logicmonitorlogs-debug}
+
+When true, logs more information to the fluentd console 
+
+
+### device_less_logs (*bool, optional) {#logicmonitorlogs-device_less_logs}
+
+When true, do not map log with any resource. record must have service when true
+
+Default: false
+
+### flush_interval (string, optional) {#logicmonitorlogs-flush_interval}
+
+Defines the time in seconds to wait before sending batches of logs to LogicMonitor (default: 60s) 
+
+Default: 60s
+
+### force_encoding (string, optional) {#logicmonitorlogs-force_encoding}
+
+Specify charset when logs contains invalid utf-8 characters 
+
+
+### format (*Format, optional) {#logicmonitorlogs-format}
+
+[Format](../format/) 
+
+
+### http_proxy (string, optional) {#logicmonitorlogs-http_proxy}
+
+http proxy string eg. http://user:pass@proxy.server:port 
+
+
+### include_metadata (*bool, optional) {#logicmonitorlogs-include_metadata}
+
+When true, appends additional metadata to the log
+
+Default: false
+
+### resource_mapping (string, required) {#logicmonitorlogs-resource_mapping}
+
+The mapping that defines the source of the log event to the LM resource. In this case, the <event_key> in the incoming event is mapped to the value of <lm_property> 
+
+
+
diff --git a/content/docs/configuration/plugins/outputs/vmware_loginsight.md b/content/docs/configuration/plugins/outputs/vmware_loginsight.md
@@ -161,7 +161,7 @@ Default: json
 
 ### shorten_keys (map[string]string, optional) {#vmwareloginsight-shorten_keys}
 
-Keys from log event to rewrite for instance from 'kubernetes_namespace' to 'k8s_namespace' tags will be rewritten with substring substitution and applied in the order present in the hash. Hashes enumerate their values in the order that the corresponding keys were inserted, see: https://ruby-doc.org/core-2.2.2/Hash.html  
+Keys from log event to rewrite for instance from 'kubernetes_namespace' to 'k8s_namespace' tags will be rewritten with substring substitution and applied in the order present in the hash. Hashes enumerate their values in the order that the corresponding keys were inserted, see: https://ruby-doc.org/core-2.2.2/Hash.html
 
 Default: { 'kubernetes_':'k8s_', 'namespace':'ns', 'labels_':'', '_name':'', '_hash':'', 'container_':'' }
 
diff --git a/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md b/content/docs/configuration/plugins/syslog-ng-outputs/syslog.md
@@ -103,6 +103,12 @@ Specifies how many lines are flushed to a destination at a time. For details, se
 Address of the destination host 
 
 
+### ip-protocol (*int, optional) {#syslogoutput-ip-protocol}
+
+IP protocol
+
+Default: 4
+
 ### persist_name (string, optional) {#syslogoutput-persist_name}
 
 Unique name for the syslog-ng driver. If you receive the following error message during syslog-ng startup, set the `persist-name()` option of the duplicate drivers: `Error checking the uniqueness of the persist names, please override it with persist-name option. Shutting down.` See the [documentation of the AxoSyslog syslog-ng distribution](https://axoflow.com/docs/axosyslog-core/chapter-destinations/configuring-destinations-http-nonjava/reference-destination-http-nonjava/#persist-name) for more information. 
