Kafka Upstream Configuration

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

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は kafka-upstream 。

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

• instance_name

  string

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

    set of type record

    Set of bootstrap brokers in a {host: host, port: port} list format.

    • host

      string required

    • port

      integer required between: 0 65535

  • topic

    string required

    The Kafka topic to publish to.

  • timeout

    integer default: 10000

    Socket timeout in milliseconds.

  • keepalive

    integer default: 60000

    Keepalive timeout in milliseconds.

  • keepalive_enabled

    boolean default: false

  • authentication

    record required
    • strategy

      string Must be one of: sasl

      The authentication strategy for the plugin, the only option for the value is sasl.

    • mechanism

      string Must be one of: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512

      The SASL authentication mechanism.

      Supported options: PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.

    • tokenauth

      boolean

      Enable this to indicate DelegationToken authentication.

    • user

      string referenceable encrypted

      Username for SASL authentication.

    • password

      string referenceable encrypted

      Password for SASL authentication.

  • security

    record required
    • certificate_id

      string

      UUID of certificate entity for mTLS authentication.

    • ssl

      boolean

      Enables TLS.

  • forward_method

    boolean default: false

    Include the request method in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

  • forward_uri

    boolean default: false

    Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

  • forward_headers

    boolean default: false

    Include the request headers in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

  • forward_body

    boolean default: true

    Include the request body in the message. At least one of these must be true: forward_method, forward_uri, forward_headers, forward_body.

  • cluster_name

    string

    An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier.

    If more than one Kafka plugin is configured without a cluster_name (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.

  • producer_request_acks

    integer default: 1 Must be one of: -1, 0, 1

    The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).

  • producer_request_timeout

    integer default: 2000

    Time to wait for a Produce response in milliseconds.

  • producer_request_limits_messages_per_request

    integer default: 200

    Maximum number of messages to include into a single Produce request.

  • producer_request_limits_bytes_per_request

    integer default: 1048576

    Maximum size of a Produce request in bytes.

  • producer_request_retries_max_attempts

    integer default: 10

    Maximum number of retry attempts per single Produce request.

  • producer_request_retries_backoff_timeout

    integer default: 100

    Backoff interval between retry attempts in milliseconds.

  • producer_async

    boolean default: true

    Flag to enable asynchronous mode.

  • producer_async_flush_timeout

    integer default: 1000

    Maximum time interval in milliseconds between buffer flushes in asynchronous mode.

  • producer_async_buffering_limits_messages_in_memory

    integer default: 50000

    Maximum number of messages that can be buffered in memory in asynchronous mode.