ClusterOutput
fluentd.fluent.io / v1alpha1
apiVersion: fluentd.fluent.io/v1alpha1
kind: ClusterOutput
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
ClusterOutputSpec defines the desired state of ClusterOutput
outputs []object
buffer object
buffer section
calcNumRecords
string
Calculates the number of records, chunk size, during chunk resume.
chunkFormat
string
ChunkFormat specifies the chunk format for calc_num_records.
enum:
msgpack, text, auto
chunkLimitRecords
string
The max number of events that each chunks can store in it.
pattern:
^\d+(KB|MB|GB|TB)$
chunkLimitSize
string
Buffer parameters
The max size of each chunks: events will be written into chunks until the size of chunks become this size
Default: 8MB (memory) / 256MB (file)
pattern:
^\d+(KB|MB|GB|TB)$
compress
string
Fluentd will decompress these compressed chunks automatically before passing them to the output plugin
If gzip is set, Fluentd compresses data records before writing to buffer chunks.
Default:text.
enum:
text, gzip
delayedCommitTimeout
string
The timeout (seconds) until output plugin decides if the async write operation has failed. Default is 60s
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
disableChunkBackup
boolean
Instead of storing unrecoverable chunks in the backup directory, just discard them. This option is new in Fluentd v1.2.6.
flushAtShutdown
boolean
Flush parameters
This specifies whether to flush/write all buffer chunks on shutdown or not.
flushInterval
string
FlushInterval defines the flush interval
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
flushMode
string
FlushMode defines the flush mode:
lazy: flushes/writes chunks once per timekey
interval: flushes/writes chunks per specified time via flush_interval
immediate: flushes/writes chunks immediately after events are appended into chunks
default: equals to lazy if time is specified as chunk key, interval otherwise
enum:
default, lazy, interval, immediate
flushThreadCount
string
The number of threads to flush/write chunks in parallel
pattern:
^\d+$
id
string
The @id parameter specifies a unique name for the configuration.
localtime
boolean
If true, uses local time.
logLevel
string
The @log_level parameter specifies the plugin-specific logging level
overflowAction
string
OverflowAtction defines the output plugin behave when its buffer queue is full.
Default: throw_exception
path
string
The path where buffer chunks are stored. This field would make no effect in memory buffer plugin.
pathSuffix
string
Changes the suffix of the buffer file.
queueLimitLength
string
The queue length limitation of this buffer plugin instance. Default: 0.95
pattern:
^\d+.?\d+$
queuedChunksLimitSize
integer
Limit the number of queued chunks. Default: 1
If a smaller flush_interval is set, e.g. 1s,
there are lots of small queued chunks in the buffer.
With file buffer, it may consume a lot of fd resources when output destination has a problem.
This parameter mitigates such situations.
minimum:
1
retryExponentialBackoffBase
string
The base number of exponential backoff for retries.
pattern:
^\d+(\.[0-9]{0,2})?$
retryForever
boolean
If true, plugin will ignore retry_timeout and retry_max_times options and retry flushing forever.
retryMaxInterval
string
The maximum interval (seconds) for exponential backoff between retries while failing
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
retryMaxTimes
integer
The maximum number of times to retry to flush the failed chunks. Default: none
retryRandomize
boolean
If true, the output plugin will retry after randomized interval not to do burst retries
retrySecondaryThreshold
string
The ratio of retry_timeout to switch to use the secondary while failing.
pattern:
^\d+.?\d+$
retryTimeout
string
Retry parameters
The maximum time (seconds) to retry to flush again the failed chunks, until the plugin discards the buffer chunks
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
retryType
string
Output plugin will retry periodically with fixed intervals.
retryWait
string
Wait in seconds before the next retry to flush or constant factor of exponential backoff
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
tag
string
The output plugins group events into chunks.
Chunk keys, specified as the argument of <buffer> section, control how to group events into chunks.
If tag is empty, which means blank Chunk Keys.
Tag also supports Nested Field, combination of Chunk Keys, placeholders, etc.
See https://docs.fluentd.org/configuration/buffer-section.
timeFormat
string
Process value according to the specified format. This is available only when time_type is string
timeFormatFallbacks
string
Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
timeType
string
parses/formats value according to this type, default is string
enum:
float, unixtime, string, mixed
timekey
string
Output plugin will flush chunks per specified time (enabled when time is specified in chunk keys)
timekeyWait
string
Output plugin will write chunks after timekey_wait seconds later after timekey expiration
timezone
string
Uses the specified timezone.
totalLimitSize
string
The size limitation of this buffer plugin instance
Default: 512MB (memory) / 64GB (file)
pattern:
^\d+(KB|MB|GB|TB)$
type
string required
The @type parameter specifies the type of the plugin.
enum:
file, memory, file_single
utc
boolean
If true, uses UTC.
cloudWatch object
out_cloudwatch plugin
autoCreateStream
boolean
awsEcsAuthentication
boolean
awsKeyId object
Secret defines the key of a value.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
awsSecKey object
Secret defines the key of a value.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
awsStsDurationSeconds
string
awsStsEndpointUrl
string
awsStsExternalId
string
awsStsPolicy
string
awsStsRoleArn
string
awsStsSessionName
string
awsUseSts
boolean
concurrency
integer
durationSeconds
string
endpoint
string
Specify an AWS endpoint to send data to.
httpProxy
string
includeTimeKey
boolean
jsonHandler
string
localtime
boolean
logGroupAwsTags
string
logGroupAwsTagsKey
string
logGroupName
string
logGroupNameKey
string
logRejectedRequest
string
logStreamName
string
logStreamNameKey
string
maxEventsPerBatch
string
maxMessageLength
string
messageKeys
string
policy
string
putLogEventsDisableRetryLimit
boolean
putLogEventsRetryLimit
string
putLogEventsRetryWait
string
region
string
The AWS region.
removeLogGroupAwsTagsKey
boolean
removeLogGroupNameKey
boolean
removeLogStreamNameKey
boolean
removeRetentionInDaysKey
boolean
retentionInDays
string
retentionInDaysKey
string
roleArn
string
ARN of an IAM role to assume (for cross account access).
roleSessionName
string
Role Session name
sslVerifyPeer
boolean
useTagAsGroup
string
useTagAsStream
string
webIdentityTokenFile
string
Web identity token file
copy object
copy plugin
copyMode
string required
CopyMode defines how to pass the events to <store> plugins.
enum:
no_copy, shallow, deep, marshalcustomPlugin object
Custom plugin type
config
string required
datadog object
datadog plugin
apiKey object
This parameter is required in order to authenticate your fluent agent.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
compressionLevel
integer
Set the log compression level for HTTP (1 to 9, 9 being the best ratio)
format:
int32
ddHostname
string
Used by Datadog to identify the host submitting the logs.
ddSource
string
This tells Datadog what integration it is
ddSourcecategory
string
Multiple value attribute. Can be used to refine the source attribute
ddTags
string
Custom tags with the following format "key1:value1, key2:value2"
host
string
Proxy endpoint when logs are not directly forwarded to Datadog
httpProxy
string
HTTP proxy, only takes effect if HTTP forwarding is enabled (use_http). Defaults to HTTP_PROXY/http_proxy env vars.
includeTagKey
boolean
Automatically include the Fluentd tag in the record.
maxBackoff
integer
The maximum time waited between each retry in seconds
format:
int32
maxRetries
integer
The number of retries before the output plugin stops. Set to -1 for unlimited retries
format:
int32
noSSLValidation
boolean
Disable SSL validation (useful for proxy forwarding)
port
integer
Proxy port when logs are not directly forwarded to Datadog and ssl is not used
format:
int32minimum:
1maximum:
65535
service
string
Used by Datadog to correlate between logs, traces and metrics.
sslPort
integer
Port used to send logs over a SSL encrypted connection to Datadog. If use_http is disabled, use 10516 for the US region and 443 for the EU region.
format:
int32minimum:
1maximum:
65535
tagKey
string
Where to store the Fluentd tag.
timestampKey
string
Name of the attribute which will contain timestamp of the log event. If nil, timestamp attribute is not added.
useCompression
boolean
Enable log compression for HTTP
useHTTP
boolean
Enable HTTP forwarding. If you disable it, make sure to change the port to 10514 or ssl_port to 10516
useJson
boolean
Event format, if true, the event is sent in json format. Othwerwise, in plain text.
useSSL
boolean
If true, the agent initializes a secure connection to Datadog. In clear TCP otherwise.
elasticsearch object
out_es plugin
bulkMessageRequestThreshold
integer
Optional, Configure bulk_message_request_threshold splitting threshold size.
Default value is -1 (unlimited).
If a bulk message exceeds this threshold, the request is split into multiple smaller requests.
format:
int32
caFile
string
Optional, Absolute path to CA certificate file
clientCert
string
Optional, Absolute path to client Certificate file
clientKey
string
Optional, Absolute path to client private Key file
clientKeyPassword object
Optional, password for ClientKey file
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
cloudAuth object
Authenticate towards Elastic Cloud using cloudAuth.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
cloudId object
Authenticate towards Elastic Cloud using CloudId. If set, cloudAuth must
be set as well and host, port, user and password are ignored.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
enableIlm
boolean
Optional, Enable Index Lifecycle Management (ILM)
failOnPuttingTemplateRetryExceeded
boolean
Optional, Indicates whether to fail when max_retry_putting_template is exceeded. If you have multiple output plugin, you could use this property to do not fail on fluentd statup (default: false)
host
string
The hostname of your Elasticsearch node (default: localhost).
hosts
string
Hosts defines a list of hosts if you want to connect to more than one Elasticsearch nodes
ilmPolicy
string
Optional, Specify ILM policy contents as Hash
ilmPolicyId
string
Optional, Specify ILM policy id
ilmPolicyOverride
boolean
Optional, Specify whether overwriting ilm policy or not
indexName
string
IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section.
logEs400Reason
boolean
Optional, Enable logging of 400 reason without enabling debug log level
logstashFormat
boolean
If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option.
logstashPrefix
string
LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash).
maxRetryPuttingTemplate
integer
Optional, You can specify times of retry putting template (default: 10)
format:
int32password object
Optional, The login credentials to connect to Elasticsearch
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
path
string
Path defines the REST API endpoint of Elasticsearch to post write requests (default: nil).
port
integer
The port number of your Elasticsearch node (default: 9200).
format:
int32minimum:
1maximum:
65535
reconnectOnError
boolean
Optional, Indicates that the plugin should reset connection on any error (reconnect on next send) (default: false)
reloadAfter
integer
Optional, When ReloadConnections true, this is the integer number of operations after which the plugin will reload the connections. The default value is 10000.
format:
int32
reloadConnections
boolean
Optional, Automatically reload connection after 10000 documents (default: true)
reloadOnFailure
boolean
Optional, Indicates that the elasticsearch-transport will try to reload the nodes addresses if there is a failure while making the request, this can be useful to quickly remove a dead node from the list of addresses (default: false)
requestTimeout
string
Optional, HTTP Timeout (default: 5)
pattern:
^\d+(s|m|h|d)$
scheme
string
Specify https if your Elasticsearch endpoint supports SSL (default: http).
snifferClassName
string
Optional, Provide a different sniffer class name
sslVerify
boolean
Optional, Force certificate validation
suppressTypeName
boolean
Optional, Suppress '[types removal]' warnings on elasticsearch 7.x
templateOverwrite
boolean
Optional, Always update the template, even if it already exists (default: false)
user object
Optional, The login credentials to connect to Elasticsearch
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
elasticsearchDataStream object
out_es datastreams plugin
bulkMessageRequestThreshold
integer
Optional, Configure bulk_message_request_threshold splitting threshold size.
Default value is -1 (unlimited).
If a bulk message exceeds this threshold, the request is split into multiple smaller requests.
format:
int32
caFile
string
Optional, Absolute path to CA certificate file
clientCert
string
Optional, Absolute path to client Certificate file
clientKey
string
Optional, Absolute path to client private Key file
clientKeyPassword object
Optional, password for ClientKey file
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
cloudAuth object
Authenticate towards Elastic Cloud using cloudAuth.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
cloudId object
Authenticate towards Elastic Cloud using CloudId. If set, cloudAuth must
be set as well and host, port, user and password are ignored.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
dataStreamIlmName
string
Optional, You can specify the name of an existing ILM policy, which will be applied to the data stream. If not present, it creates a new ILM default policy (unless data_stream_template_name is defined, in that case the ILM will be set to the one specified in the matching index template)
dataStreamIlmPolicy
string
Optional, You can specify the ILM policy contents as hash. If not present, it will apply the ILM default policy
dataStreamIlmPolicyOverwrite
boolean
Optional, Specify whether the data stream ILM policy should be overwritten
dataStreamName
string required
You can specify Elasticsearch data stream name by this parameter. This parameter is mandatory for elasticsearch_data_stream
dataStreamTemplateName
string
Optional, You can specify an existing matching index template for the data stream. If not present, it creates a new matching index template
dataStreamTemplateUseIndexPatternsWildcard
boolean
Optional, Specify whether index patterns should include a wildcard (*) when creating an index template. This is particularly useful to prevent errors in scenarios where index templates are generated automatically, and multiple services with distinct suffixes are in use
enableIlm
boolean
Optional, Enable Index Lifecycle Management (ILM)
failOnPuttingTemplateRetryExceeded
boolean
Optional, Indicates whether to fail when max_retry_putting_template is exceeded. If you have multiple output plugin, you could use this property to do not fail on fluentd statup (default: false)
host
string
The hostname of your Elasticsearch node (default: localhost).
hosts
string
Hosts defines a list of hosts if you want to connect to more than one Elasticsearch nodes
ilmPolicy
string
Optional, Specify ILM policy contents as Hash
ilmPolicyId
string
Optional, Specify ILM policy id
ilmPolicyOverride
boolean
Optional, Specify whether overwriting ilm policy or not
logEs400Reason
boolean
Optional, Enable logging of 400 reason without enabling debug log level
maxRetryPuttingTemplate
integer
Optional, You can specify times of retry putting template (default: 10)
format:
int32password object
Optional, The login credentials to connect to Elasticsearch
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
path
string
Path defines the REST API endpoint of Elasticsearch to post write requests (default: nil).
port
integer
The port number of your Elasticsearch node (default: 9200).
format:
int32minimum:
1maximum:
65535
reconnectOnError
boolean
Optional, Indicates that the plugin should reset connection on any error (reconnect on next send) (default: false)
reloadAfter
integer
Optional, When ReloadConnections true, this is the integer number of operations after which the plugin will reload the connections. The default value is 10000.
format:
int32
reloadConnections
boolean
Optional, Automatically reload connection after 10000 documents (default: true)
reloadOnFailure
boolean
Optional, Indicates that the elasticsearch-transport will try to reload the nodes addresses if there is a failure while making the request, this can be useful to quickly remove a dead node from the list of addresses (default: false)
requestTimeout
string
Optional, HTTP Timeout (default: 5)
pattern:
^\d+(s|m|h|d)$
scheme
string
Specify https if your Elasticsearch endpoint supports SSL (default: http).
snifferClassName
string
Optional, Provide a different sniffer class name
sslVerify
boolean
Optional, Force certificate validation
suppressTypeName
boolean
Optional, Suppress '[types removal]' warnings on elasticsearch 7.x
templateOverwrite
boolean
Optional, Always update the template, even if it already exists (default: false)
user object
Optional, The login credentials to connect to Elasticsearch
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
format object
format section
delimiter
string
Delimiter for each field.
id
string
The @id parameter specifies a unique name for the configuration.
localtime
boolean
If true, uses local time.
logLevel
string
The @log_level parameter specifies the plugin-specific logging level
newline
string
Specify newline characters.
enum:
lf, crlf
outputTag
boolean
Output tag field if true.
outputTime
boolean
Output time field if true.
timeFormat
string
Process value according to the specified format. This is available only when time_type is string
timeFormatFallbacks
string
Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
timeType
string
parses/formats value according to this type, default is string
enum:
float, unixtime, string, mixed
timezone
string
Uses the specified timezone.
type
string
The @type parameter specifies the type of the plugin.
enum:
out_file, json, ltsv, csv, msgpack, hash, single_value
utc
boolean
If true, uses UTC.
forward object
out_forward plugin
ackResponseTimeout
string
This option is used when require_ack_response is true. This default value is based on popular tcp_syn_retries.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
connectTimeout
string
The connection timeout for the socket. When the connection is timed out during the connection establishment, Errno::ETIMEDOUT error is raised.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
dnsRoundRobin
boolean
Enable client-side DNS round robin. Uniform randomly pick an IP address to send data when a hostname has several IP addresses.
heartbeat_type udp is not available with dns_round_robintrue. Use heartbeat_type tcp or heartbeat_type none.
expireDnsCache
string
Sets TTL to expire DNS cache in seconds. Set 0 not to use DNS Cache.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
hardTimeout
string
The hard timeout used to detect server failure. The default value is equal to the send_timeout parameter.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
heartbeatInterval
string
The interval of the heartbeat packer.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
heartbeatType
string
Specifies the transport protocol for heartbeats. Set none to disable.
enum:
transport, tcp, udp, none
ignoreNetworkErrorsAtStartup
boolean
Ignores DNS resolution and errors at startup time.
keepalive
boolean
Enables the keepalive connection.
keepaliveTimeout
string
Timeout for keepalive. Default value is nil which means to keep the connection alive as long as possible.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
phiFailureDetector
boolean
Use the "Phi accrual failure detector" to detect server failure.
phiThreshold
integer
The threshold parameter used to detect server faults.
recoverWait
string
The wait time before accepting a server fault recovery.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$
requireAckResponse
boolean
Changes the protocol to at-least-once. The plugin waits the ack from destination's in_forward plugin.
security object
ServiceDiscovery defines the security section
allowAnonymousSource
string
Allows the anonymous source. <client> sections are required, if disabled.
selfHostname
string
The hostname.
sharedKey
string
The shared key for authentication.
user object
Defines user section directly.
password object
Secret defines the key of a value.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
username object
Secret defines the key of a value.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
userAuth
string
If true, user-based authentication is used.
sendTimeout
string
The timeout time when sending event logs.
pattern:
^\d+(\.[0-9]{0,2})?(s|m|h|d)?$servers []object required
Servers defines the servers section, at least one is required
host
string
Host defines the IP address or host name of the server.
id
string
The @id parameter specifies a unique name for the configuration.
logLevel
string
The @log_level parameter specifies the plugin-specific logging level
name
string
Name defines the name of the server. Used for logging and certificate verification in TLS transport (when the host is the address).
password object
Password defines the password for authentication.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
port
string
Port defines the port number of the host. Note that both TCP packets (event stream) and UDP packets (heartbeat messages) are sent to this port.
sharedKey
string
SharedKey defines the shared key per server.
standby
string
Standby marks a node as the standby node for an Active-Standby model between Fluentd nodes.
type
string
The @type parameter specifies the type of the plugin.
username object
Username defines the username for authentication.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
weight
string
Weight defines the load balancing weight
serviceDiscovery object
ServiceDiscovery defines the service_discovery section
confEncoding
string
The encoding of the configuration file.
dnsLookup
string
DnsLookup resolves the hostname to IP address of the SRV's Target.
dnsServerHost
string
DnsServerHost defines the hostname of the DNS server to request the SRV record.
hostname
string
The name in RFC2782.
id
string
The @id parameter specifies a unique name for the configuration.
interval
string
Interval defines the interval of sending requests to DNS server.
logLevel
string
The @log_level parameter specifies the plugin-specific logging level
path
string
The path of the target list. Default is '/etc/fluent/sd.yaml'
proto
string
Proto without the underscore in RFC2782.
server object
The server section of this plugin
host
string
Host defines the IP address or host name of the server.
id
string
The @id parameter specifies a unique name for the configuration.
logLevel
string
The @log_level parameter specifies the plugin-specific logging level
name
string
Name defines the name of the server. Used for logging and certificate verification in TLS transport (when the host is the address).
password object
Password defines the password for authentication.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
port
string
Port defines the port number of the host. Note that both TCP packets (event stream) and UDP packets (heartbeat messages) are sent to this port.
sharedKey
string
SharedKey defines the shared key per server.
standby
string
Standby marks a node as the standby node for an Active-Standby model between Fluentd nodes.
type
string
The @type parameter specifies the type of the plugin.
username object
Username defines the username for authentication.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
weight
string
Weight defines the load balancing weight
service
string
Service without the underscore in RFC2782.
type
string required
The @type parameter specifies the type of the plugin.
enum:
static, file, srv
tlsAllowSelfSignedCert
boolean
Allows self-signed certificates or not.
tlsCertLogicalStoreName
string
The certificate logical store name on Windows system certstore. This parameter is for Windows only.
tlsCertPath
string
The additional CA certificate path for TLS.
tlsCertThumbprint
string
The certificate thumbprint for searching from Windows system certstore. This parameter is for Windows only.
tlsCertUseEnterpriseStore
boolean
Enables the certificate enterprise store on Windows system certstore. This parameter is for Windows only.
tlsCiphers
string
The cipher configuration of TLS transport.
tlsClientCertPath
string
The client certificate path for TLS.
tlsClientPrivateKeyPassphrase
string
The TLS private key passphrase for the client.
tlsClientPrivateKeyPath
string
The client private key path for TLS.
tlsInsecureMode
boolean
Skips all verification of certificates or not.
tlsVerifyHostname
boolean
Verifies hostname of servers and certificates or not in TLS transport.
tlsVersion
string
The default version of TLS transport.
enum:
TLSv1_1, TLSv1_2
verifyConnectionAtStartup
boolean
Verify that a connection can be made with one of out_forward nodes at the time of startup.
http object
out_http plugin
auth object
Auth section for this plugin
auth
string
The method for HTTP authentication. Now only basic.
password object
The password for basic authentication.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
username object
The username for basic authentication.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
compress
string
Compress enables the given compression method for HTTP requests.
enum:
text, gzip
contentType
string
ContentType defines Content-Type for HTTP request. out_http automatically set Content-Type for built-in formatters when this parameter is not specified.
endpoint
string
Endpoint defines the endpoint for HTTP request. If you want to use HTTPS, use https prefix.
errorResponseAsUnrecoverable
boolean
Raise UnrecoverableError when the response code is not SUCCESS.
headers
string
Headers defines the additional headers for HTTP request.
headersFromPlaceholders
string
Additional placeholder based headers for HTTP request. If you want to use tag or record field, use this parameter instead of headers.
httpMethod
string
HttpMethod defines the method for HTTP request.
enum:
post, put
jsonArray
boolean
JsonArray defines whether to use the array format of JSON or not
openTimeout
integer
OpenTimeout defines the connection open timeout in seconds.
proxy
string
Proxy defines the proxy for HTTP request.
readTimeout
integer
ReadTimeout defines the read timeout in seconds.
retryableResponseCodes
string
The list of retryable response codes. If the response code is included in this list, out_http retries the buffer flush.
sslTimeout
integer
SslTimeout defines the TLS timeout in seconds.
tlsCaCertPath
string
TlsCaCertPath defines the CA certificate path for TLS.
tlsCiphers
string
TlsCiphers defines the cipher suites configuration of TLS.
tlsClientCertPath
string
TlsClientCertPath defines the client certificate path for TLS.
tlsPrivateKeyPassphrase
string
TlsPrivateKeyPassphrase defines the client private key passphrase for TLS.
tlsPrivateKeyPath
string
TlsPrivateKeyPath defines the client private key path for TLS.
tlsVerifyMode
string
TlsVerifyMode defines the verify mode of TLS.
enum:
peer, none
tlsVersion
string
TlsVersion defines the default version of TLS transport.
enum:
TLSv1_1, TLSv1_2inject object
inject section
hostname
string
Hostname value
hostnameKey
string
The field name to inject hostname
inline object
Time section
localtime
boolean
If true, uses local time.
timeFormat
string
Process value according to the specified format. This is available only when time_type is string
timeFormatFallbacks
string
Uses the specified time format as a fallback in the specified order. You can parse undetermined time format by using time_format_fallbacks. This options is enabled when time_type is mixed.
timeType
string
parses/formats value according to this type, default is string
enum:
float, unixtime, string, mixed
timezone
string
Uses the specified timezone.
utc
boolean
If true, uses UTC.
tagKey
string
The field name to inject tag
timeKey
string
The field name to inject time
workerIdKey
string
The field name to inject worker_id
kafka object
out_kafka plugin
brokers
string
The list of all seed brokers, with their host and port information. Default: localhost:9092
compressionCodec
string
The codec the producer uses to compress messages (default: nil).
enum:
gzip, snappy
defaultTopic
string
The name of the default topic. (default: nil)
requiredAcks
integer
The number of acks required per request.
topicKey
string
The field name for the target topic. If the field value is app, this plugin writes events to the app topic.
useEventTime
boolean
Set fluentd event time to Kafka's CreateTime.
logLevel
string
The @log_level parameter specifies the plugin-specific logging level
loki object
out_loki plugin
bearerTokenFile
string
Set path to file with bearer authentication token
Can be used as alterntative to HTTP basic authentication
dropSingleKey
boolean
If a record only has 1 key, then just set the log line to the value and discard the key.
extractKubernetesLabels
boolean
If set to true, it will add all Kubernetes labels to the Stream labels.
httpPassword object
Password for user defined in HTTP_User
Set HTTP basic authentication password
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
httpUser object
Set HTTP basic authentication user name.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
includeThreadLabel
boolean
Whether or not to include the fluentd_thread label when multiple threads are used for flushing
insecure
boolean
Disable certificate validation
labelKeys
[]string
Optional list of record keys that will be placed as stream labels.
This configuration property is for records key only.
labels
[]string
Stream labels for API request. It can be multiple comma separated of strings specifying key=value pairs.
In addition to fixed parameters, it also allows to add custom record keys (similar to label_keys property).
lineFormat
string
Format to use when flattening the record to a log line. Valid values are json or key_value.
If set to json, the log line sent to Loki will be the Fluentd record dumped as JSON.
If set to key_value, the log line will be each item in the record concatenated together (separated by a single space) in the format.
enum:
json, key_value
removeKeys
[]string
Optional list of record keys that will be removed from stream labels.
This configuration property is for records key only.
tenantID object
Tenant ID used by default to push logs to Loki.
If omitted or empty it assumes Loki is running in single-tenant mode and no X-Scope-OrgID header is sent.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
tlsCaCertFile
string
TlsCaCert defines the CA certificate file for TLS.
tlsClientCertFile
string
TlsClientCert defines the client certificate file for TLS.
tlsPrivateKeyFile
string
TlsPrivateKey defines the client private key file for TLS.
url
string required
Loki URL.
nullPlugin object
null plugin
neverFlush
boolean
NeverFlush for testing to simulate the output plugin that never succeeds to flush.
opensearch object
out_opensearch plugin
applicationName
string
Optional, Specify the application name for the rollover index to be created (default: default)
bulkMessageRequestThreshold
integer
Optional, Configure bulk_message_request_threshold splitting threshold size (default: -1 unlimited)
format:
int32
caFile
string
Optional, Absolute path to CA certificate file
clientCert
string
Optional, Absolute path to client Certificate file
clientKey
string
Optional, Absolute path to client private Key file
clientKeyPassword object
Optional, password for ClientKey file
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
compressionLevel
string
Optional, You can specify the compression level (default: no_compression). Options: no_compression, best_compression, best_speed, default_compression
contentType
string
Optional, With content_type application/x-ndjson, plugin adds application/x-ndjson as Content-Type (default: application/json)
customHeaders
string
Optional, Custom headers in Hash format
defaultOpensearchVersion
integer
Optional, Default OpenSearch version (default: 1)
format:
int32
emitErrorForMissingId
boolean
Optional, When write_operation is not index, setting this true will cause plugin to emit_error_event of records which do not include _id field (default: false)
exceptionBackup
boolean
Optional, Backup chunk when ignore exception occurs (default: true)
failOnDetectingOsVersionRetryExceed
boolean
Optional, Indicates whether to fail when max_retry_get_os_version is exceeded (default: true)
failOnPuttingTemplateRetryExceed
boolean
Optional, Indicates whether to fail when max_retry_putting_template is exceeded (default: true)
host
string
The hostname of your Opensearch node (default: localhost).
hosts
string
Hosts defines a list of hosts if you want to connect to more than one Openearch nodes
httpBackend
string
Optional, You can specify HTTP backend (default: excon). Options: excon, typhoeus
httpBackendExconNonblock
boolean
Optional, With http_backend_excon_nonblock false, plugin uses excon with nonblock=false (default: true)
idKey
string
Optional, Record accessor syntax to specify the field to use as _id in OpenSearch
ignoreExceptions
string
Optional, List of exception classes to ignore
includeTagKey
boolean
Optional, Include tag key in record (default: false)
indexDatePattern
string
Optional, Specify the index date pattern for creating a rollover index (default: now/d)
indexName
string
IndexName defines the placeholder syntax of Fluentd plugin API. See https://docs.fluentd.org/configuration/buffer-section.
logOs400Reason
boolean
Optional, Enable logging of 400 reason without enabling debug log level (default: false)
logstashFormat
boolean
If true, Fluentd uses the conventional index name format logstash-%Y.%m.%d (default: false). This option supersedes the index_name option.
logstashPrefix
string
LogstashPrefix defines the logstash prefix index name to write events when logstash_format is true (default: logstash).
maxRetryGetOsVersion
integer
Optional, You can specify times of retry obtaining OpenSearch version (default: 15)
format:
int32
maxRetryPuttingTemplate
integer
Optional, You can specify times of retry putting template (default: 10)
format:
int32password object
Optional, The login credentials to connect to Opensearch
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
path
string
Path defines the REST API endpoint of Opensearch to post write requests (default: nil).
pipeline
string
Optional, Pipeline name
port
integer
The port number of your Opensearch node (default: 9200).
format:
int32minimum:
1maximum:
65535
preferOjSerializer
boolean
Optional, With default behavior, plugin uses Yajl as JSON encoder/decoder. Set to true to use Oj (default: false)
reconnectOnError
boolean
Optional, Indicates that the plugin should reset connection on any error (reconnect on next send) (default: false)
reloadAfter
integer
Optional, When ReloadConnections true, this is the integer number of operations after which the plugin will reload the connections (default: 10000)
format:
int32
reloadConnections
boolean
Optional, Automatically reload connection after 10000 documents (default: true)
reloadOnFailure
boolean
Optional, Indicates that the opensearch-transport will try to reload the nodes addresses if there is a failure while making the request (default: false)
removeKeys
string
Optional, Remove specified keys from the event record
removeKeysOnUpdate
string
Optional, Remove keys when record is being updated
requestTimeout
string
Optional, HTTP request timeout in seconds (default: 5s)
pattern:
^\d+(s|m|h|d)$
scheme
string
Specify https if your Opensearch endpoint supports SSL (default: http).
selectorClassName
string
Optional, Provide a selector class name
snifferClassName
string
Optional, Provide a different sniffer class name
sslMaxVersion
string
Optional, Maximum SSL/TLS version
sslMinVersion
string
Optional, Minimum SSL/TLS version
sslVerify
boolean
Optional, Force certificate validation
sslVersion
string
Optional, You can specify SSL/TLS version (default: TLSv1_2)
suppressDocWrap
boolean
Optional, Suppress doc_wrap (default: false)
suppressTypeName
boolean
Optional, Suppress '[types removal]' warnings on OpenSearch 2.x (default: true for OS2+)
tagKey
string
Optional, Tag key name when include_tag_key is true (default: tag)
templateOverwrite
boolean
Optional, Always update the template, even if it already exists (default: false)
useLegacyTemplate
boolean
Optional, Use legacy template or not (default: false for composable templates)
user object
Optional, The login credentials to connect to Opensearch
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
utcIndex
boolean
Optional, UTC index (default: false for local time)
verifyOsVersionAtStartup
boolean
Optional, Validate OpenSearch version at startup (default: true)
writeOperation
string
Optional, The write operation (default: index). Options: index, create, update, upsert
s3 object
out_s3 plugin
awsKeyId
string
The AWS access key id.
awsKeyIdFromSecret object
The AWS access key id from Secrets.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
awsSecKey
string
The AWS secret key.
awsSecKeyFromSecret object
The AWS secret key from Secrets.
valueFrom object
ValueSource defines how to find a value's key.
secretKeyRef object
Selects a key of a secret in the pod's namespace
key
string required
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
forcePathStyle
boolean
This prevents AWS SDK from breaking endpoint URL
path
string
The path prefix of the files on S3.
proxyUri
string
The proxy URL.
s3Bucket
string
The Amazon S3 bucket name.
s3Endpoint
string
The endpoint URL (like "http://localhost:9000/")
s3ObjectKeyFormat
string
The actual S3 path. This is interpolated to the actual path.
s3Region
string
The Amazon S3 region name
sseCustomerAlgorithm
string
The AWS KMS enctyption algorithm.
sseCustomerKey
string
The AWS KMS key.
sseCustomerKeyMd5
string
The AWS KMS key MD5.
ssekmsKeyId
string
The AWS KMS key ID.
sslVerifyPeer
boolean
Verify the SSL certificate of the endpoint.
storeAs
string
The compression type.
enum:
gzip, lzo, json, txt
timeSliceFormat
string
This timestamp is added to each file name
useServerSideEncryption
string
the following parameters are for S3 kms https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html
stdout
object
out_stdout plugin
tag
string
Which tag to be matched.
status
object
ClusterOutputStatus defines the observed state of ClusterOutput
No matches. Try .spec.outputs for an exact path