このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
StatsDプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
statsd
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
service.name or service.id
stringプラグインが対象とするサービス名または ID。最上位の
/plugins
エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください/services/{serviceName|Id}/plugins
を使用する場合は必要ありません。 -
route.name or route.id
stringプラグインがターゲットとするルート名または ID。最上位の
/plugins
エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください/routes/{routeName|Id}/plugins
を使用する場合は必要ありません。 -
consumer.name or consumer.id
stringプラグインがターゲットとするコンシューマーの名前または ID。 最上位の
/plugins
エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください/consumers/{consumerName|Id}/plugins
を使用する場合は必要ありません。 -
enabled
boolean default:true
このプラグインが適用されるかどうか。
-
config
record required-
host
string default:localhost
The IP address or hostname of StatsD server to send data to.
-
port
integer default:8125
between:0
65535
The port of StatsD server to send data to.
-
prefix
string default:kong
String to prefix to each metric’s name.
-
metrics
array of typerecord
default:{"sample_rate"=>1, "stat_type"=>"counter", "name"=>"request_count"}, {"stat_type"=>"timer", "name"=>"latency"}, {"stat_type"=>"timer", "name"=>"request_size"}, {"sample_rate"=>1, "stat_type"=>"counter", "name"=>"status_count"}, {"stat_type"=>"timer", "name"=>"response_size"}, {"consumer_identifier"=>"custom_id", "stat_type"=>"set", "name"=>"unique_users"}, {"sample_rate"=>1, "name"=>"request_per_user", "stat_type"=>"counter", "consumer_identifier"=>"custom_id"}, {"stat_type"=>"timer", "name"=>"upstream_latency"}, {"stat_type"=>"timer", "name"=>"kong_latency"}, {"sample_rate"=>1, "name"=>"status_count_per_user", "stat_type"=>"counter", "consumer_identifier"=>"custom_id"}
List of metrics to be logged. Available values are described under Metrics.
-
name
string required Must be one of:kong_latency
,latency
,request_count
,request_per_user
,request_size
,response_size
,status_count
,status_count_per_user
,unique_users
,upstream_latency
-
stat_type
string required Must be one of:counter
,gauge
,histogram
,meter
,set
,timer
-
sample_rate
number
-
consumer_identifier
string Must be one of:consumer_id
,custom_id
,username
-
-