30.4. レポートの設定

3scale システムで追跡するメトリクスの名前を設定したら、適切なメトリクスを報告するようにプラグインの設定を微調整します。この操作の詳細な手順は、使用しているプラグインまたはインテグレーション手段によって異なります。デフォルトでは、プラグインは hits (API トランザクション) メトリクスしか報告しません。

一般的には、以下の手順に従う必要があります。

  1. アプリケーションは、着信 API コールで決められたとおりに、適切なメトリクス/メソッド名をプラグインに渡す必要があります。必要なメトリクス/メソッドの値および増分は、プラグインが公開する承認またはレポートメソッドの引数です。
  2. 3scale Service Management API を使用して、トラフィックを報告することもできます。3scale APIs ActiveDocs セクションには、さまざなエンドポイントに関する情報が用意されています。3scale ActiveDocs は、管理ポータルの Documentation → 3scale API Docs セクションで利用可能です。

特定の API メソッドのトラフィックを報告する場合には、メトリクスの引数でメソッド system name を使用します。これにより、報告されたメソッドと hits メトリクスの両方のカウンターに、自動的に増分が加算されます。