Amberflo.io API Metering設定

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

構成

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

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

互換性のあるプロトコル

Amberflo.io API Meteringプラグインは以下のプロトコルに対応しています：

http, https

パラメータ

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

• name or plugin

  string required

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

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

• instance_name

  string

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

• enabled

  boolean default: true

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

• config

  record required
  • apiKey

    string required

    Your Amberflo API key.

  • meterApiName

    string required

    The meter for metering the requests.

  • customerHeader

    string required

    The header to get the Amberflo customerId from.

  • intervalSeconds

    number default: 1

    The rate (in seconds) at which to send the meter record batch.

  • batchSize

    number default: 10

    The size at which to send the meter record batch.

  • methodDimension

    string

    The dimension name for the request method.

  • hostDimension

    string

    The dimension name for the target URL host.

  • routeDimension

    string

    The dimension name for the route name.

  • serviceDimension

    string

    The dimension name for the service name.

  • dimensionHeaders

    map

    The map of “dimension name” to “header name”, for inclusion in the meter record.

  • replacements

    map default: { "/": ":" }

    The map of “old” to “new” values for transforming dimension values.