HTTP Log Configuration

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

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

構成

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

互換性のあるプロトコル

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

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

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は http-log 。

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

• instance_name

  string

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

    string required referenceable encrypted

    The HTTP URL endpoint (including the protocol to use) to which the data is sent.

    If the http_endpoint contains a username and password (for example, http://bob:password@example.com/logs), then Kong Gateway automatically includes a basic-auth Authorization header in the log requests.

  • method

    string default: POST Must be one of: POST, PUT, PATCH

    An optional method used to send data to the HTTP server. Supported values are POST (default), PUT, and PATCH.

  • content_type

    string default: application/json Must be one of: application/json

    Indicates the type of data sent. The only available option is application/json.

  • timeout

    number default: 10000

    An optional timeout in milliseconds when sending data to the upstream server.

  • keepalive

    number default: 60000

    An optional value in milliseconds that defines how long an idle connection will live before being closed.

  • retry_count

    integer default: 10

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

  • queue_size

    integer default: 1

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

  • flush_timeout

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

  • headers

    map

    An optional table of headers included in the HTTP message to the upstream server. Values are indexed by header name, and each header name accepts a single string.

    The following headers are not allowed: Host, Content-Length, Content-Type.

    Note: Before version 3.0.0, the values were arrays of strings (multiple values per header name).

  • custom_fields_by_lua

    map

    A list of key-value pairs, where the key is the name of a log field and the value is a chunk of Lua code, whose return value sets or replaces the log field value.