このページは、まだ日本語ではご利用いただけません。翻訳中です。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
StatsD Advancedプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
, ws
, wss
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
string required
プラグイン名。この場合は
statsd-advanced
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
string
プラグインのインスタンスを識別するための任意のカスタム名 (例:
statsd-advanced_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 default:
localhost
A string representing a host name, such as example.com.
-
integer default:
8125
between:0
65535
An integer representing a port number between 0 and 65535, inclusive.
-
string default:
kong
String to prefix to each metric’s name.
-
array of type
record
default:{"stat_type"=>"counter", "sample_rate"=>1, "name"=>"request_count"}, {"stat_type"=>"timer", "name"=>"latency"}, {"stat_type"=>"timer", "name"=>"request_size"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count"}, {"stat_type"=>"timer", "name"=>"response_size"}, {"stat_type"=>"set", "name"=>"unique_users"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"request_per_user"}, {"stat_type"=>"timer", "name"=>"upstream_latency"}, {"stat_type"=>"timer", "name"=>"kong_latency"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count_per_user"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count_per_workspace"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"status_count_per_user_per_route"}, {"stat_type"=>"gauge", "sample_rate"=>1, "name"=>"shdict_usage"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"cache_datastore_hits_total"}, {"stat_type"=>"counter", "sample_rate"=>1, "name"=>"cache_datastore_misses_total"}
List of Metrics to be logged.
-
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.
-
string required default:
custom_id
Must be one of:consumer_id
,custom_id
,username
The default consumer identifier for metrics. This will take effect when a metric’s consumer identifier is omitted. Allowed values are
custom_id
,consumer_id
,username
.
-
string required default:
service_name_or_host
Must be one of:service_id
,service_name
,service_host
,service_name_or_host
The default service identifier for metrics. This will take effect when a metric’s service identifier is omitted. Allowed values are
service_name_or_host
,service_id
,service_name
,service_host
.
-
string required default:
workspace_id
Must be one of:workspace_id
,workspace_name
The default workspace identifier for metrics. This will take effect when a metric’s workspace identifier is omitted. Allowed values are
workspace_id
,workspace_name
.
-
record required
-
integer default:
1
between:1
1000000
Maximum number of entries that can be processed at a time.
-
number default:
1
between:0
3600
Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
-
integer default:
10000
between:1
1000000
Maximum number of entries that can be waiting on the queue.
-
integer
Maximum number of bytes that can be waiting on a queue, requires string content.
-
number default:
60
Time in seconds before the queue gives up calling a failed handler for a batch.
-
number default:
0.01
between:0.001
1000000
Time in seconds before the initial retry is made for a failing batch.
-
number default:
60
between:0.001
1000000
Maximum time in seconds between retries, caps exponential backoff.
-
integer default:
1
Must be one of:-1
,1
The number of of queue delivery timers. -1 indicates unlimited.
-
-