Fluentd
Search…
Command Line Option
This article describes built-in commands and its options

fluentd

Invoke fluentd. Here is supported options:
1
Usage: fluentd [options]
2
-s, --setup [DIR=/etc/fluent] install sample configuration file to the directory`
3
-c, --config PATH config file path (default: /etc/fluent/fluent.conf)
4
--dry-run Check fluentd setup is correct or not
5
-p, --plugin DIR add plugin directory
6
-I PATH add library path
7
-r NAME load library
8
-d, --daemon PIDFILE daemonize fluent process
9
--no-supervisor run without fluent supervisor
10
--user USER change user
11
--group GROUP change group
12
-o, --log PATH log file path
13
-i CONFIG_STRING, inline config which is appended to the config file on-fly
14
--inline-config
15
--emit-error-log-interval SECONDS
16
suppress interval seconds of emit error logs
17
--suppress-repeated-stacktrace [VALUE]
18
suppress repeated stacktrace
19
--without-source invoke a fluentd without input plugins
20
--use-v1-config Use v1 configuration format (default)
21
--use-v0-config Use v0 configuration format
22
-v, --verbose increase verbose level (-v: debug, -vv: trace)
23
-q, --quiet decrease verbose level (-q: warn, -qq: error)
24
--suppress-config-dump suppress config dumping when fluentd starts
25
-g, --gemfile GEMFILE Gemfile path
26
-G, --gem-path GEM_INSTALL_PATH Gemfile install path (default: $(dirname $gemfile)/vendor/bundle)
Copied!

Important options

--suppress-config-dump

Fluentd starts without configuration dump. If you don't want to show configuration in fluentd logs, e.g. don't show private keys, this options is useful.

--suppress-repeated-stacktrace

If set true, suppress stacktrace in fluentd logs. Since v0.12, this option is true by default.

--without-source

Fluentd starts without input plugins. This option is useful for flushing buffers with no new incoming events.

-i, --inline-config

If you use fluentd on XaaS which doesn't support persistent disks, this option is useful.

--no-supervisor

If you want to use your supervisor tools, this option avoids double supervisor.

Set via configuration file

Several options could be set via <system> directive configuration file. See configuration file article.

fluent-cat

Send event to fluentd's in_forward/in_unix plugin. This is useful for testing.
1
Usage: fluent-cat [options] <tag>
2
-p, --port PORT fluent tcp port (default: 24224)
3
-h, --host HOST fluent host (default: 127.0.0.1)
4
-u, --unix use unix socket instead of tcp
5
-s, --socket PATH unix socket path (default: /var/run/fluent/fluent.sock)
6
-f, --format FORMAT input format (default: json)
7
--json same as: -f json
8
--msgpack same as: -f msgpack
9
--none same as: -f none
10
--message-key KEY key field for none format (default: message)
Copied!

example

Send json message with debug.log tag to local fluentd:
1
% echo '{"message":"hello"}' | fluent-cat debug.log
Copied!
Send to other machine:
1
% echo '{"message":"hello"}' | fluent-cat debug.log --host testserver --port 24225
Copied!
If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is a open source project under Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.
Last modified 2yr ago