Moesif API Monetization and Analytics設定

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

構成

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

The plugin is compatible with any with DB-less mode including local, cluster, and redis

互換性のあるプロトコル

Moesif API Monetization and Analyticsプラグインは以下のプロトコルに対応しています：

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

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は kong-plugin-moesif 。

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

• instance_name

  string

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

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

• api_id

  string

  プラグインが対象とするAPIのID。
  
  注:API Entity は CE 0.13.0 と EE 0.32以降はサービスが優先され、非推奨になりました。

• config

  record required
  • application_id

    string required

    Your Moesif Application Id from your Moesif dashboard. Go to Bottom Left Menu -> Installation.

  • api_endpoint

    string default: https://api.moesif.net

    URL for the Moesif Collection API (Change to your secure proxy hostname if client-side encryption is used).

  • connect_timeout

    number default: 1000

    Timeout in milliseconds when connecting to Moesif.

  • send_timeout

    number default: 2000

    Timeout in milliseconds when sending data to Moesif.

  • timeout

    number default: 1000

    (Deprecated) timeout in milliseconds when connecting/sending to Moesif.

  • keepalive

    number default: 5000

    Value in milliseconds that defines for how long an idle connection will live before being closed.

  • api_version

    string default: 1.0

    API Version you want to tag this request with in Moesif.

  • disable_capture_request_body

    boolean default: false

    Disable logging of request body.

  • disable_capture_response_body

    boolean default: false

    Disable logging of response body.

  • request_header_masks

    map default: {}

    An array of request header fields to mask.

  • request_query_masks

    map default: {}

    An array of query string parameter fields to mask.

  • request_body_masks

    map default: {}

    An array of request body fields to mask.

  • response_header_masks

    map default: {}

    An array of response header fields to mask.

  • response_body_masks

    map default: {}

    An array of response body fields to mask.

  • batch_size

    number default: 200

    Maximum batch size when sending to Moesif.

  • user_id_header

    string default: X-Consumer-Custom-Id

    Request or response header used to identify the User in Moesif. See identifying users.

  • company_id_header

    string

    Request or response header used to identify the Company (Account) in Moesif. See identifying companies.

  • authorization_header_name

    string default: authorization

    Request header containing a Bearer or basic token to extract user id. See identifying users. Also, supports a comma-separated string. The plugin will check headers in order “X-Api-Key, Authorization”. See identifying users.

  • authorization_user_id_field

    string default: sub

    Field name in JWT/OpenId token’s payload for identifying users. Only applicable if authorization_header_name is set and is a Bearer token. See identifying users.

  • authorization_company_id_field

    string

    Field name in JWT/OpenId token’s payload for identifying companies. Only applicable if authorization_header_name is set and is a Bearer token. See identifying companies.

  • event_queue_size

    number default: 1000

    Maximum number of events to hold in the queue before sending to Moesif. In case of network issues where the plugin is unable to connect or send an event to Moesif, skips adding new events to the queue to prevent memory overflow.

  • disable_gzip_payload_decompression

    boolean default: false

    If set to true, disables decompressing body in Kong.

  • disable_transaction_id

    boolean default: false

    Disable adding the X-Moesif-Transaction-Id response header for debugging.

  • max_callback_time_spent

    number default: 750

    Limits the amount of time in milliseconds to send events to Moesif per worker cycle.

  • request_max_body_size_limit

    number default: 100000

    Maximum request body size in bytes to log in Moesif.

  • response_max_body_size_limit

    number default: 100000

    Maximum response body size in bytes to log in Moesif.

  • debug

    boolean default: false

    An option if set to true, prints internal log messages for debugging integration issues.