このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
string required
プラグイン名。この場合は
statsd-advanced
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
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 default:
localhost
The IP address or hostname of the StatsD server.
-
integer default:
8125
between:0
65535
The port of the StatsD server.
-
string default:
kong
String to prefix to each metric’s name.
-
array of type
record
default:{"sample_rate"=>1, "name"=>"request_count", "stat_type"=>"counter", "service_identifier"=>"service_name_or_host"}, {"service_identifier"=>"service_name_or_host", "stat_type"=>"timer", "name"=>"latency"}, {"service_identifier"=>"service_name_or_host", "stat_type"=>"timer", "name"=>"request_size"}, {"sample_rate"=>1, "name"=>"status_count", "stat_type"=>"counter", "service_identifier"=>"service_name_or_host"}, {"service_identifier"=>"service_name_or_host", "stat_type"=>"timer", "name"=>"response_size"}, {"consumer_identifier"=>"custom_id", "name"=>"unique_users", "stat_type"=>"set", "service_identifier"=>"service_name_or_host"}, {"stat_type"=>"counter", "sample_rate"=>1, "service_identifier"=>"service_name_or_host", "name"=>"request_per_user", "consumer_identifier"=>"custom_id"}, {"service_identifier"=>"service_name_or_host", "stat_type"=>"timer", "name"=>"upstream_latency"}, {"service_identifier"=>"service_name_or_host", "stat_type"=>"timer", "name"=>"kong_latency"}, {"stat_type"=>"counter", "sample_rate"=>1, "service_identifier"=>"service_name_or_host", "name"=>"status_count_per_user", "consumer_identifier"=>"custom_id"}, {"sample_rate"=>1, "name"=>"status_count_per_workspace", "stat_type"=>"counter", "workspace_identifier"=>"workspace_id"}, {"stat_type"=>"counter", "sample_rate"=>1, "service_identifier"=>"service_name_or_host", "name"=>"status_count_per_user_per_route", "consumer_identifier"=>"custom_id"}, {"sample_rate"=>1, "name"=>"shdict_usage", "stat_type"=>"gauge", "service_identifier"=>"service_name_or_host"}, {"sample_rate"=>1, "stat_type"=>"counter", "name"=>"cache_datastore_hits_total"}, {"sample_rate"=>1, "stat_type"=>"counter", "name"=>"cache_datastore_misses_total"}
List of Metrics to be logged. Available values are described under Metrics.
-
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
,status_count_per_workspace
,status_count_per_user_per_route
,shdict_usage
,cache_datastore_hits_total
,cache_datastore_misses_total
-
string required Must be one of:
counter
,gauge
,histogram
,meter
,set
,timer
-
number
-
string Must be one of:
consumer_id
,custom_id
,username
-
string Must be one of:
service_id
,service_name
,service_host
,service_name_or_host
-
string Must be one of:
workspace_id
,workspace_name
-
-
array of type
string
List of status code ranges that are allowed to be logged in metrics.
-
number default:
0
between:0
65507
Combine UDP packet up to the size configured. If zero (0), don’t combine the UDP packet. Must be a number between 0 and 65507 (inclusive).
-
boolean default:
false
Use TCP instead of UDP.
-
boolean default:
false
Include the
hostname
in theprefix
for each metric name.
-