This Document documents the types introduced by the fluentbit Operator.
Note this document is generated from code comments. When contributing a change to this document please do so by changing the code comments.
ClusterFilter defines a cluster-level Filter configuration.
Field
Description
Scheme
metadata
metav1.ObjectMeta
spec
Specification of desired Filter configuration.
FilterSpec
Back to TOC
ClusterFilterList contains a list of ClusterFilter
Back to TOC
ClusterFluentBitConfig is the Schema for the cluster-level fluentbitconfigs API
Back to TOC
ClusterFluentBitConfigList ClusterFluentBitConfigList contains a list of ClusterFluentBitConfig
Field
Description
Scheme
metadata
metav1.ListMeta
items
[]ClusterFluentBitConfig
Back to TOC
ClusterInput is the Schema for the inputs API
Back to TOC
ClusterInputList contains a list of ClusterInput
Back to TOC
ClusterOutput is the Schema for the cluster-level outputs API
Back to TOC
ClusterOutputList contains a list of ClusterOutput
Back to TOC
ClusterParser is the Schema for the cluster-level parsers API
Back to TOC
ClusterParserList contains a list of ClusterParser
Back to TOC
Field
Description
Scheme
decodeField
If the content can be decoded in a structured message, append that structure message (keys and values) to the original log message.
string
decodeFieldAs
Any content decoded (unstructured or structured) will be replaced in the same key/value, no extra keys are added.
string
Back to TOC
Field
Description
Scheme
grep
Grep defines Grep Filter configuration.
*filter.Grep
recordModifier
RecordModifier defines Record Modifier Filter configuration.
*filter.RecordModifier
kubernetes
Kubernetes defines Kubernetes Filter configuration.
*filter.Kubernetes
modify
Modify defines Modify Filter configuration.
*filter.Modify
nest
Nest defines Nest Filter configuration.
*filter.Nest
parser
Parser defines Parser Filter configuration.
*filter.Parser
lua
Lua defines Lua Filter configuration.
*filter.Lua
throttle
Throttle defines a Throttle configuration.
*filter.Throttle
rewriteTag
RewriteTag defines a RewriteTag configuration.
*filter.RewriteTag
aws
Aws defines a Aws configuration.
*filter.AWS
multiline
Multiline defines a Multiline configuration.
*filter.Multiline
customPlugin
CustomPlugin defines a Custom plugin configuration.
*custom.CustomPlugin
Back to TOC
FilterSpec defines the desired state of ClusterFilter
Field
Description
Scheme
match
A pattern to match against the tags of incoming records. It's case-sensitive and support the star (*) character as a wildcard.
string
matchRegex
A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.
string
filters
A set of filter plugins in order.
[]FilterItem
Back to TOC
FluentBit is the Schema for the fluentbits API
Field
Description
Scheme
metadata
metav1.ObjectMeta
spec
FluentBitSpec
status
FluentBitStatus
Back to TOC
FluentBitConfigSpec defines the desired state of ClusterFluentBitConfig
Field
Description
Scheme
service
Service defines the global behaviour of the Fluent Bit engine.
*Service
inputSelector
Select input plugins
metav1.LabelSelector
filterSelector
Select filter plugins
metav1.LabelSelector
outputSelector
Select output plugins
metav1.LabelSelector
parserSelector
Select parser plugins
metav1.LabelSelector
namespace
If namespace is defined, then the configmap and secret for fluent-bit is in this namespace. If it is not defined, it is in the namespace of the fluentd-operator
*string
Back to TOC
FluentBitList contains a list of FluentBit
Back to TOC
FluentBitSpec defines the desired state of FluentBit
Field
Description
Scheme
image
Fluent Bit image.
string
args
Fluent Bit Watcher command line arguments.
[]string
imagePullPolicy
Fluent Bit image pull policy.
corev1.PullPolicy
imagePullSecrets
Fluent Bit image pull secret
[]corev1.LocalObjectReference
positionDB
Storage for position db. You will use it if tail input is enabled.
corev1.VolumeSource
containerLogRealPath
Container log path
string
resources
Compute Resources required by container.
corev1.ResourceRequirements
nodeSelector
NodeSelector
map[string]string
affinity
Pod's scheduling constraints.
*corev1.Affinity
tolerations
Tolerations
[]corev1.Toleration
fluentBitConfigName
Fluentbitconfig object associated with this Fluentbit
string
secrets
The Secrets are mounted into /fluent-bit/secrets/.
[]string
runtimeClassName
RuntimeClassName represents the container runtime configuration.
string
priorityClassName
PriorityClassName represents the pod's priority class.
string
volumes
List of volumes that can be mounted by containers belonging to the pod.
[]corev1.Volume
volumesMounts
Pod volumes to mount into the container's filesystem.
[]corev1.VolumeMount
annotations
Annotations to add to each Fluentbit pod.
map[string]string
securityContext
SecurityContext holds pod-level security attributes and common container settings.
*corev1.PodSecurityContext
hostNetwork
Host networking is requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
bool
envVars
EnvVars represent environment variables that can be passed to fluentbit pods.
[]corev1.EnvVar
Back to TOC
InputSpec defines the desired state of ClusterInput
Field
Description
Scheme
alias
A user friendly alias name for this input plugin. Used in metrics for distinction of each configured input.
string
dummy
Dummy defines Dummy Input configuration.
*input.Dummy
tail
Tail defines Tail Input configuration.
*input.Tail
systemd
Systemd defines Systemd Input configuration.
*input.Systemd
nodeExporterMetrics
NodeExporterMetrics defines Node Exporter Metrics Input configuration.
*input.NodeExporterMetrics
prometheusScrapeMetrics
PrometheusScrapeMetrics defines Prometheus Scrape Metrics Input configuration.
*input.PrometheusScrapeMetrics
fluentBitMetrics
FluentBitMetrics defines Fluent Bit Metrics Input configuration.
*input.FluentbitMetrics
customPlugin
CustomPlugin defines Custom Input configuration.
*custom.CustomPlugin
Back to TOC
OutputSpec defines the desired state of ClusterOutput
Field
Description
Scheme
match
A pattern to match against the tags of incoming records. It's case sensitive and support the star (*) character as a wildcard.
string
matchRegex
A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax.
string
alias
A user friendly alias name for this output plugin. Used in metrics for distinction of each configured output.
string
retry_limit
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.
string
es
Elasticsearch defines Elasticsearch Output configuration.
*output.Elasticsearch
file
File defines File Output configuration.
*output.File
forward
Forward defines Forward Output configuration.
*output.Forward
http
HTTP defines HTTP Output configuration.
*output.HTTP
kafka
Kafka defines Kafka Output configuration.
*output.Kafka
null
Null defines Null Output configuration.
*output.Null
stdout
Stdout defines Stdout Output configuration.
*output.Stdout
tcp
TCP defines TCP Output configuration.
*output.TCP
loki
Loki defines Loki Output configuration.
*output.Loki
syslog
Syslog defines Syslog Output configuration.
*output.Syslog
datadog
DataDog defines DataDog Output configuration.
*output.DataDog
firehose
Firehose defines Firehose Output configuration.
*output.Firehose
splunk
Splunk defines Splunk Output Configuration
*output.Splunk
opensearch
OpenSearch defines OpenSearch Output configuration.
*output.OpenSearch
opentelemetry
OpenTelemetry defines OpenTelemetry Output configuration.
*output.OpenTelemetry
prometheusRemoteWrite
PrometheusRemoteWrite_types defines Prometheus Remote Write configuration.
*output.PrometheusRemoteWrite
customPlugin
CustomPlugin defines Custom Output configuration.
*custom.CustomPlugin
Back to TOC
ParserSpec defines the desired state of ClusterParser
Field
Description
Scheme
json
JSON defines json parser configuration.
*parser.JSON
regex
Regex defines regex parser configuration.
*parser.Regex
ltsv
LTSV defines ltsv parser configuration.
*parser.LSTV
logfmt
Logfmt defines logfmt parser configuration.
*parser.Logfmt
decoders
Decoders are a built-in feature available through the Parsers file, each Parser definition can optionally set one or multiple decoders. There are two type of decoders type: Decode_Field and Decode_Field_As.
[]Decorder
Back to TOC
Field
Description
Scheme
Name
string
Content
string
Back to TOC
Field
Description
Scheme
daemon
If true go to background on start
*bool
flushSeconds
Interval to flush output
*int64
graceSeconds
Wait time on exit
*int64
httpListen
Address to listen
string
httpPort
Port to listen
*int32
httpServer
If true enable statistics HTTP server
*bool
logFile
File to log diagnostic output
string
logLevel
Diagnostic level (error/warning/info/debug/trace)
string
parsersFile
Optional 'parsers' config file (can be multiple)
string
Back to TOC