このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
Syslogプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
, ws
, wss
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
string required
プラグイン名。この場合は
syslog
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
string
プラグインのインスタンスを識別するための任意のカスタム名 (例:
syslog_my-service
。インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。
インスタンス名は、次のコンテキスト内で一意である必要があります。
- Kong Gateway Enterpriseのワークスペース内
- Konnectのコントロールプレーン(CP)またはコントロールプレーン(CP)グループ内
- Kong Gateway (OSS)の全世界
-
string
プラグインが対象とするサービス名または ID。最上位の
/plugins
エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください/services/{serviceName|Id}/plugins
を使用する場合は必要ありません。 -
string
プラグインがターゲットとするルート名または ID。最上位の
/plugins
エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください/routes/{routeName|Id}/plugins
を使用する場合は必要ありません。 -
string
プラグインがターゲットとするコンシューマーの名前または ID。 最上位の
/plugins
エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください/consumers/{consumerName|Id}/plugins
を使用する場合は必要ありません。 -
boolean default:
true
このプラグインが適用されるかどうか。
-
record required
-
string required default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity. Any request with equal or higher severity will be logged to System log. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
string required default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity assigned to all the successful requests with a response status code less then 400. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
string required default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity assigned to all the failed requests with a response status code 400 or higher but less than 500. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
string required default:
info
Must be one of:debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
An optional logging severity assigned to all the failed requests with a response status code 500 or higher. Available options:
debug
,info
,notice
,warning
,err
,crit
,alert
,emerg
.
-
map
A list of key-value pairs, where the key is the name of a log field and the value is a chunk of Lua code, whose return value sets or replaces the log field value.
-
string required default:
user
Must be one of:auth
,authpriv
,cron
,daemon
,ftp
,kern
,lpr
,mail
,news
,syslog
,user
,uucp
,local0
,local1
,local2
,local3
,local4
,local5
,local6
,local7
The facility is used by the operating system to decide how to handle each log message. This optional argument defines what must be the facility set by the plugin when logging. Available options:
auth
,authpriv
,cron
,daemon
,ftp
,kern
,lpr
,mail
,news
,syslog
,user
,uucp
,local0
,local1
,local2
,local3
,local4
,local5
,local6
,local7
.
-