のユーザープールメトリクス CloudWatch - Amazon Cognito

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

のユーザープールメトリクス CloudWatch

ユーザープールは、ユーザーアクティビティ統計をメトリクス CloudWatch として に報告します。から CloudWatch、ユーザープール内の認証アクティビティの量とクォータ使用量を分析できます。これらのメトリクスの情報を使用して、注目すべきイベントのアラームを設定し、必要に応じてユーザープール設定を調整できます。ユーザーアクティビティのログ記録にユーザープール内のユーザーアクティビティの詳細なレコードがある場合、 CloudWatch メトリクスには集計統計とパフォーマンスインジケータがあります。

以下の表には、Amazon Cognito ユーザープールに使用できるメトリクスがリストされています。Amazon Cognito の Amazon CloudWatch メトリクスの名前空間は AWS/Cognito です。詳細については、「Amazon CloudWatch ユーザーガイド」の「名前空間」を参照してください。

注記

過去 2 週間に新しいデータポイントがなかったメトリクスは、コンソールに表示されません。また、コンソールの [All metrics] (すべてのメトリクス) タブにある検索ボックスにそれらのメトリクス名またはディメンション名を入力しても表示されません。さらに、list-metrics コマンドの結果にも返されません。これらのメトリクスを取得する最善の方法は、 の get-metric-dataまたは get-metric-statistics コマンドを使用することです AWS CLI。

メトリクス 説明
SignUpSuccesses

Amazon Cognito ユーザープールに対して正常に行われたユーザー登録リクエストの合計数を提供します。正常に行われたユーザー登録リクエストは 1 の値を生成し、失敗したリクエストは 0 の値を生成します。スロットリングされたリクエストも失敗したリクエストと見なされるため、スロットリングされたリクエストも 0 の数を生成します。

正常に行われたユーザー登録リクエストの割合を確認するには、このメトリクスの Average 統計を使用します。ユーザー登録リクエストの合計数を計上するには、このメトリクスの Sample Count 統計を使用します。正常に行われたユーザー登録リクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。失敗したユーザー登録リクエストの合計数をカウントするには、式を使用して CloudWatch MathSum統計からSample Count統計を減算します。

このメトリクスは、各ユーザープールクライアントのユーザープールごとにパブリッシュされます。ユーザー登録が管理者によって実行された場合、メトリクスはユーザープールクライアントを Admin とした形でパブリッシュされます。

このメトリクスは、ユーザーのインポートおよびユーザーの移行には生成されません。

メトリクスディメンション: UserPoolUserPoolClient

単位: 数

SignUpThrottles

Amazon Cognito ユーザープールに対して行われたユーザー登録リクエストで、スロットリングされたものの合計数を提供します。ユーザー登録リクエストがスロットリングされるたびに、1 の数が発行されます。

スロットリングされたユーザー登録リクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。

このメトリクスは、各クライアントのユーザープールごとにパブリッシュされます。スロットリングされたリクエストが管理者によって行われたものである場合、メトリクスはユーザープールクライアントを Admin とした形でパブリッシュされます。

メトリクスディメンション: UserPoolUserPoolClient

単位: 数

SignInSuccesses

Amazon Cognito ユーザープールに対して正常に行われたユーザー認証リクエストの合計数を提供します。認証トークンがユーザーに発行されると、ユーザー認証は正常に行われたとみなされます。認証が正常に行われると 1 の値が生成され、リクエストが失敗すると 0 の値が生成されます。スロットリングされたリクエストも失敗したリクエストと見なされるため、スロットリングされたリクエストも 0 の数を生成します。

正常に行われたユーザー認証リクエストの割合を調べるには、このメトリクスの Average 統計を使用します。ユーザー認証リクエストの合計数を計上するには、このメトリクスの Sample Count 統計を使用します。正常に行われたユーザー認証リクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。失敗したユーザー認証リクエストの合計数をカウントするには、式を使用して CloudWatch MathSum統計からSample Count統計を減算します。

