User pools report user-activity statistics to CloudWatch as metrics. From CloudWatch, you can analyze the volume of authentication activity and quota usage in your user pools. With the information in these metrics, you can set alarms for noteworthy events and adjust your user pool configuration as needed. Where user-activity logging has detailed records of user activity in your user pools, CloudWatch metrics have aggregated statistics and performance indicators.
The following table lists the metrics available for Amazon Cognito user pools. Amazon Cognito publishes
metrics to the namespaces AWS/Cognito and AWS/Usage. For more
information, see Namespaces in Amazon CloudWatch User Guide.
For more information about tracking quotas and usage, see Track quota usage and Track monthly active users (MAUs).
Note
Metrics that haven't had any new data points in the past two weeks don't appear in the
console. They also don't appear when you enter their metric name or dimension names in the
search box in the All metrics tab in the console. In addition, they
are not returned in the results of a list-metrics command. The best way to retrieve these
metrics is with the get-metric-data or get-metric-statistics
commands in the AWS CLI.
| Metric | Description | Namespace |
|---|---|---|
SignUpSuccesses |
Provides the total number of successful user registration requests made to the Amazon Cognito user pool. A successful user registration request produces a value of 1, whereas an unsuccessful request produces a value of 0. A throttled request is also considered as an unsuccessful request, and hence a throttled request will also produce a count of 0. To find the percentage of successful user registration requests, use the
This metric is published for each user pool for each user pool client. In case
when the user registration is performed by an admin, the metric is published with
the user pool client as Note that this metric is not emitted for User import and User migration cases. Metric dimension: Units: Count |
|
SignUpThrottles |
Provides the total number of throttled user registration requests made to the Amazon Cognito user pool. A count of 1 is published whenever a user registration request is throttled. To count the total number of throttled user registration requests, use the
This metric is published for each user pool for each client. In case when the
request that was throttled was made by an administrator, the metric is published
with user pool client as Metric dimension: Units: Count |
|
SignInSuccesses |
Provides the total number of successful user authentication requests made to the Amazon Cognito user pool. A user authentication is considered successful when authentication token is issued to the user. A successful authentication produces a value of 1, whereas an unsuccessful request produces a value of 0. A throttled request is also considered as an unsuccessful request, and hence a throttled request will also produce a count of 0. To find the percentage of successful user authentication requests, use the
This metric is published for each user pool for each client. In case an
invalid user pool client is provided with a request, the corresponding user pool
client value in the metric contains a fixed value
Note that requests to refresh the Amazon Cognito token is not included in this metric.
There is a separate metric for providing Metric dimension: Units: Count |
|
SignInThrottles |
Provides the total number of throttled user authentication requests made to the Amazon Cognito user pool. A count of 1 is published whenever an authentication request is throttled. To count the total number of throttled user authentication requests, use the
This metric is published for each user pool for each client. In case an
invalid user pool client is provided with a request, the corresponding user pool
client value in the metric contains a fixed value Requests to refresh Amazon Cognito token is not included in this metric. There is a
separate metric for providing Metric dimension: Units: Count |
|
TokenRefreshSuccesses |
Provides the total number of successful requests to refresh an Amazon Cognito token that were made to the Amazon Cognito user pool. A successful refresh Amazon Cognito token request produces a value of 1, whereas an unsuccessful request produces a value of 0. A throttled request is also considered as an unsuccessful request, and hence a throttled request will also produce a count of 0. To find the percentage of successful requests to refresh an Amazon Cognito token, use
the This metric is published per each user pool client. If an invalid user pool
client is in a request, the user pool client value contains a fixed value of
Metric dimension: Units: Count |
|
TokenRefreshThrottles |
Provides the total number of throttled requests to refresh an Amazon Cognito token that were made to the Amazon Cognito user pool. A count of 1 is published whenever a refresh Amazon Cognito token request is throttled. To count the total number of throttled requests to refresh an Amazon Cognito token, use
the This metric is published for each user pool for each client. In case an
invalid user pool client is provided with a request, corresponding user pool
client value in the metric contains a fixed value Metric dimension: Units: Count |
|
FederationSuccesses |
Provides the total number of successful identity federation requests to the Amazon Cognito user pool. An identity federation is considered successful when Amazon Cognito issues authentication tokens to the user. A successful identity federation request produces a value of 1, whereas an unsuccessful request produces a value of 0. Throttled requests and requests that generate an authorization code but no tokens produce a value of 0. To find the percentage of successful identity federation requests, use the
Metric dimension: Units: Count |
|
FederationThrottles |
Provides the total number of throttled identity federation requests to the Amazon Cognito user pool. A count of 1 is published whenever an identity federation request is throttled. To count the total number of throttled identity federation requests, use the
Metric dimension: Units: Count |
|
CallCount |
Provides the total number of calls customers made related to a category. This metric includes all the calls, such as throttled calls, failed calls, and successful calls. This metric is available in the Usage
The category quota is enforced for each AWS account across all user pools in an account and Region. You can count the total number of calls in a category using the
Metric dimension: Service, Type, Resource, Class Units: Count |
|
ThrottleCount |
Provides the total number of throttled calls related to a category. This metric is available in the Usage
This metric is published at the account level. You can count the total number of calls in a category, using the
Metric dimension: Service, Type, Resource, Class Units: Count |
Viewing threat
protection metrics
The metrics that your user pool publishes have statistical information about the effect that your threat protection settings have on user authentication activity. You might want to know how many users are attempting to sign in with compromised credentials. You can also find out what percentage of sign-in activity was evaluated to have some level of risk. Amazon Cognito publishes metrics for threat protection features to your account in Amazon CloudWatch. Amazon Cognito groups the threat protection metrics together by risk level and also by request level.
To add context to your risk analysis, you can view information about individual user sign-in attempts, either in your user pool or in an exported data source.
To view metrics in the CloudWatch console
-
Open the CloudWatch console at https://console.aws.amazon.com/cloudwatch/
. -
In the navigation pane, choose Metrics.
-
Choose Amazon Cognito.
-
Choose a group of aggregated metrics, such as By Risk Classification.
-
The All metrics tab displays all metrics for that choice. You can do the following:
-
To sort the table, use the column heading.
-
To graph a metric, select the check box next to the metric. To select all metrics, select the check box in the heading row of the table.
-
To filter by resource, choose the resource ID, and then choose Add to search.
-
To filter by metric, choose the metric name, and then choose Add to search.
-
|
Metric |
Description |
Metric Dimensions |
|---|---|---|
|
CompromisedCredentialRisk |
Requests where Amazon Cognito detected compromised credentials. |
Operation: The type of operation. UserPoolId: The identifier of the user pool. RiskLevel: high (default), medium, or low. |
|
AccountTakeoverRisk |
Requests where Amazon Cognito detected account take-over risk. |
Operation: The type of operation. UserPoolId: The identifier of the user pool. RiskLevel: high, medium, or low. |
|
OverrideBlock |
Requests that Amazon Cognito blocked because of the configuration provided by the developer. |
Operation: The type of operation. UserPoolId: The identifier of the user pool. RiskLevel: high, medium, or low. |
|
Risk |
Requests that Amazon Cognito marked as risky. |
Operation: The type of operation, such as UserPoolId: The identifier of the user pool. |
|
NoRisk |
Requests where Amazon Cognito did not identify any risk. |
Operation: The type of operation, such as UserPoolId: The identifier of the user pool. |
Amazon Cognito offers you two predefined groups of metrics for ready analysis in CloudWatch. By Risk Classification identifies the granularity of the risk level for requests that Amazon Cognito identifies as risky. By Request Classification reflects metrics aggregated by request level.
|
Aggregated Metrics Group |
Description |
|---|---|
|
By Risk Classification |
Requests that Amazon Cognito identifies as risky. |
|
By Request Classification |
Metrics aggregated by request. |
Dimensions for Amazon Cognito user pools
The following dimensions are used to refine the usage metrics that are published by
Amazon Cognito. The dimensions only apply to CallCount and ThrottleCount
metrics.
| Dimension | Description |
|---|---|
|
Service |
The name of the AWS service containing the resource. For Amazon Cognito usage
metrics, the value for this dimension is |
|
Type |
The type of entity that is being reported. The only valid value for Amazon Cognito usage metrics is API. |
|
Resource |
The type of resource that is running. The only valid value is category name. |
|
Class |
The class of resource being tracked. Amazon Cognito doesn't use the class dimension. |
Use the CloudWatch console to track
metrics
You can track and collect Amazon Cognito user pools metrics using CloudWatch. The CloudWatch dashboard will display metrics about every AWS service you use. You can use CloudWatch to create metric alarms. The alarms can be set up to send you notifications or make a change to a specific resource that you are monitoring. To view service quota metrics in CloudWatch, complete the following steps.
-
Open the CloudWatch console
. -
In the navigation pane, choose Metrics.
-
In All metrics select a metric and a dimension.
-
Select the check box next to a metric. The metrics will appear in the graph.
Note
Metrics that haven't had any new data points in the past two weeks don't appear in the
console. They also don't appear when you enter their metric name or dimension names in the
search box in the All metrics tab in the console, and they are not returned in the results
of a list-metrics command. The best way to retrieve these metrics is with the
get-metric-data or get-metric-statistics commands in the AWS
CLI.
Create a CloudWatch alarm for a quota
Amazon Cognito provides CloudWatch usage metrics that correspond to the AWS service quotas for
CallCount and ThrottleCount APIs. For more information about
tracking usage in CloudWatch, see Track quota usage.
In the Service Quotas console, you can create alarms that alert you when your usage approaches a service quota. To learn how to set up a CloudWatch alarm using the Service Quotas console, see Service Quotas and CloudWatch alarms.
