FluentBitConfig
fluentbit.fluent.io / v1alpha2
apiVersion: fluentbit.fluent.io/v1alpha2
kind: FluentBitConfig
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
NamespacedFluentBitCfgSpec defines the desired state of FluentBit
clusterMultilineParserSelector object
Select cluster level multiline parser config
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
clusterParserSelector object
Select cluster level parser config
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
filterSelector object
Select filter plugins
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
multilineParserSelector object
Select multiline parser plugins
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
outputSelector object
Select output plugins
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
parserSelector object
Select parser plugins
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key
string required
key is the label key that the selector applies to.
operator
string required
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
values
[]string
values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.
matchLabels
object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.
service object
Service defines the global behaviour of the Fluent Bit engine.
daemon
boolean
If true go to background on start
emitterMemBufLimit
string
emitterName
string
Per-namespace re-emitter configuration
emitterStorageType
string
enableChunkTrace
boolean
Enable input/output tracing on debug images, controlled more granualry via the http API
flushSeconds
number
Interval to flush output
graceSeconds
integer
Wait time on exit
format:
int64
hcErrorsCount
integer
the error count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period, example for output error: [2022/02/16 10:44:10] [ warn] [engine] failed to flush chunk '1-1645008245.491540684.flb', retry in 7 seconds: task_id=0, input=forward.1 > output=cloudwatch_logs.3 (out_id=3)
format:
int64minimum:
1
hcPeriod
integer
The time period by second to count the error and retry failure data point
format:
int64minimum:
1
hcRetryFailureCount
integer
the retry failure count to meet the unhealthy requirement, this is a sum for all output plugins in a defined HC_Period, example for retry failure: [2022/02/16 20:11:36] [ warn] [engine] chunk '1-1645042288.260516436.flb' cannot be retried: task_id=0, input=tcp.3 > output=cloudwatch_logs.1
format:
int64minimum:
1
healthCheck
boolean
enable Health check feature at http://127.0.0.1:2020/api/v1/health Note: Enabling this will not automatically configure kubernetes to use fluentbit's healthcheck endpoint
hotReload
boolean
If true enable reloading via HTTP
hotReloadEnsureThreadSafety
boolean
If true, preserve thread safety during hot reload by waiting for in-flight work to drain before reloading; this wait can be bounded by hotReloadTimeout.
hotReloadTimeout
integer
Maximum time in seconds to wait for a hot reload to complete before aborting.
format:
int32
httpListen
string
Address to listen
pattern:
^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(([A-Fa-f0-9:]+:+)+[A-Fa-f0-9]*)$
httpPort
integer
Port to listen
format:
int32minimum:
1maximum:
65535
httpServer
boolean
If true enable statistics HTTP server
logFile
string
File to log diagnostic output
logLevel
string
Diagnostic level (error/warning/info/debug/trace)
enum:
off, error, warning, info, debug, trace
multilineBufferLimit
string
Set a default buffer size limit for multiline parsers. The value must be according to the Unit Size specification.
pattern:
^\d+(k|K|KB|kb|m|M|MB|mb|g|G|GB|gb)?$
parsersFile
string
Optional 'parsers' config file (can be multiple)
parsersFiles
[]string
backward compatible
schedulerBase
integer
Set a base for exponential backoff in the scheduler. Supported in Fluent Bit >= 1.8.7
format:
int32
schedulerCap
integer
Set a maximum retry time in seconds for the scheduler. Supported in Fluent Bit >= 1.8.7
format:
int32storage object
Configure a global environment for the storage layer in Service. It is recommended to configure the volume and volumeMount separately for this storage. The hostPath type should be used for that Volume in Fluentbit daemon set.
backlogMemLimit
string
This option configure a hint of maximum value of memory to use when processing these records
checksum
string
Enable the data integrity check when writing and reading data from the filesystem
enum:
on, off
deleteIrrecoverableChunks
string
When enabled, irrecoverable chunks will be deleted during runtime, and any other irrecoverable chunk located in the configured storage path directory will be deleted when Fluent-Bit starts.
enum:
on, off
maxChunksUp
integer
If the input plugin has enabled filesystem storage type, this property sets the maximum number of Chunks that can be up in memory
format:
int64
metrics
string
If http_server option has been enabled in the Service section, this option registers a new endpoint where internal metrics of the storage layer can be consumed
enum:
on, off
path
string
Select an optional location in the file system to store streams and chunks of data/
sync
string
Configure the synchronization mode used to store the data into the file system
enum:
normal, fullNo matches. Try .spec.clusterMultilineParserSelector for an exact path