19.2. プロダクトおよびバックエンドへのメトリックの追加
メトリックを追加して、API へのすべての呼び出しについて把握する使用状況の単位を指定します。アプリケーションプランにより、プロダクトまたはバックエンドに追加する各メトリックに上限を設定することができます。プロダクトにメソッドまたはメトリックを追加する手順は、メソッドまたはメトリックをバックエンドに追加する手順と類似しています。
手順
- [Your_product_name] > Integration > Methods & Metrics または [Your_backend_name] > Methods & Metrics の順に移動します。
- Metrics タブをクリックします。
- Add a metric をクリックします。
Friendly name フィールドに、メトリクスの簡単な説明を入力します。この名前は、3scale 管理ポータルのさまざまなセクションに表示されます。平易な名前は、プロダクト単位で一意でなければなりません。
重要メトリックのシステム名を変更する場合やそれらを削除する場合は、注意してください。メトリックの変更前のシステム名/削除したメトリックをポイントするマッピングルールがあると、これらの変更によりデプロイ済みの 3scale インテグレーションが機能しなくなります。
System name フィールドに、3scale Service Management API 経由で使用状況を報告するのに使用する API のメトリクスの名前を入力します。
システム名の形式を決定します。ただし、システム名は、以下のルールに準拠する必要があります。
- プロダクトまたはバックエンド単位で一意である。
-
英数字、アンダースコア (
_)、ハイフン (-)、またはスラッシュ (/) のみが含まれる。 - スペースなし。
- バックエンド API の場合、メトリックのシステム名には、マップされたバックエンドを識別する数値の文字列が含まれます。このバックエンド識別子を変更することはできません。
Unit フィールドに単位を入力します。
- hit のように、単数形の名詞を使用します。解析チャートでは、単数形が複数形に変わります。
- (オプション) Description フィールドに、メトリックのより詳細な説明を入力します。
- Create Metric をクリックします。
検証手順
- 追加したメトリックがアプリケーションプランで利用可能である。