このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
Datadogプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
, tcp
, tls
, tls_passthrough
, udp
, ws
, wss
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
datadog
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
instance_name
stringプラグインのインスタンスを識別するための任意のカスタム名 (例:
datadog_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 referenceable default:localhost
A string representing a host name, such as example.com.
-
port
integer default:8125
between:0
65535
An integer representing a port number between 0 and 65535, inclusive.
-
prefix
string default:kong
String to be attached as a prefix to a metric’s name.
-
service_name_tag
string default:name
String to be attached as the name of the service.
-
status_tag
string default:status
String to be attached as the tag of the HTTP status.
-
consumer_tag
string default:consumer
String to be attached as tag of the consumer.
-
retry_count
integerNumber of times to retry when sending data to the upstream server.
-
queue_size
integerMaximum number of log entries to be sent on each message to the upstream server.
-
flush_timeout
numberOptional time in seconds. If
queue_size
> 1, this is the max idle time before sending a log with less thanqueue_size
records.
-
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
integerMaximum 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.
-
-
metrics
array of typerecord
required default:{"stat_type"=>"counter", "consumer_identifier"=>"custom_id", "tags"=>["app:kong"], "name"=>"request_count", "sample_rate"=>1}, {"stat_type"=>"timer", "name"=>"latency", "consumer_identifier"=>"custom_id", "tags"=>["app:kong"]}, {"stat_type"=>"timer", "name"=>"request_size", "consumer_identifier"=>"custom_id", "tags"=>["app:kong"]}, {"stat_type"=>"timer", "name"=>"response_size", "consumer_identifier"=>"custom_id", "tags"=>["app:kong"]}, {"stat_type"=>"timer", "name"=>"upstream_latency", "consumer_identifier"=>"custom_id", "tags"=>["app:kong"]}, {"stat_type"=>"timer", "name"=>"kong_latency", "consumer_identifier"=>"custom_id", "tags"=>["app:kong"]}
List of metrics to be logged.
-
name
string required Must be one of:kong_latency
,latency
,request_count
,request_size
,response_size
,upstream_latency
Datadog metric’s name
-
stat_type
string required Must be one of:counter
,gauge
,histogram
,meter
,set
,timer
,distribution
Determines what sort of event the metric represents
-
tags
array of typestring
List of tags
-
sample_rate
number between:0
1
Sampling rate
-
consumer_identifier
string Must be one of:consumer_id
,custom_id
,username
Authenticated user detail
-
-