StatsD Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

StatsDプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は statsd 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: statsd_my-service 。

  インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。

  インスタンス名は、次のコンテキスト内で一意である必要があります。

  • Kong Gateway Enterpriseのワークスペース内
  • Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
  • Kong Gateway (OSS)の全世界

• 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 type record default: {"name"=>"request_count", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"latency", "stat_type"=>"timer"}, {"name"=>"request_size", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"status_count", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"response_size", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"unique_users", "stat_type"=>"set"}, {"name"=>"request_per_user", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"upstream_latency", "stat_type"=>"timer"}, {"name"=>"kong_latency", "stat_type"=>"timer"}, {"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"=>"counter", "sample_rate"=>1}, {"name"=>"shdict_usage", "stat_type"=>"gauge", "sample_rate"=>1}, {"name"=>"cache_datastore_hits_total", "stat_type"=>"counter", "sample_rate"=>1}, {"name"=>"cache_datastore_misses_total", "stat_type"=>"counter", "sample_rate"=>1}

    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, status_count_per_workspace, status_count_per_user_per_route, shdict_usage, cache_datastore_hits_total, cache_datastore_misses_total

    • 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

    • service_identifier

      string Must be one of: service_id, service_name, service_host, service_name_or_host

    • workspace_identifier

      string Must be one of: workspace_id, workspace_name

  • allow_status_codes

    array of type string

    List of status code ranges that are allowed to be logged in metrics.

  • udp_packet_size

    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).

  • use_tcp

    boolean default: false

    Use TCP instead of UDP.

  • hostname_in_prefix

    boolean default: false

    Include the hostname in the prefix for each metric name.

  • consumer_identifier_default

    string required default: custom_id Must be one of: consumer_id, custom_id, username

    The default consumer identifier of metrics. This takes effect when a metric’s consumer identifier is omitted. Allowed values are custom_id, consumer_id, username.

  • service_identifier_default

    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 of metrics. This takes effect when a metric’s service identifier is omitted. Allowed values are service_name_or_host, service_id, service_name, service_host.

  • workspace_identifier_default

    string required default: workspace_id Must be one of: workspace_id, workspace_name

    The default workspace identifier of metrics. This will take effect when a metric’s workspace identifier is omitted. Allowed values are workspace_id, workspace_name.

  • retry_count

    integer required default: 10

    Number of times to retry when sending data to the upstream server.

  • queue_size

    integer required default: 1

    Maximum number of log entries to be sent on each message to the upstream server.

  • flush_timeout

    number required default: 2

    Optional time in seconds. If queue_size > 1, this is the max idle time before sending a log with less than queue_size records.

  • tag_style

    string Must be one of: dogstatsd, influxdb, librato, signalfx

    The tag style configurations to send metrics with tags. Defaults to nil, which doesn’t add any tags to the metrics. Allowed values are dogstatsd, influxdb, librato, and signalfx.