31.2. API メトリクスを取得するための 3scale プラグインの設定

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

前提条件

  • プロダクトまたはバックエンドにメトリクスがすでに設定されている必要があります。

手順

  1. 着信 API コールで決められたとおりに、適切なメトリクス/メソッド名をプラグインに渡します。

    必要なメトリクス/メソッドの値および増分は、プラグインが公開する承認またはレポートメソッドの引数です。

  2. メトリクスで System name メソッドを使用して、特定の API メソッドのトラフィックを報告します。

    これにより、報告されたメソッドと Hits メトリクスの両方のカウンターに、自動的に増分が加算されます。

  3. 管理ポータルの Account Settings > Integrate → 3scale API Docs で、3scale Service Management API を使用してトラフィックを報告します。

さまざまなエンドポイントに関する補足情報については、管理ポータルの Account Settings > Integrate → 3scale API Docs から利用できる3scale API Documentation を参照してください。