第19章 使用状況の詳細を把握するためのメソッドの指定およびメトリクスの追加

アプリケーションプランでは、API へのコンシューマーアクセスに対して上限および課金ルールを設定します。上限および課金ルールの適用を有効にするには、個々の使用状況データを収集するメソッドを API に指定するか、メトリクスを追加します。指定した各メソッドおよびカスタムメトリクスにマッピングルールを追加します。マッピングルールは、把握する使用状況データの詳細を指定します。

プロダクトおよびバックエンドに対して、メソッドを指定したりメトリクスを追加したりすることができます。プロダクトの場合、これにより、プロダクトのアプリケーションプランに上限および課金ルールを設定することができます。バックエンドの場合、これにより、そのバックエンドをバンドルするあらゆるプロダクトのアプリケーションプランに上限および課金ルールを設定することができます。

個々の呼び出しの数を把握するメソッドを指定します。これにより、API の使用をより細かい粒度で追跡することができます。メソッドにトラフィックがレポートされると、メソッドおよび Hits メトリクスのカウンターが自動的に加算されます。API バックエンドのエンドポイントごとにメソッドを指定することや、エンドポイントと HTTP メソッドの組み合わせにメソッドを指定することができます。API のエンドポイントをここで追加するメソッドにマッピングする方法については、「メソッドおよびメトリクスへのマッピングルールの追加」を参照してください。

メトリクスは、プロダクトとバックエンドの両方について、API の使用状況を追跡するのに適しています。Hits は、各 API に存在する組み込みのメトリクスです。これは、API への呼び出しの数を追跡します。Hits とは別に API の使用状況を把握するには、使用状況を別の単位でレポートするメトリクスを定義します。この単位は数値化が可能で、ビジネス目標に対して意味を持つものでなければなりません (例: メガバイト数、CPU 時間、または API によって返される要素数など)。CPU 時間や mb などの Hits 以外のメトリクスは、デフォルトでは提供されません。ユーザーが設定した外部サービスによって呼び出されるエンドポイントを使用して、これらのメトリクスを取得します。

メソッドおよびメトリクスは、API をパッケージ化するための骨組みです。それぞれのアプリケーションプランにより、指定した各メソッドおよびメトリクスに、異なる使用上限および課金ルールを定義することができます。メトリクスおよびメソッドにより報告される使用状況についての詳細は、「API の解析」を参照してください。

19.1. プロダクトおよびバックエンドへのメソッドの追加

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

手順

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

    重要

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

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

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

    このルールに準拠していれば、どのようなシステム名を定義することもできます。エンドポイントと同じにするか (/status)、たとえばメソッドおよびパスを含めることができます (GET_/status)。

  5. (オプション) Description フィールドに、メソッドのより詳細な説明を入力します。
  6. Create Method をクリックします。

検証手順

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

次のステップ

  • [Your_product_name] > Applications > Application Plans > [plan_you_want_to_edit] の順に移動して、各メソッドの上限および課金ルールを編集する。

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 パターンにマッピングする。「メソッドおよびメトリクスへのマッピングルールの追加」を参照してください。

19.3. メソッドおよびメトリクスをインポートするその他の方法

API に複数のエンドポイントがある場合、メソッドを自動的に指定し、3scale プロダクトおよびバックエンドにメトリクスを追加する方法は 2 つあります。

19.4. メソッドおよびメトリクスへのマッピングルールの追加

マッピングルールは、以前プロダクトおよびバックエンドに作成した メソッド および メトリクス にマッピングされる操作です。

注記

マッピングルールは、以前に作成したメソッドに必要ですが、メトリクスにはオプションになります。

手順

  1. [Your_product_name] > Integration > Mapping Rules の順に移動します。
  2. Add Mapping Rule をクリックします。
  3. Verb フィールドには HTTP メソッド GET が事前設定されていますが、ドロップダウンリストから他のオプションを選択できます。
  4. Pattern フィールドに、スラッシュ (/) で始まる有効な URL を追加します。URL は、中かっこ {} 内に指定したワイルドカードから設定できます。
  5. Metric or Method to increment フィールドで、以前に作成したメソッドまたはメトリクスのいずれかを選択します。
  6. Increment by フィールドには 1 が事前設定されていますが、必要に応じて変更してください。
  7. Create Mapping Rule のボタンをクリックします。

検証手順

  • マッピングルールを確認するには、[Your_product_name] > Integration > Methods & Metrics の順に移動します。各メソッドおよびメトリクスの Mapped 列に、チェックマークが付いているはずです。

19.5. その他のリソース