plugin.config

警告

Use plugin.yaml instead. The plugin.config format is maintained for backward compatibility but plugin.yaml is the recommended way to configure global plugins. It supports disabling plugins without deleting lines, explicit load ordering, and inline configuration.

If plugin.yaml exists in the configuration directory, Traffic Server will load plugins from it and ignore plugin.config entirely.

See plugin.yaml for the full reference.

Migrating: use traffic_ctl to convert an existing file automatically:

# Preview the converted output on stdout
traffic_ctl config convert plugin_config plugin.config -

# Write directly to plugin.yaml
traffic_ctl config convert plugin_config plugin.config plugin.yaml

Commented-out lines in plugin.config are converted to enabled: false entries. Pass --skip-disabled to drop them instead.

解説

plugin.config ファイルは Traffic Server で利用可能な実行時に読み込み可能なプラグインの制御をその設定と同様に行います。このファイルに記載されたプラグインの一覧は、常に読み込まれ大域的に影響を持っているので グローバルプラグイン として参照されます。これはその影響が適用された特定のマッピングルールに制限されている remap.config に指定されたプラグインとは対照的です。

設定の各行は .so ファイルへのパスで構成されます。このパスは絶対パスにもプラグインディレクトリ ( 通常は /usr/local/libexec/trafficserver) に対する相対パスにもできます。プラグインの読み込み失敗は致命的で、 Traffic Server の中断を引き起こします。一般に、プラグインはキャッシュと認証ポリシーについて恣意的な効果を持っているので、特定のプラグイン無しで動作することがサービスの提供において安全かどうか知ることはできません。

重要

プラグインは一度のみ記載されるべきです。プラグインが記載される順番はリクエスト処理のためにプラグインがチェーンされる順番となります。

An option list of whitespace-separated arguments may follow the plugin name. These are passed as an argument vector to the plugin's initialization function, TSPluginInit(). Arguments that begin with the $ character designate Traffic Server configuration variables. These arguments will be replaced with the value of the corresponding configuration variable before the plugin is loaded. When using configuration variable expansion, note that most Traffic Server configuration can be changed. If a plugin requires the current value, it must obtain that using the management API.

例

# Comments start with a '#' and continue to the end of the line
# Blank lines are ignored
#
# test-plugin.so arg1 arg2 arg3
#
plugins/iwx/iwx.so
plugins/abuse/abuse.so etc/trafficserver/abuse.config
plugins/icx/icx.so etc/trafficserver/icx.config $proxy.config.http.connect_attempts_timeout

参照

plugin.yaml, TSAPI(3ts), TSPluginInit(3ts), remap.config(5)