AppSentinels Configuration

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

構成

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

互換性のあるプロトコル

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

http, https

パラメータ

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

• name or plugin

  string required

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

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: appsentinels_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を使用する場合は必要ありません。

• consumer_group.name or consumer_group.id

  string

  プラグインが対象とするコンシューマグループの名前または ID。 設定されている場合、プラグインは指定されたグループが認証されているリクエストに対してのみアクティブになります/plugins エンドポイント. /consumer_groups/{consumerGroupName|Id}/pluginsを使用する場合は必要ありません。

• enabled

  boolean default: true

  このプラグインが適用されるかどうか。

• config

  record
  • http_endpoint

    string required

    URL of AppSentinels edge controller

  • method

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

    Method for HTTP logging request to AppSentinels edge controllr

  • content_type

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

    Content-Type for HTTP logging request to AppSentinels edge controllr

  • timeout

    number default: 100

    Authz request timeout

  • log_timeout

    number default: 150

    Logging request timeout for response and transparent mode

  • connect_timeout

    number default: 1000

    HTTP Connect timeout to AppSentinels edge controller

  • stats_timeout

    number default: 5

    Stats message frequency in seconds to AppSentinels edge controller

  • keepalive

    number default: 60000

    HTTP Keepalive timeout for connections to AppSentinels edge controller

  • retry_count

    integer default: 0

    Number of retries for HTTP logging request in case of failure

  • queue_size

    integer default: 5

    Number of entries in the batched queue

  • queue_num

    integer default: 5

    Number of batched queues

  • queue_max_entries

    integer default: 10000

    Maximum number of entries in the batched queue

  • flush_timeout

    number default: 1

    Flush timeout for batched queue in seconds

  • no_self_signed

    boolean default: false

    Enable server (AppSentinels edge controller) cert verification

  • authz

    boolean default: false

    Enable authz/enforcement mode

  • authz_fail_allow

    boolean default: true

    Enable authz fail open for authz/enforcement mode

  • authz_fail_msg

    string default: Unauthorized by Appsentinels

    Custom authz fail message sent to client in authz/enforcement mode

  • path_requestlog

    string default: /auth

    Set request log path in authz/enforcement mode

  • path_responselog

    string default: /nginxlog

    Set response log path in authz/enforcement mode

  • path_mergedlog

    string default: /mergedlog

    Set merged log path in transparent mode

  • path_stats

    string default: /nginxstats

    Set stats request path

  • compress_logs

    boolean default: true

    Enable gzip compression for logs

  • unhealthy_threshold

    integer default: 3

    Number of failures to consider before declaring connection to AppSentinels edge controller as unhealthy

  • shaper_type

    string default: linear

    Shaping algorithm to use

  • shaper_max_stages

    number default: 180

    Maximum number of stages in shaper algorithm

  • shaper_base

    number default: 3

    Base for shaper steps, in number of logs

  • shaper_multiplier

    number default: 1

    Multiplier for shaper steps

  • shaper_step_duration

    number default: 1000

    Duration of each shaper step in milliseconds

  • shaper_fallback_rate

    number default: 1.25

    Shaper fallback rate in case of failures

  • shaper_idle_timeout

    number default: 60000

    Shaper idle timeout in milliseconds

  • console_error_supp_rate

    number default: 10

    Console error logging suppression rate

  • normalize_factor

    number default: 0

    Normalize factor for shaper

  • max_payload

    number default: 131072

    Maximum payload size in bytes, beyond which payload wont be logged

  • early_payload_threshold

    number default: 32768

    Payloads greater then this will be logged during access phase without holding in the memory

  • content_regex

    string default: (json|form|xml|graphql)

    Regular expression to match content type for logging

  • force_read_client_payload

    boolean default: false

    Force read client payload to determine the size if content length isnt available in request headers

  • instance_name

    string default: NA

    Configure to identify Kong deployment instances

  • stats_send_timeout

    number default: 4000

    Stats send timeout in milliseconds

  • trace

    boolean default: false

    Enable plugin logging on console