StatsD設定

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

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

構成

このプラグインは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: {"stat_type"=>"counter", "name"=>"request_count", "sample_rate"=>1}, {"name"=>"latency", "stat_type"=>"timer"}, {"stat_type"=>"counter", "name"=>"request_size", "sample_rate"=>1}, {"stat_type"=>"counter", "name"=>"status_count", "sample_rate"=>1}, {"stat_type"=>"counter", "name"=>"response_size", "sample_rate"=>1}, {"stat_type"=>"set", "name"=>"unique_users"}, {"stat_type"=>"counter", "name"=>"request_per_user", "sample_rate"=>1}, {"name"=>"upstream_latency", "stat_type"=>"timer"}, {"name"=>"kong_latency", "stat_type"=>"timer"}, {"stat_type"=>"counter", "name"=>"status_count_per_user", "sample_rate"=>1}, {"stat_type"=>"counter", "name"=>"status_count_per_workspace", "sample_rate"=>1}, {"stat_type"=>"counter", "name"=>"status_count_per_user_per_route", "sample_rate"=>1}, {"stat_type"=>"gauge", "name"=>"shdict_usage", "sample_rate"=>1}, {"stat_type"=>"counter", "name"=>"cache_datastore_hits_total", "sample_rate"=>1}, {"stat_type"=>"counter", "name"=>"cache_datastore_misses_total", "sample_rate"=>1}

    List of metrics to be logged.

    • 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

      StatsD metric’s name.

    • stat_type

      string required Must be one of: counter, gauge, histogram, meter, set, timer

      Determines what sort of event a metric represents.

    • sample_rate

      number

      Sampling rate

    • consumer_identifier

      string Must be one of: consumer_id, custom_id, username

      Authenticated user detail.

    • service_identifier

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

      Service detail.

    • workspace_identifier

      string Must be one of: workspace_id, workspace_name

      Workspace detail.

  • 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

  • use_tcp

    boolean default: false

  • hostname_in_prefix

    boolean default: false

  • consumer_identifier_default

    string required default: custom_id Must be one of: consumer_id, custom_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

  • workspace_identifier_default

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

  • retry_count

    integer default: 10
    Deprecation notice: statsd: config.retry_count no longer works, please use config.queue.max_retry_time instead. This field is planned to be removed in version 4.0.

  • queue_size

    integer default: 1
    Deprecation notice: statsd: config.queue_size is deprecated, please use config.queue.max_batch_size instead. This field is planned to be removed in version 4.0.

  • flush_timeout

    number default: 2
    Deprecation notice: statsd: config.flush_timeout is deprecated, please use config.queue.max_coalescing_delay instead. This field is planned to be removed in version 4.0.

  • tag_style

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

  • queue

    record required
    • max_batch_size

      integer default: 1 between: 1 1000000

      Maximum number of entries that can be processed at a time.

    • max_coalescing_delay

      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.

    • max_entries

      integer default: 10000 between: 1 1000000

      Maximum number of entries that can be waiting on the queue.

    • max_bytes

      integer

      Maximum number of bytes that can be waiting on a queue, requires string content.

    • max_retry_time

      number default: 60

      Time in seconds before the queue gives up calling a failed handler for a batch.

    • initial_retry_delay

      number default: 0.01 between: 0.001 1000000

      Time in seconds before the initial retry is made for a failing batch.

    • max_retry_delay

      number default: 60 between: 0.001 1000000

      Maximum time in seconds between retries, caps exponential backoff.