Output
fluentbit.fluent.io / v1alpha2
apiVersion: fluentbit.fluent.io/v1alpha2
kind: Output
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
OutputSpec defines the desired state of ClusterOutput
alias
string
A user friendly alias name for this output plugin.
Used in metrics for distinction of each configured output.
azureBlob object
AzureBlob defines AzureBlob Output Configuration
accountName
string required
Azure Storage account name
autoCreateContainer
string
Creates container if ContainerName is not set.
enum:
on, off
blobType
string
Specify the desired blob type. Must be `appendblob` or `blockblob`
enum:
appendblob, blockblob
bufferingEnabled
boolean
Enable buffering into disk before ingesting into Azure Blob.
compressBlob
string
Optional: Enables GZIP compression in the final blockblob file. This option isn't compatible when blob_type = appendblob.
enum:
on, off
containerName
string required
Name of the container that will contain the blobs
emulatorMode
string
Optional toggle to use an Azure emulator
enum:
on, off
endpoint
string
HTTP Service of the endpoint (if using EmulatorMode)
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
path
string
Optional path to store the blobs.
sharedKey object required
Specify the Azure Storage Shared Key to authenticate against the storage account
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
tls object
Enable/Disable TLS Encryption. Azure services require TLS to be enabled.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
uploadFileSize
string
Specifies the size of files to be uploaded in MB. Defaults to 200M.
uploadTimeout
string
Optional. Specify a timeout for uploads. Fluent Bit will start ingesting buffer files which have been created more than x minutes ago and haven't reached upload_file_size limit yet. Defaults to 30m.
azureLogAnalytics object
AzureLogAnalytics defines AzureLogAnalytics Output Configuration
customerID object required
Customer ID or Workspace ID
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
logType
string
Name of the event type.
logTypeKey
string
Set a record key that will populate 'logtype'. If the key is found, it will have precedence
sharedKey object required
Specify the primary or the secondary client authentication key
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
timeGenerated
boolean
If set, overrides the timeKey value with the `time-generated-field` HTTP header value.
timeKey
string
Specify the name of the key where the timestamp is stored.
cloudWatch object
CloudWatch defines CloudWatch Output Configuration
autoCreateGroup
boolean
Automatically create the log group. Defaults to False.
autoRetryRequests
boolean
Automatically retry failed requests to CloudWatch once. Defaults to True.
endpoint
string
Custom endpoint for CloudWatch logs API
externalID
string
Specify an external ID for the STS API.
logFormat
string
Optional parameter to tell CloudWatch the format of the data
logGroupName
string
Name of Cloudwatch Log Group to send log records to
logGroupTemplate
string
Template for Log Group name, overrides LogGroupName if set.
logKey
string
If set, only the value of the key will be sent to CloudWatch
logRetentionDays
integer
Number of days logs are retained for
enum:
1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653format:
int32
logStreamName
string
The name of the CloudWatch Log Stream to send log records to
logStreamPrefix
string
Prefix for the Log Stream name. Not compatible with LogStreamName setting
logStreamTemplate
string
Template for Log Stream name. Overrides LogStreamPrefix and LogStreamName if set.
metricDimensions
string
Optional lists of lists for dimension keys to be added to all metrics. Use comma separated strings
for one list of dimensions and semicolon separated strings for list of lists dimensions.
metricNamespace
string
Optional string to represent the CloudWatch namespace.
region
string required
AWS Region
roleArn
string
Role ARN to use for cross-account access
stsEndpoint
string
Specify a custom STS endpoint for the AWS STS API
customPlugin object
CustomPlugin defines Custom Output configuration.
config
string
Config holds any unsupported plugins classic configurations,
if ConfigFileFormat is set to yaml, this filed will be ignored
yamlConfig
object
YamlConfig holds the unsupported plugins yaml configurations, it only works when the ConfigFileFormat is yaml
datadog object
DataDog defines DataDog Output configuration.
apikey object
Your Datadog API key.
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 the payload in GZIP format.
Datadog supports and recommends setting this to gzip.
dd_message_key
string
By default, the plugin searches for the key 'log' and remap the value to the key 'message'. If the property is set, the plugin will search the property name key.
dd_service
string
The human readable name for your service generating the logs.
dd_source
string
A human readable name for the underlying technology of your service.
dd_tags
string
The tags you want to assign to your logs in Datadog.
host
string
Host is the Datadog server where you are sending your logs.
include_tag_key
boolean
If enabled, a tag is appended to output. The key name is used tag_key property.
json_date_key
string
Date key name for output.
provider
string
To activate the remapping, specify configuration flag provider.
proxy
string
Specify an HTTP Proxy.
tag_key
string
The key name of tag. If include_tag_key is false, This property is ignored.
tls
boolean
TLS controls whether to use end-to-end security communications security protocol.
Datadog recommends setting this to on.
es object
Elasticsearch defines Elasticsearch Output configuration.
awsAuth
string
Enable AWS Sigv4 Authentication for Amazon ElasticSearch Service.
awsAuthSecret object
AWSAuthSecret Enable AWS Sigv4 Authentication for Amazon ElasticSearch Service.
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
awsExternalID
string
External ID for the AWS IAM Role specified with aws_role_arn.
awsRegion
string
Specify the AWS region for Amazon ElasticSearch Service.
awsRoleARN
string
AWS IAM Role to assume to put records to your Amazon ES cluster.
awsSTSEndpoint
string
Specify the custom sts endpoint to be used with STS API for Amazon ElasticSearch Service.
bufferSize
string
Specify the buffer size used to read the response from the Elasticsearch HTTP service.
This option is useful for debugging purposes where is required to read full responses,
note that response size grows depending of the number of records inserted.
To set an unlimited amount of memory set this value to False,
otherwise the value must be according to the Unit Size specification.
pattern:
^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
cloudAuth
string
Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud.
cloudAuthSecret object
CloudAuthSecret Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud.
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
string
If you are using Elastic's Elasticsearch Service you can specify the cloud_id of the cluster running.
compress
string
Set payload compression mechanism. Option available is 'gzip'
enum:
gzip
currentTimeIndex
boolean
Use current time for index generation instead of message record
generateID
boolean
When enabled, generate _id for outgoing records.
This prevents duplicate records when retrying ES.
host
string
IP address or hostname of the target Elasticsearch instance
httpPassword object
Password for user defined in HTTP_User
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
Optional username credential for Elastic X-Pack access
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
idKey
string
If set, _id will be the value of the key from incoming record and Generate_ID option is ignored.
includeTagKey
boolean
When enabled, it append the Tag name to the record.
index
string
Index name
logstashDateFormat
string
Time format (based on strftime) to generate the second part of the Index name.
logstashFormat
boolean
Enable Logstash format compatibility.
This option takes a boolean value: True/False, On/Off
logstashPrefix
string
When Logstash_Format is enabled, the Index name is composed using a prefix and the date,
e.g: If Logstash_Prefix is equals to 'mydata' your index will become 'mydata-YYYY.MM.DD'.
The last string appended belongs to the date when the data is being generated.
logstashPrefixKey
string
Prefix keys with this string
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
path
string
Elasticsearch accepts new data on HTTP query path "/_bulk".
But it is also possible to serve Elasticsearch behind a reverse proxy on a subpath.
This option defines such path on the fluent-bit side.
It simply adds a path prefix in the indexing HTTP POST URI.
pipeline
string
Newer versions of Elasticsearch allows setting up filters called pipelines.
This option allows defining which pipeline the database should use.
For performance reasons is strongly suggested parsing
and filtering on Fluent Bit side, avoid pipelines.
port
integer
TCP port of the target Elasticsearch instance
format:
int32minimum:
1maximum:
65535
replaceDots
boolean
When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3.
suppressTypeName
string
When enabled, mapping types is removed and Type option is ignored. Types are deprecated in APIs in v7.0. This options is for v7.0 or later.
tagKey
string
When Include_Tag_Key is enabled, this property defines the key name for the tag.
timeKey
string
When Logstash_Format is enabled, each record will get a new timestamp field.
The Time_Key property defines the name of that field.
timeKeyFormat
string
When Logstash_Format is enabled, this property defines the format of the timestamp.
timeKeyNanos
boolean
When Logstash_Format is enabled, enabling this property sends nanosecond precision timestamps.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
totalLimitSize
string
Limit the maximum number of Chunks in the filesystem for the current output logical destination.
traceError
boolean
When enabled print the elasticsearch API calls to stdout when elasticsearch returns an error
traceOutput
boolean
When enabled print the elasticsearch API calls to stdout (for diag only)
type
string
Type name
writeOperation
string
Operation to use to write in bulk requests.
file object
File defines File Output configuration.
delimiter
string
The character to separate each pair. Applicable only if format is csv or ltsv.
file
string
Set file name to store the records. If not set, the file name will be the tag associated with the records.
format
string
The format of the file content. See also Format section. Default: out_file.
enum:
out_file, plain, csv, ltsv, template
labelDelimiter
string
The character to separate each pair. Applicable only if format is ltsv.
path
string
Absolute directory path to store files. If not set, Fluent Bit will write the files on it's own positioned directory.
template
string
The format string. Applicable only if format is template.
firehose object
Firehose defines Firehose Output configuration.
autoRetryRequests
boolean
Immediately retry failed requests to AWS services once. This option does not affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which may help improve throughput when there are transient/random networking issues.
compression
string
Compression type to use when compressing the data. Valid values are: gzip, snappy, lz4, zstd. If you do not specify a compression type, the data will be sent uncompressed.
enum:
gzip, snappy, lz4, zstd
dataKeys
string
By default, the whole log record will be sent to Kinesis. If you specify a key name(s) with this option, then only those keys and values will be sent to Kinesis. For example, if you are using the Fluentd Docker log driver, you can specify data_keys log and only the log message will be sent to Kinesis. If you specify multiple keys, they should be comma delimited.
deliveryStream
string required
The name of the Kinesis Firehose Delivery stream that you want log records sent to.
endpoint
string
Specify a custom endpoint for the Kinesis Firehose API.
externalID
string
Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID.
logKey
string
By default, the whole log record will be sent to Firehose. If you specify a key name with this option, then only the value of that key will be sent to Firehose. For example, if you are using the Fluentd Docker log driver, you can specify log_key log and only the log message will be sent to Firehose.
profile
string
Option to specify an AWS Profile for credentials.
region
string required
The AWS region.
roleARN
string
ARN of an IAM role to assume (for cross account access).
simpleAggregation
boolean
Option to enable simple aggregation for the Firehose output plugin.
stsEndpoint
string
Specify a custom endpoint for the STS API; used to assume your custom role provided with role_arn.
timeKey
string
Add the timestamp to the record under this key. By default, the timestamp from Fluent Bit will not be added to records sent to Kinesis.
timeKeyFormat
string
strftime compliant format string for the timestamp; for example, %Y-%m-%dT%H *string This option is used with time_key. You can also use %L for milliseconds and %f for microseconds. If you are using ECS FireLens, make sure you are running Amazon ECS Container Agent v1.42.0 or later, otherwise the timestamps associated with your container logs will only have second precision.
workers
integer
Specify number of worker threads to use to output to Firehose
format:
int32forward object
Forward defines Forward Output configuration.
emptySharedKey
boolean
Use this option to connect to Fluentd with a zero-length secret.
host
string
Target host where Fluent-Bit or Fluentd are listening for Forward messages.
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
password object
Specify the password corresponding to the username.
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
integer
TCP Port of the target service.
format:
int32minimum:
1maximum:
65535
requireAckResponse
boolean
Send "chunk"-option and wait for "ack" response from server.
Enables at-least-once and receiving server can control rate of traffic.
(Requires Fluentd v0.14.0+ server)
retainMetadataInForwardMode
boolean
Retain metadata when forwarding in forward mode.
selfHostname
string
Default value of the auto-generated certificate common name (CN).
sendOptions
boolean
Always send options (with "size"=count of messages)
sharedKey
string
A key string known by the remote Fluentd used for authorization.
tag
string
Overwrite the tag as we transmit. This allows the receiving pipeline start
fresh, or to attribute source.
timeAsInteger
boolean
Set timestamps in integer format, it enable compatibility mode for Fluentd v0.12 series.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
username object
Specify the username to present to a Fluentd server that enables user_auth.
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
gelf object
Gelf defines GELF Output configuration.
compress
boolean
If transport protocol is udp, it defines if UDP packets should be compressed.
fullMessageKey
string
FullMessageKey is the key to use as the long message that can i.e. contain a backtrace.
host
string
IP address or hostname of the target Graylog server.
hostKey
string
HostKey is the key which its value is used as the name of the host, source or application that sent this message.
levelKey
string
LevelKey is the key to be used as the log level.
mode
string
The protocol to use (tls, tcp or udp).
enum:
tls, tcp, udpnetworking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
packetSize
integer
If transport protocol is udp, it sets the size of packets to be sent.
format:
int32
port
integer
The port that the target Graylog server is listening on.
format:
int32minimum:
1maximum:
65535
shortMessageKey
string
ShortMessageKey is the key to use as the short message.
timestampKey
string
TimestampKey is the key which its value is used as the timestamp of the message.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
http object
HTTP defines HTTP Output configuration.
allowDuplicatedHeaders
boolean
Specify if duplicated headers are allowed.
If a duplicated header is found, the latest key/value set is preserved.
compress
string
Set payload compression mechanism. Option available is 'gzip'
format
string
Specify the data format to be used in the HTTP request body, by default it uses msgpack.
Other supported formats are json, json_stream and json_lines and gelf.
enum:
msgpack, json, json_stream, json_lines, gelf
gelfFullMessageKey
string
Specify the key to use for the full message in gelf format
gelfHostKey
string
Specify the key to use for the host in gelf format
gelfLevelKey
string
Specify the key to use for the level in gelf format
gelfShortMessageKey
string
Specify the key to use as the short message in gelf format
gelfTimestampKey
string
Specify the key to use for timestamp in gelf format
headerTag
string
Specify an optional HTTP header field for the original message tag.
headers
object
Add a HTTP header key/value pair. Multiple headers can be set.
host
string
IP address or hostname of the target HTTP Server
httpPassword object
Basic Auth Password. Requires HTTP_User to be set
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
Basic Auth Username
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
jsonDateFormat
string
Specify the format of the date. Supported formats are double, epoch
and iso8601 (eg: 2018-05-30T09:39:52.000681Z)
jsonDateKey
string
Specify the name of the time key in the output record.
To disable the time key just set the value to false.
logResponsePayload
boolean
Specify if the response paylod should be logged or not.
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
port
integer
TCP port of the target HTTP Server
format:
int32minimum:
1maximum:
65535
proxy
string
Specify an HTTP Proxy. The expected format of this value is http://host:port.
Note that https is not supported yet.
tls object
HTTP output plugin supports TTL/SSL, for more details about the properties available
and general configuration, please refer to the TLS/SSL section.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
totalLimitSize
string
Limit the maximum number of Chunks in the filesystem for the current output logical destination.
uri
string
Specify an optional HTTP URI for the target web server, e.g: /something
influxDB object
InfluxDB defines InfluxDB Output configuration.
autoTags
boolean
Automatically tag keys where value is string.
bucket
string
InfluxDB bucket name where records will be inserted - if specified, database is ignored and v2 of API is used
database
string
InfluxDB database name where records will be inserted.
host
string required
IP address or hostname of the target InfluxDB service.
httpPassword object
Password for user defined in HTTP_User
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
httpToken object
Authentication token used with InfluxDB v2 - if specified, both HTTPUser and HTTPPasswd 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
httpUser object
Optional username for HTTP 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
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
org
string
InfluxDB organization name where the bucket is (v2 only)
port
integer
TCP port of the target InfluxDB service.
format:
int32minimum:
1maximum:
65535
sequenceTag
string
The name of the tag whose value is incremented for the consecutive simultaneous events.
tagKeys
[]string
List of keys that needs to be tagged
tagListKey
string
Key of the string array optionally contained within each log record that contains tag keys for that record
tagsListEnabled
boolean
Dynamically tag keys which are in the string array at Tags_List_Key key.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
kafka object
Kafka defines Kafka Output configuration.
brokers
string
Single of multiple list of Kafka Brokers, e.g: 192.168.1.3:9092, 192.168.1.4:9092.
dynamicTopic
boolean
Adds unknown topics (found in Topic_Key) to Topics. So in Topics only a default topic needs to be configured
format
string
Specify data format, options available: json, msgpack.
messageKey
string
Optional key to store the message
messageKeyField
string
If set, the value of Message_Key_Field in the record will indicate the message key.
If not set nor found in the record, Message_Key will be used (if set).
queueFullRetries
integer
Fluent Bit queues data into rdkafka library,
if for some reason the underlying library cannot flush the records the queue might fills up blocking new addition of records.
The queue_full_retries option set the number of local retries to enqueue the data.
The default value is 10 times, the interval between each retry is 1 second.
Setting the queue_full_retries value to 0 set's an unlimited number of retries.
format:
int64
rdkafka
object
{property} can be any librdkafka properties
timestampFormat
string
iso8601 or double
timestampKey
string
Set the key to store the record timestamp
topicKey
string
If multiple Topics exists, the value of Topic_Key in the record will indicate the topic to use.
E.g: if Topic_Key is router and the record is {"key1": 123, "router": "route_2"},
Fluent Bit will use topic route_2. Note that if the value of Topic_Key is not present in Topics,
then by default the first topic in the Topics list will indicate the topic to be used.
topics
string
Single entry or list of topics separated by comma (,) that Fluent Bit will use to send messages to Kafka.
If only one topic is set, that one will be used for all records.
Instead if multiple topics exists, the one set in the record by Topic_Key will be used.
totalLimitSize
string
Limit the maximum number of Chunks in the filesystem for the current output logical destination.
workers
integer
Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0.
format:
int32kinesis object
Kinesis defines Kinesis Output configuration.
autoRetryRequests
boolean
Immediately retry failed requests to AWS services once. This option does not affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which may help improve throughput when there are transient/random networking issues. This option defaults to true.
endpoint
string
Specify a custom endpoint for the Kinesis API.
externalID
string
Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID.
logKey
string
By default, the whole log record will be sent to Kinesis. If you specify a key name with this option, then only the value of that key will be sent to Kinesis. For example, if you are using the Fluentd Docker log driver, you can specify log_key log and only the log message will be sent to Kinesis.
region
string required
The AWS region.
minLength:
1
roleARN
string
ARN of an IAM role to assume (for cross account access).
stream
string required
The name of the Kinesis Streams Delivery stream that you want log records sent to.
stsEndpoint
string
Custom endpoint for the STS API.
timeKey
string
Add the timestamp to the record under this key. By default the timestamp from Fluent Bit will not be added to records sent to Kinesis.
timeKeyFormat
string
strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'. Supports millisecond precision with '%3N' and supports nanosecond precision with '%9N' and '%L'; for example, adding '%3N' to support millisecond '%Y-%m-%dT%H:%M:%S.%3N'. This option is used with time_key.
logLevel
string
Set the plugin's logging verbosity level. Allowed values are: off, error, warn, info, debug and trace, Defaults to the SERVICE section's Log_Level
enum:
off, error, warning, info, debug, traceloki object
Loki defines Loki Output configuration.
autoKubernetesLabels
string
If set to true, it will add all Kubernetes labels to the Stream labels.
enum:
on, offbearerToken object
Set bearer token authentication token value.
Can be used as alterntative to HTTP 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
dropSingleKey
string
If set to true and after extracting labels only a single key remains, the log line sent to Loki will be the value of that key in line_format.
enum:
on, off
host
string required
Loki hostname or IP address.
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
labelKeys
[]string
Optional list of record keys that will be placed as stream labels.
This configuration property is for records key only.
labelMapPath
string
Specify the label map file path. The file defines how to extract labels from each record.
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 Fluent Bit 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_valuenetworking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
port
integer
Loki TCP port
format:
int32minimum:
1maximum:
65535
removeKeys
[]string
Optional list of keys to remove.
structuredMetadata
object
Stream structured metadata for API request. It can be multiple comma separated key=value pairs.
This is used for high cardinality data that isn't suited for using labels.
Only supported in Loki 3.0+ with schema v13 and TSDB storage.
structuredMetadataKeys
[]string
Optional list of record keys that will be placed as structured metadata.
This allows using record accessor patterns (e.g. $kubernetes['pod_name']) to reference record keys.
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
tenantIDKey
string
Specify the name of the key from the original record that contains the Tenant ID.
The value of the key is set as X-Scope-OrgID of HTTP header. It is useful to set Tenant ID dynamically.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
totalLimitSize
string
Limit the maximum number of Chunks in the filesystem for the current output logical destination.
uri
string
Specify a custom HTTP URI. It must start with forward slash.
workers
integer
Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0.
format:
int32
match
string
A pattern to match against the tags of incoming records.
It's case sensitive and support the star (*) character as a wildcard.
matchRegex
string
A regular expression to match against the tags of incoming records.
Use this option if you want to use the full regex syntax.
null
object
Null defines Null Output configuration.
opensearch object
OpenSearch defines OpenSearch Output configuration.
awsAuth
string
Enable AWS Sigv4 Authentication for Amazon OpenSearch Service.
awsExternalID
string
External ID for the AWS IAM Role specified with aws_role_arn.
awsRegion
string
Specify the AWS region for Amazon OpenSearch Service.
awsRoleARN
string
AWS IAM Role to assume to put records to your Amazon cluster.
awsSTSEndpoint
string
Specify the custom sts endpoint to be used with STS API for Amazon OpenSearch Service.
bufferSize
string
Specify the buffer size used to read the response from the OpenSearch HTTP service.
This option is useful for debugging purposes where is required to read full responses,
note that response size grows depending of the number of records inserted.
To set an unlimited amount of memory set this value to False,
otherwise the value must be according to the Unit Size specification.
pattern:
^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
compress
string
enum:
gzip
currentTimeIndex
boolean
Use current time for index generation instead of message record
generateID
boolean
When enabled, generate _id for outgoing records.
This prevents duplicate records when retrying OpenSearch.
host
string
IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
httpPassword object
Password for user defined in HTTP_User
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
Optional username credential for access
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
idKey
string
If set, _id will be the value of the key from incoming record and Generate_ID option is ignored.
includeTagKey
boolean
When enabled, it append the Tag name to the record.
index
string
Index name
logstashDateFormat
string
Time format (based on strftime) to generate the second part of the Index name.
logstashFormat
boolean
Enable Logstash format compatibility.
This option takes a boolean value: True/False, On/Off
logstashPrefix
string
When Logstash_Format is enabled, the Index name is composed using a prefix and the date,
e.g: If Logstash_Prefix is equals to 'mydata' your index will become 'mydata-YYYY.MM.DD'.
The last string appended belongs to the date when the data is being generated.
logstashPrefixKey
string
Prefix keys with this string
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
path
string
OpenSearch accepts new data on HTTP query path "/_bulk".
But it is also possible to serve OpenSearch behind a reverse proxy on a subpath.
This option defines such path on the fluent-bit side.
It simply adds a path prefix in the indexing HTTP POST URI.
pipeline
string
OpenSearch allows to setup filters called pipelines.
This option allows to define which pipeline the database should use.
For performance reasons is strongly suggested to do parsing
and filtering on Fluent Bit side, avoid pipelines.
port
integer
TCP port of the target OpenSearch instance, default `9200`
format:
int32minimum:
1maximum:
65535
replaceDots
boolean
When enabled, replace field name dots with underscore, required by Opensearch 2.0-2.3.
suppressTypeName
boolean
When enabled, mapping types is removed and Type option is ignored. Types are deprecated in APIs in v7.0. This options is for v7.0 or later.
tagKey
string
When Include_Tag_Key is enabled, this property defines the key name for the tag.
timeKey
string
When Logstash_Format is enabled, each record will get a new timestamp field.
The Time_Key property defines the name of that field.
timeKeyFormat
string
When Logstash_Format is enabled, this property defines the format of the timestamp.
timeKeyNanos
boolean
When Logstash_Format is enabled, enabling this property sends nanosecond precision timestamps.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
totalLimitSize
string
Limit the maximum number of Chunks in the filesystem for the current output logical destination.
traceError
boolean
When enabled print the Opensearch API calls to stdout when Opensearch returns an error
traceOutput
boolean
When enabled print the Opensearch API calls to stdout (for diag only)
type
string
Type name
workers
integer
Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0.
format:
int32
writeOperation
string
Operation to use to write in bulk requests.
opentelemetry object
OpenTelemetry defines OpenTelemetry Output configuration.
addLabel
object
This allows you to add custom labels to all metrics exposed through the OpenTelemetry exporter. You may have multiple of these fields.
header
object
Add a HTTP header key/value pair. Multiple headers can be set.
host
string
IP address or hostname of the target HTTP Server, default `127.0.0.1`
httpPassword object
Password for user defined in HTTP_User
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
Optional username credential for access
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
logResponsePayload
boolean
Log the response payload within the Fluent Bit log.
logsBodyKey
string
The log body key to look up in the log events body/message. Sets the Body field of the opentelemtry logs data model.
logsBodyKeyAttributes
boolean
If true, remaining unmatched keys are added as attributes.
logsUri
string
Specify an optional HTTP URI for the target web server listening for logs, e.g: /v1/logs
metricsUri
string
Specify an optional HTTP URI for the target web server listening for metrics, e.g: /v1/metrics
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
port
integer
TCP port of the target OpenSearch instance, default `80`
format:
int32minimum:
1maximum:
65535
proxy
string
Specify an HTTP Proxy. The expected format of this value is http://HOST:PORT. Note that HTTPS is not currently supported.
It is recommended not to set this and to configure the HTTP proxy environment variables instead as they support both HTTP and HTTPS.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
totalLimitSize
string
Limit the maximum number of Chunks in the filesystem for the current output logical destination.
tracesUri
string
Specify an optional HTTP URI for the target web server listening for traces, e.g: /v1/traces
processors
object
Processors defines the processors configuration
prometheusExporter object
PrometheusExporter_types defines Prometheus exporter configuration to expose metrics from Fluent Bit.
addLabels
object
This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields
host
string required
IP address or hostname of the target HTTP Server, default: 0.0.0.0
port
integer
This is the port Fluent Bit will bind to when hosting prometheus metrics.
format:
int32minimum:
1maximum:
65535prometheusRemoteWrite object
PrometheusRemoteWrite_types defines Prometheus Remote Write configuration.
addLabels
object
This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields
headers
object
Add a HTTP header key/value pair. Multiple headers can be set.
host
string required
IP address or hostname of the target HTTP Server, default: 127.0.0.1
httpPasswd object
Basic Auth Password.
Requires HTTP_user to be se
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
Basic Auth Username
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
logResponsePayload
boolean
Log the response payload within the Fluent Bit log,default: false
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
port
integer
TCP port of the target HTTP Serveri, default:80
format:
int32minimum:
1maximum:
65535
proxy
string
Specify an HTTP Proxy. The expected format of this value is http://HOST:PORT.
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
uri
string
Specify an optional HTTP URI for the target web server, e.g: /something ,default: /
workers
integer
Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0,default : 2
format:
int32
retry_limit
string
RetryLimit represents configuration for the scheduler which can be set independently on each output section.
This option allows to disable retries or impose a limit to try N times and then discard the data after reaching that limit.
s3 object
S3 defines S3 Output configuration.
AutoRetryRequests
boolean
Immediately retry failed requests to AWS services once.
Bucket
string required
S3 Bucket name
CannedAcl
string
Predefined Canned ACL Policy for S3 objects.
Compression
string
Compression type for S3 objects.
ContentType
string
A standard MIME type for the S3 object; this will be set as the Content-Type HTTP header.
Endpoint
string
Custom endpoint for the S3 API.
ExternalId
string
Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID.
JsonDateFormat
string
Specify the format of the date. Supported formats are double, epoch, iso8601 (eg: 2018-05-30T09:39:52.000681Z) and java_sql_timestamp (eg: 2018-05-30 09:39:52.000681)
JsonDateKey
string
Specify the name of the time key in the output record. To disable the time key just set the value to false.
LogKey
string
By default, the whole log record will be sent to S3. If you specify a key name with this option, then only the value of that key will be sent to S3.
PreserveDataOrdering
boolean
Normally, when an upload request fails, there is a high chance for the last received chunk to be swapped with a later chunk, resulting in data shuffling. This feature prevents this shuffling by using a queue logic for uploads.
Profile
string
Option to specify an AWS Profile for credentials.
Region
string required
The AWS region of your S3 bucket
RetryLimit
integer
Integer value to set the maximum number of retries allowed.
format:
int32
RoleArn
string
ARN of an IAM role to assume
S3KeyFormat
string
Format string for keys in S3.
S3KeyFormatTagDelimiters
string
A series of characters which will be used to split the tag into 'parts' for use with the s3_key_format option.
SendContentMd5
boolean
Send the Content-MD5 header with PutObject and UploadPart requests, as is required when Object Lock is enabled.
StaticFilePath
boolean
Disables behavior where UUID string is automatically appended to end of S3 key name when $UUID is not provided in s3_key_format. $UUID, time formatters, $TAG, and other dynamic key formatters all work as expected while this feature is set to true.
StorageClass
string
Specify the storage class for S3 objects. If this option is not specified, objects will be stored with the default 'STANDARD' storage class.
StoreDir
string
Directory to locally buffer data before sending.
StoreDirLimitSize
string
The size of the limitation for disk usage in S3.
StsEndpoint
string
Custom endpoint for the STS API.
TotalFileSize
string
Specifies the size of files in S3. Minimum size is 1M. With use_put_object On the maximum size is 1G. With multipart upload mode, the maximum size is 50G.
UploadChunkSize
string
The size of each 'part' for multipart uploads. Max: 50M
UploadTimeout
string
Whenever this amount of time has elapsed, Fluent Bit will complete an upload and create a new file in S3. For example, set this value to 60m and you will get a new file every hour.
UsePutObject
boolean
Use the S3 PutObject API, instead of the multipart upload API.
Workers
integer
Specify number of worker threads to use to output to S3
format:
int32tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
splunk object
Splunk defines Splunk Output Configuration
Workers
integer
Enables dedicated thread(s) for this output. Default value `2` is set since version 1.8.13. For previous versions is 0.
format:
int32
channel
string
Specify X-Splunk-Request-Channel Header for the HTTP Event Collector interface.
compress
string
Set payload compression mechanism. The only available option is gzip.
eventFields
[]string
Set event fields for the record. This option is an array and the format is "key_name
record_accessor_pattern".
eventHost
string
Specify the key name that contains the host value. This option allows a record accessors pattern.
eventIndex
string
The name of the index by which the event data is to be indexed.
eventIndexKey
string
Set a record key that will populate the index field. If the key is found, it will have precedence
over the value set in event_index.
eventKey
string
Specify the key name that will be used to send a single value as part of the record.
eventSource
string
Set the source value to assign to the event data.
eventSourcetype
string
Set the sourcetype value to assign to the event data.
eventSourcetypeKey
string
Set a record key that will populate 'sourcetype'. If the key is found, it will have precedence
over the value set in event_sourcetype.
host
string
IP address or hostname of the target OpenSearch instance, default `127.0.0.1`
httpBufferSize
string
Buffer size used to receive Splunk HTTP responses: Default `2M`
pattern:
^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
httpDebugBadRequest
boolean
If the HTTP server response code is 400 (bad request) and this flag is enabled, it will print the full HTTP request
and response to the stdout interface. This feature is available for debugging purposes.
httpPassword object
Password for user defined in HTTP_User
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
Optional username credential for access
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
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
port
integer
TCP port of the target Splunk instance, default `8088`
format:
int32minimum:
1maximum:
65535
splunkSendRaw
boolean
When enabled, the record keys and values are set in the top level of the map instead of under the event key. Refer to
the Sending Raw Events section from the docs more details to make this option work properly.
splunkToken object
Specify the Authentication Token for the HTTP Event Collector interface.
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
tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
stackdriver object
Stackdriver defines Stackdriver Output Configuration
autoformatStackdriverTrace
boolean
Rewrite the trace field to be formatted for use with GCP Cloud Trace
customK8sRegex
string
A custom regex to extract fields from the local_resource_id of the logs
exportToProjectID
string
The GCP Project that should receive the logs
googleServiceCredentials
string
Path to GCP Credentials JSON file
job
string
Identifier for a grouping of tasks. Required if Resource is generic_task
k8sClusterLocation
string
Location of the cluster that contains the pods/nodes. Required if Resource is k8s_container, k8s_node, or k8s_pod
k8sClusterName
string
Name of the cluster that the pod is running in. Required if Resource is k8s_container, k8s_node, or k8s_pod
labels
[]string
Optional list of comma separated of strings for key/value pairs
labelsKey
string
Used by Stackdriver to find related labels and extract them to LogEntry Labels
location
string
GCP/AWS region to store data. Required if Resource is generic_node or generic_task
logNameKey
string
The value of this field is set as the logName field in Stackdriver
metadataServer
string
Metadata Server Prefix
namespace
string
Namespace identifier. Required if Resource is generic_node or generic_task
nodeID
string
Node identifier within the namespace. Required if Resource is generic_node or generic_task
resource
string
Set resource types of data
resourceLabels
[]string
Optional list of comma separated strings. Setting these fields overrides the Stackdriver monitored resource API values
serviceAccountEmail object
Email associated with the service
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
serviceAccountSecret object
Private Key associated with the service
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
severityKey
string
Specify the key that contains the severity information for the logs
tagPrefix
string
Used to validate the tags of logs that when the Resource is k8s_container, k8s_node, or k8s_pod
taskID
string
Identifier for a task within a namespace. Required if Resource is generic_task
textPayloadKey
string
The key used to select the text payload from the record
workers
integer
Number of dedicated threads for the Stackdriver Output Plugin
format:
int32stdout object
Stdout defines Stdout Output configuration.
format
string
Specify the data format to be printed. Supported formats are msgpack json, json_lines and json_stream.
enum:
msgpack, json, json_lines, json_stream
jsonDateFormat
string
Specify the format of the date. Supported formats are double, iso8601 (eg: 2018-05-30T09:39:52.000681Z) and epoch.
enum:
double, iso8601, epoch
jsonDateKey
string
Specify the name of the date field in output.
syslog object
Syslog defines Syslog Output configuration.
host
string
Host domain or IP address of the remote Syslog server.
mode
string
Mode of the desired transport type, the available options are tcp, tls and udp.
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
port
integer
TCP or UDP port of the remote Syslog server.
format:
int32minimum:
1maximum:
65535
syslogAppnameKey
string
Key name from the original record that contains the application name that generated the message.
syslogFacilityKey
string
Key from the original record that contains the Syslog facility number.
syslogFormat
string
Syslog protocol format to use, the available options are rfc3164 and rfc5424.
syslogHostnameKey
string
Key name from the original record that contains the hostname that generated the message.
syslogMaxSize
integer
Maximum size allowed per message, in bytes.
format:
int32
syslogMessageIDKey
string
Key name from the original record that contains the Message ID associated to the message.
syslogMessageKey
string
Key key name that contains the message to deliver.
syslogProcessIDKey
string
Key name from the original record that contains the Process ID that generated the message.
syslogSDKey
string
Key name from the original record that contains the Structured Data (SD) content.
syslogSeverityKey
string
Key from the original record that contains the Syslog severity number.
tls object
Syslog output plugin supports TTL/SSL, for more details about the properties available
and general configuration, please refer to the TLS/SSL section.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
totalLimitSize
string
Limit the maximum number of Chunks in the filesystem for the current output logical destination.
workers
integer
Enables dedicated thread(s) for this output. Default value is set since version 1.8.13. For previous versions is 0.
format:
int32tcp object
TCP defines TCP Output configuration.
format
string
Specify the data format to be printed. Supported formats are msgpack json, json_lines and json_stream.
enum:
msgpack, json, json_lines, json_stream
host
string
Target host where Fluent-Bit or Fluentd are listening for Forward messages.
jsonDateFormat
string
Specify the format of the date. Supported formats are double, epoch
and iso8601 (eg: 2018-05-30T09:39:52.000681Z)
enum:
double, epoch, iso8601
jsonDateKey
string
TSpecify the name of the time key in the output record.
To disable the time key just set the value to false.
networking object
Include fluentbit networking options for this output-plugin
DNSMode
string
Select the primary DNS connection type (TCP or UDP).
enum:
TCP, UDP
DNSPreferIPv4
boolean
Prioritize IPv4 DNS results when trying to establish a connection.
DNSResolver
string
Select the primary DNS resolver type (LEGACY or ASYNC).
enum:
LEGACY, ASYNC
connectTimeout
integer
Set maximum time expressed in seconds to wait for a TCP connection to be established, this include the TLS handshake time.
format:
int32
connectTimeoutLogError
boolean
On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.
keepalive
string
Enable or disable connection keepalive support. Accepts a boolean value: on / off.
enum:
on, off
keepaliveIdleTimeout
integer
Set maximum time expressed in seconds for an idle keepalive connection.
format:
int32
keepaliveMaxRecycle
integer
Set maximum number of times a keepalive connection can be used before it is retired.
format:
int32
maxWorkerConnections
integer
Set maximum number of TCP connections that can be established per worker.
format:
int32
sourceAddress
string
Specify network address to bind for data traffic.
port
integer
TCP Port of the target service.
format:
int32minimum:
1maximum:
65535tls object
Fluent Bit provides integrated support for Transport Layer Security (TLS) and it predecessor Secure Sockets Layer (SSL) respectively.
caFile
string
Absolute path to CA certificate file
caPath
string
Absolute path to scan for certificate files
crtFile
string
Absolute path to Certificate file
debug
integer
Set TLS debug verbosity level.
It accept the following values: 0 (No debug), 1 (Error), 2 (State change), 3 (Informational) and 4 Verbose
enum:
0, 1, 2, 3, 4format:
int32
keyFile
string
Absolute path to private Key file
keyPassword object
Optional password for tls.key_file 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
verify
boolean
Force certificate validation
vhost
string
Hostname to be used for TLS SNI extension
No matches. Try .spec.alias for an exact path