fluentdのプラグインの各パラメータの説明

Fluentd v0.12.16でプラグインの設定をコマンドラインから確認する方法

クリアコードさんのブログで既に書かれてますが，fluentdはv0.12.16から，プラグインの各パラメータを定義するconfig_paramに説明が付与できるようになってます．今だと二つ付与する方法があります．以下はout_stdoutのoutput_typeの例です．

• :descオプション

config_param :output_type, :default => 'json', :desc => 'Output format.(json,hash)'

• descメソッド (v0.12.17から)

desc 'Output format.(json,hash)'
config_param :output_type, :default => 'json'

結果:

% fluentd --show-plugin-config=output:stdout
2015-12-14 17:59:58 +0900 [info]: Show config for output:stdout
2015-12-14 17:59:58 +0900 [info]: 
log_level: string: <nil> # Allows the user to set different levels of logging for each plugin.
output_type: : <"json"> # Output format.(json,hash)

:descオプションの方はv0.12.16以前でも単に無視されるだけなので，様々なバージョンを考慮するのであれば，こちらの方が良いです．

built-inのプラグインはクリアコードの方々にたくさんパッチを送ってもらい，これらの対応をしました．いずれfluentd-uiでこの機能を利用して自動で設定画面を生成する仕組みを実装しようかなと考えているので，もし時間がある方は，是非:descを付与してもらえると助かります！