このメトリクスは、各クライアントのユーザープールごとにパブリッシュされます。リクエストで無効なユーザープールクライアントが提供された場合、メトリクスの対応するユーザープールクライアント値には、リクエストで送信された実際の無効な値ではなく、固定値の Invalid が含まれます。

このメトリクスには Amazon Cognito トークンを更新するリクエストが含まれないことに注意してください。Refresh トークン統計の提供には、別のメトリクスがあります。

メトリクスディメンション: UserPoolUserPoolClient

単位: 数

SignInThrottles

Amazon Cognito ユーザープールに対して行われたユーザー認証リクエストで、スロットリングされたものの合計数を提供します。認証リクエストがスロットリングされるたびに、1 の数が発行されます。

スロットリングされたユーザー認証リクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。

このメトリクスは、各クライアントのユーザープールごとにパブリッシュされます。リクエストで無効なユーザープールクライアントが提供された場合、メトリクスの対応するユーザープールクライアント値には、リクエストで送信された実際の無効な値ではなく、固定値の Invalid が含まれます。

このメトリクスに Amazon Cognito トークンを更新するリクエストは含まれません。Refresh トークン統計の提供には、別のメトリクスがあります。

メトリクスディメンション: UserPoolUserPoolClient

単位: 数

TokenRefreshSuccesses

Amazon Cognito ユーザープールに対して行われた Amazon Cognito を更新するリクエストで、正常に行われたものの合計数を提供します。Amazon Cognito トークンの更新リクエストが正常に行われると 1 の値が生成され、失敗したリクエストには 0 の値が生成されます。スロットリングされたリクエストも失敗したリクエストと見なされるため、スロットリングされたリクエストも 0 の数を生成します。

正常に行われた Amazon Cognito トークンの更新リクエストの割合を調べるには、このメトリクスの Average 統計を使用します。Amazon Cognito トークンを更新するリクエストの合計数を計上するには、このメトリクスの Sample Count 統計を使用します。正常に行われた Amazon Cognito トークンの更新リクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。Amazon Cognito トークンを更新する失敗したリクエストの合計数をカウントするには、Math式を使用して CloudWatchSum統計からSample Count統計を減算します。

このメトリクスは、ユーザープールクライアントごとにパブリッシュされます。リクエストに無効なユーザープールクライアントがある場合、ユーザープールクライアントの値には固定値の Invalid が含まれます。

メトリクスディメンション: UserPoolUserPoolClient

単位: 数

TokenRefreshThrottles

Amazon Cognito ユーザープールに対して行われた Amazon Cognito トークンを更新するリクエストで、スロットリングされたものの合計数を提供します。Amazon Cognito トークンの更新リクエストがスロットリングされるたびに、1 の数が発行されます。

Amazon Cognito トークンのスロットリングされた更新リクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。

このメトリクスは、各クライアントのユーザープールごとにパブリッシュされます。リクエストで無効なユーザープールクライアントが提供された場合、メトリクスの対応するユーザープールクライアント値には、リクエストで送信された実際の無効な値ではなく、固定値の Invalid が含まれます。

メトリクスディメンション: UserPoolUserPoolClient

単位: 数

FederationSuccesses

Amazon Cognito ユーザープールに対して正常に行われた ID フェデレーションリクエストの合計数を提供します。ID フェデレーションは、Amazon Cognito がユーザーに認証トークンを発行した時点で成功とみなされます。ID フェデレーションリクエストが正常に行われると 1 の値が生成され、失敗すると 0 の値が生成されます。スロットリングされたリクエストや、認可コードは生成されるがトークンは生成されないリクエストでは、値が 0 になります。

正常に行われた ID フェデレーションリクエストの割合を調べるには、このメトリクスの Average 統計を使用します。ID フェデレーションリクエストの合計数を計上するには、このメトリクスの Sample Count 統計を使用します。正常に行われた ID フェデレーションリクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。失敗した ID フェデレーションリクエストの合計数をカウントするには、式を使用して CloudWatch MathSum統計からSample Count統計を減算します。

メトリクスディメンション:UserPoolUserPoolClientIdentityProvider

