19.2. プロダクトおよびバックエンドへのメトリクスの追加

メトリクスを追加して、API へのすべての呼び出しについて把握する使用状況の単位を指定します。アプリケーションプランにより、プロダクトまたはバックエンドに追加する各メトリクスに上限を設定することができます。プロダクトにメソッドまたはメトリクスを追加する手順は、メソッドまたはメトリクスをバックエンドに追加する手順と類似しています。

手順

  1. [Your_product_name] > Integration > Methods & Metrics または [Your_backend_name] > Methods & Metrics の順に移動します。
  2. New metric をクリックします。
  3. Friendly name フィールドに、メトリクスの簡単な説明を入力します。この名前は、3scale 管理ポータルのさまざまなセクションに表示されます。平易な名前は、プロダクト単位で一意でなければなりません。

    重要

    メトリクスのシステム名を変更する場合やそれらを削除する場合は、注意してください。メトリクスの変更前のシステム名/削除したメトリクスをポイントするマッピングルールがあると、これらの変更によりデプロイ済みの 3scale インテグレーションが機能しなくなります。

  4. System name フィールドに、3scale Service Management API 経由で使用状況を報告するのに使用する API のメトリクスの名前を入力します。システム名は、以下のルールに準拠する必要があります。

    • プロダクトまたはバックエンド単位で一意である。
    • 英数字、アンダースコア (_)、ハイフン (-)、またはスラッシュ (/) のみが含まれる。
    • スペースなし。

    このルールに準拠していれば、どのようなシステム名を定義することもできます。

  5. Unit フィールドに単位を入力します。

    • hit のように、単数形の名詞を使用します。解析チャートでは、単数形が複数形に変わります。
  6. (オプション) Description フィールドに、メトリクスのより詳細な説明を入力します。
  7. Create Metric をクリックします。

検証手順

  • 追加したメトリクスがアプリケーションプランで利用可能である。

次のステップ

  • [Your_product_name] > Applications > Application Plans > [plan_you_want_to_edit] の順に移動して、各メトリクスの上限および課金ルールを編集する。
  • [Your_product_name] > Integration > Mapping Rules の順に移動して、メトリクスを 1 つまたは複数の URL パターンにマッピングする。メソッドおよびメトリクスへのマッピングルールの追加 を参照してください。