Prometheus設定

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

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

構成

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

The database will always be reported as reachable in Prometheus with DB-less. Additionally, the DB entity count metric (kong_db_entities_total) is not emitted in DB-less mode.

互換性のあるプロトコル

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

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

パラメータ

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

• name or plugin

  string required

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

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: prometheus_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
  • per_consumer

    boolean default: false

    A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.

  • status_code_metrics

    boolean default: false

    A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.

  • ai_metrics

    boolean default: false

    A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.

  • latency_metrics

    boolean default: false

    A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.

  • bandwidth_metrics

    boolean default: false

    A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.

  • upstream_health_metrics

    boolean default: false

    A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.