単位: 数

FederationThrottles

Amazon Cognito ユーザープールに対して行われた ID フェデレーションリクエストで、スロットリングされたものの合計数を提供します。ID フェデレーションリクエストがスロットリングされるたびに、1 の数が発行されます。

スロットリングされた ID フェデレーションリクエストの合計数を計上するには、このメトリクスの Sum 統計を使用します。

メトリクスディメンション:UserPoolUserPoolClientIdentityProvider

単位: 数

CallCount

顧客が実行したコールで、カテゴリに関連するものの合計数を提供します。このメトリクスには、スロットリングコール、失敗したコール、正常に行われたコールなどのすべてのコールが含まれます。

このメトリクスは [Usage] (使用状況) の nameSpace で利用できます。

カテゴリクォータは、 AWS アカウントとリージョンのすべてのユーザープールにわたって、各アカウントに対して適用されます。

カテゴリ内のコールの合計数は、このメトリクスの Sum 統計を使用して計上できます。

メトリクスディメンション: Type、Resource、Class

単位: 数

ThrottleCount

スロットルされたコールで、カテゴリに関連するものの合計数を提供します。

このメトリクスは [Usage] (使用状況) の nameSpace で利用できます。

このメトリクスは、アカウントレベルでパブリッシュされます。

カテゴリ内のコールの合計数は、このメトリクスの Sum 統計を使用して計上できます。

メトリクスディメンション: Type、Resource、Class

単位: 数

Amazon Cognito ユーザープールのディメンション

Amazon Cognito によってパブリッシュされた使用状況メトリクスの絞り込みには、以下のディメンションが使用されます。ディメンションは、CallCount および ThrottleCount メトリクスのみに適用されます。

ディメンション 説明

Service

リソースを含む AWS サービスの名前。Amazon Cognito の使用状況メトリクスの場合、このディメンションの値は Cognito user pool です。

Type

報告されるエンティティのタイプ。Amazon Cognito 使用状況メトリクスの有効な値は のみですAPI。

リソース

実行中のリソースのタイプ。有効な値はカテゴリ名のみです。

Class

追跡されているリソースのクラス。Amazon Cognito は class ディメンションを使用しません。

CloudWatch コンソールを使用してメトリクスを追跡する

を使用して Amazon Cognito ユーザープールメトリクスを追跡および収集できます CloudWatch。 CloudWatch ダッシュボードには、使用するすべての AWS サービスに関するメトリクスが表示されます。 CloudWatch を使用してメトリクスアラームを作成できます。アラームは、通知を送信する、またはモニタリングしている特定のリソースに変更を行うように設定できます。でサービスクォータメトリクスを表示するには CloudWatch、次の手順を実行します。

  1. CloudWatch コンソール を開きます。

  2. ナビゲーションペインで Metrics (メトリクス) を選択します。

  3. [All metrics] (すべてのメトリクス) でメトリクスとディメンションを選択します。

  4. メトリクスの横にあるチェックボックスをオンにします。グラフにメトリクスが表示されます。

注記

過去 2 週間に新しいデータポイントがなかったメトリクスは、コンソールに表示されません。また、コンソールの [All metrics] (すべてのメトリクス) タブにある検索ボックスにそれらのメトリクス名またはディメンション名を入力しても表示されず、list-metrics コマンドの結果にも返されません。これらのメトリクスを取得する最善の方法は、 の AWS get-metric-dataまたは get-metric-statistics コマンドを使用することですCLI。

クォータの CloudWatch アラームを作成する

Amazon Cognito は、 CallCountおよび ThrottleCount AWS のサービスクォータに対応する CloudWatch 使用状況メトリクスを提供しますAPIs。での使用状況の追跡の詳細については CloudWatch、「」を参照してくださいクォータの使用状況を追跡する

Service Quotas コンソールで、使用量がサービスクォータに近づいた場合に警告するアラームを作成できます。Service Quotas コンソールを使用して CloudWatch アラームを設定する方法については、Service Quotas CloudWatch alarms」を参照してください。