Skip to content

Commit 65148d9

Browse files
authored
Updates to all of the Fluent Bit configuration output and added supervisor mode entry matching verison 4.1. Fixes #2082. (#2129)
Signed-off-by: Eric D. Schabell <[email protected]>
1 parent c824e47 commit 65148d9

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

administration/configuring-fluent-bit.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Fluent Bit supports two configuration formats:
1010
Fluent Bit exposes most of it features through the command line interface. Running the `-h` option you can get a list of the options available:
1111

1212
```shell
13+
# Podman container tooling.
14+
podman run -rm -ti fluent/fluent-bit --help
15+
16+
# Docker container tooling.
1317
docker run --rm -it fluent/fluent-bit --help
1418
```
1519

@@ -22,6 +26,7 @@ Available Options
2226
-b --storage_path=PATH specify a storage buffering path
2327
-c --config=FILE specify an optional configuration file
2428
-d, --daemon run Fluent Bit in background mode
29+
--supervisor run under a supervising parent process, uses "fork()" to execute child processes
2530
-D, --dry-run dry run
2631
-f, --flush=SECONDS flush timeout in seconds (default: 1)
2732
-C, --custom=CUSTOM enable a custom plugin
@@ -36,16 +41,24 @@ Available Options
3641
-t, --tag=TAG set plugin tag, same as '-p tag=abc'
3742
-T, --sp-task=SQL define a stream processor task
3843
-v, --verbose increase logging verbosity (default: info)
44+
-Z, --enable-chunk-traceenable chunk tracing, it can be activated either through the http api or the command line
45+
--trace-input input to start tracing on startup.
46+
--trace-output output to use for tracing on startup.
47+
--trace-output-property set a property for output tracing on startup.
48+
--trace setup a trace pipeline on startup. Uses a single line, ie: "input=dummy.0 output=stdout output.format='json'"
3949
-w, --workdir set the working directory
4050
-H, --http enable monitoring HTTP server
4151
-P, --port set HTTP server TCP port (default: 2020)
4252
-s, --coro_stack_size set coroutines stack size in bytes (default: 24576)
4353
-q, --quiet quiet mode
4454
-S, --sosreport support report for Enterprise customers
55+
-Y, --enable-hot-reload enable for hot reloading
56+
-W, --disable-thread-safety-on-hot-reloadingdisable thread safety on hot reloading
4557
-V, --version show version number
4658
-h, --help print this help
4759
4860
Inputs
61+
blob Blob (binary) files
4962
cpu CPU Usage
5063
mem Memory Usage
5164
thermal Thermal
@@ -56,32 +69,53 @@ Inputs
5669
netif Network Interface Usage
5770
docker Docker containers metrics
5871
docker_events Docker events
72+
podman_metrics Podman metrics
73+
process_exporter_metricsProcess Exporter Metrics (Prometheus Compatible)
74+
gpu_metrics GPU Metrics
5975
node_exporter_metrics Node Exporter Metrics (Prometheus Compatible)
76+
kubernetes_events Kubernetes Events
77+
kafka Kafka consumer input plugin
6078
fluentbit_metrics Fluent Bit internal metrics
6179
prometheus_scrape Scrape metrics from Prometheus Endpoint
80+
prometheus_textfile Read Prometheus metrics from text files
6281
tail Tail files
6382
dummy Generate dummy data
64-
dummy_thread Generate dummy data in a separate thread
6583
head Head Input
6684
health Check TCP server health
6785
http HTTP
6886
collectd collectd input plugin
6987
statsd StatsD input plugin
7088
opentelemetry OpenTelemetry
89+
elasticsearch HTTP Endpoints for Elasticsearch (Bulk API)
90+
splunk Input plugin for Splunk HEC payloads
91+
prometheus_remote_write Prometheus Remote Write input
92+
event_type Event tests for input plugins
7193
nginx_metrics Nginx status metrics
7294
serial Serial input
7395
stdin Standard Input
7496
syslog Syslog
97+
udp UDP
98+
exec_wasi Exec WASI Input
7599
tcp TCP
76100
mqtt MQTT, listen for Publish messages
77101
forward Fluentd in-forward
78102
random Random
79103
104+
Processors
105+
content_modifier Modify the content of Logs, Metrics and Traces
106+
labels Modifies metrics labels
107+
metrics_selector select metrics by specified name
108+
opentelemetry_envelope Package log records inside an OpenTelemetry Logs schema
109+
sampling Sampling
110+
sql SQL processor
111+
80112
Filters
81113
alter_size Alter incoming chunk size
82114
aws Add AWS Metadata
83115
checklist Check records and flag them
116+
ecs Add AWS ECS Metadata
84117
record_modifier modify record
118+
sysinfo Filter for system info
85119
throttle Throttle messages using sliding window algorithm
86120
type_converter Data type converter
87121
kubernetes Filter to append Kubernetes metadata
@@ -92,14 +126,17 @@ Filters
92126
expect Validate expected keys and values
93127
grep grep events by specified field values
94128
rewrite_tag Rewrite records tags
129+
log_to_metrics generate log derived metrics
95130
lua Lua Scripting Filter
96131
stdout Filter events to STDOUT
97132
geoip2 add geoip information to records
98133
nightfall scans records for sensitive content
134+
wasm WASM program filter
99135
100136
Outputs
101137
azure Send events to Azure HTTP Event Collector
102138
azure_blob Azure Blob Storage
139+
azure_logs_ingestion Send logs to Log Analytics with Log Ingestion API
103140
azure_kusto Send events to Kusto (Azure Data Explorer)
104141
bigquery Send events to BigQuery via streaming insert
105142
counter Records counter
@@ -118,6 +155,7 @@ Outputs
118155
nrlogs New Relic
119156
null Throws away events
120157
opensearch OpenSearch
158+
oracle_log_analytics Oracle log analytics
121159
plot Generate data file for GNU Plot
122160
pgsql PostgreSQL
123161
skywalking Send logs into log collector on SkyWalking OAP
@@ -127,6 +165,7 @@ Outputs
127165
stdout Prints events to STDOUT
128166
syslog Syslog
129167
tcp TCP Output
168+
udp UDP Output
130169
td Treasure Data
131170
flowcounter FlowCounter
132171
gelf GELF Output
@@ -138,4 +177,6 @@ Outputs
138177
prometheus_exporter Prometheus Exporter
139178
prometheus_remote_write Prometheus remote write
140179
s3 Send to S3
180+
vivo_exporter Vivo Exporter
181+
chronicle Send logs to Google Chronicle as unstructured log
141182
```

0 commit comments

Comments
 (0)