コンテンツにスキップ
|
Plugin Hub
report-issue問題を報告する
header icon

Prometheus設定

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

構成

このプラグインは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

      コンシューマごとのメトリクスを収集するかどうかを決定するブール値。有効にすると、kong_http_requests_totalおよびkong_bandwidth_bytesメトリクスが、コンシューマラベルに入力されます（利用可能な場合）。

    • status_code_metrics

      boolean default: false

      ステータスコードのメトリクスを収集するかどうかを決定するブール値。有効にすると、http_requests_total、stream_sessions_totalメトリクスがエクスポートされます。

    • latency_metrics

      boolean default: false

      レイテンシのメトリクスを収集するかどうかを決定するブール値。有効にすると、kong_latency_ms、upstream_latency_ms、およびrequest_latency_msメトリクスがエクスポートされます。

    • bandwidth_metrics

      boolean default: false

      帯域幅メトリクスを収集するかどうかを決定するブール値。有効にすると、bandwidth_bytesとstream_sessions_totalメトリクスがエクスポートされます。

    • upstream_health_metrics

      boolean default: false

      アップストリームのメトリクスを収集するかどうかを決定するブール値。有効にすると、upstream_target_healthメトリクスがエクスポートされます。