CloudWatch 中的用户池指标 - Amazon Cognito
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

CloudWatch 中的用户池指标

用户池将用户活动统计数据作为指标报告给 CloudWatch。在 CloudWatch 中,您可以分析用户池中的身份验证活动量和配额使用情况。利用这些指标中的信息,您可为值得注意的事件设置警报,并根据需要调整用户池配置。用户活动日志记录包含用户池中用户活动的详细记录,而 CloudWatch 指标则包含汇总的统计数据和性能指标。

下表列出了对 Amazon Cognito 用户池可用的指标。Amazon Cognito 的 Amazon CloudWatch 指标命名空间是 AWS/Cognito。有关更多信息,请参阅《Amazon CloudWatch 用户指南》中的命名空间

注意

控制台中不会显示在过去两周内没有任何新数据点的指标。当您在控制台中所有指标选项卡的搜索框中输入其指标名称或维度名称时,它们也不会显示。此外,它们不会在 list-metrics 命令的结果中返回。检索这些指标的最佳方法是在 Amazon CLI 中使用 get-metric-data 或者 get-metric-statistics 命令。

指标 描述
SignUpSuccesses

提供向 Amazon Cognito 用户池发出的成功用户注册请求的总数。一个成功的用户注册请求会产生值 1,而一个不成功的请求会产生值 0。受限制的请求也会被视为不成功的请求,因此,一个受限制的请求也将产生计数 0。

要查找成功的用户注册请求的百分比,请对此指标使用 Average 统计数据。要计算用户注册请求的总数,请对此指标使用 Sample Count 统计数据。要计算成功的用户注册请求的总数,请对此指标使用 Sum 统计数据。要计算失败的用户注册请求的总数,请使用 CloudWatch Math 表达式并从 Sample Count 统计数据中减去 Sum 统计数据。

为每个用户池客户端的用户池发布此指标。如果用户注册由管理员执行,则以 Admin 身份将指标与用户池客户端一起发布。

请注意,不会针对用户导入用户迁移案例发出此指标。

指标维度:UserPoolUserPoolClient

单位:计数

SignUpThrottles

提供向 Amazon Cognito 用户池发出的受限的用户注册请求的总数。当用户注册请求受到限制时,将发布计数 1。

要计算受限制的用户注册请求的总数,请对此指标使用 Sum 统计数据。

为每个客户端的每个用户池发布此指标。如果受限制的请求由管理员发出,则以 Admin 身份将指标与用户池客户端一起发布。

指标维度:UserPoolUserPoolClient

单位:计数

SignInSuccesses

提供向 Amazon Cognito 用户池发出的成功的用户身份验证请求的总数。在向用户颁发身份验证令牌时,用户身份验证将被视为成功。一个成功的身份验证会产生值 1,而一个不成功的请求会产生值 0。受限制的请求也会被视为不成功的请求,因此,一个受限制的请求也将产生计数 0。

要查找成功的用户身份验证请求的百分比,请对此指标使用 Average 统计数据。要计算用户身份验证请求的总数,请对此指标使用 Sample Count 统计数据。要计算成功的用户身份验证请求的总数,请对此指标使用 Sum 统计数据。要计算失败的用户身份验证请求的总数,请使用 CloudWatch Math 表达式并从 Sample Count 统计数据中减去 Sum 统计数据。

为每个客户端的每个用户池发布此指标。如果请求中提供了无效的用户池客户端,则指标中的相应用户池客户端值将包含固定值 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 令牌刷新请求的总数,请使用 CloudWatch Math 表达式并从 Sample Count 统计数据中减去 Sum 统计数据。

按每个用户池客户端发布此指标。如果请求中有无效的用户池客户端,则用户池客户端值包含固定值 Invalid

指标维度:UserPoolUserPoolClient

单位:计数

TokenRefreshThrottles

提供向 Amazon Cognito 用户池发出的受限制 Amazon Cognito 令牌刷新请求的总数。当 Amazon Cognito 令牌刷新请求受到限制时,将发布计数 1。

要计算受限制的 Amazon Cognito 令牌刷新请求的总数,请对此指标使用 Sum 统计数据。

为每个客户端的每个用户池发布此指标。如果请求中提供了无效的用户池客户端,则指标中的相应用户池客户端值将包含固定值 Invalid,而不是请求中发送的实际无效值。

指标维度:UserPoolUserPoolClient

单位:计数

FederationSuccesses

提供向 Amazon Cognito 用户池发出的成功的联合身份验证请求的总数。当 Amazon Cognito 向用户颁发身份验证令牌时,身份联合验证被视为成功。一个成功的联合身份验证请求会产生值 1,而一个不成功的请求会产生值 0。节流的请求以及生成授权码但没有令牌的请求所生成的值为 0。

要查找成功的联合身份验证请求的百分比,请对此指标使用 Average 统计数据。要计算联合身份验证请求的总数,请对此指标使用 Sample Count 统计数据。要计算成功的联合身份验证请求的总数,请对此指标使用 Sum 统计数据。要计算失败的联合身份验证请求的总数,请使用 CloudWatch Math 表达式并从 Sample Count统计数据中减去 Sum 统计数据。

指标维度:UserPoolUserPoolClientIdentityProvider

单位:计数

FederationThrottles

提供向 Amazon Cognito 用户池发出的受限制的联合身份验证请求的总数。当联合身份验证请求受到限制时,将发布计数 1。

要计算受限制的联合身份验证请求的总数,请对此指标使用 Sum 统计数据。

指标维度:UserPoolUserPoolClientIdentityProvider

单位:计数

CallCount

提供客户发出的与类别相关的调用总数。此指标包括所有调用,如受限制的调用、失败的调用和成功的调用。

此指标在用量 nameSpace 中提供。

类别配额针对账户和区域中所有用户池的每个Amazon账户强制实施。

您可以使用此指标的 Sum 统计数据计算调用总数。

指标维度:服务、类型、资源、类

单位:计数

ThrottleCount

提供与类别相关的受限调用总数。

此指标在用量 nameSpace 中提供。

此指标已在账户级别发布。

您可以使用此指标的 Sum 统计数据计算某个类别中的调用总数。

指标维度:服务、类型、资源、类

单位:计数

Amazon Cognito 用户池的维度

以下维度用于优化由 Amazon Cognito 发布的用量指标。维度仅适用于 CallCountThrottleCount 指标。

维度 描述

服务

包含该资源的 Amazon 服务的名称。对于 Amazon Cognito 用量指标,此维度的值为 Cognito user pool

类型

正在报告的实体的类型。Amazon Cognito 用量指标的唯一有效值为 API。

资源

正在运行的资源的类型。唯一的有效值是类别名。

所跟踪的资源的类。Amazon Cognito 不使用类维度。

使用 CloudWatch 控制台跟踪指标

您可以使用 CloudWatch 来跟踪和收集 Amazon Cognito 用户池指标。CloudWatch 控制面板将显示您所使用的每个Amazon服务的指标。您可以使用 CloudWatch 来创建指标告警。可以将警报设置为向您发送通知或更改您正在监控的特定资源。要在 CloudWatch 中查看服务配额指标,请完成以下步骤。

  1. 打开 CloudWatch 控制台

  2. 在导航窗格中,选择指标

  3. 所有指标中,选择一个指标和维度。

  4. 选中指标旁边的复选框。指标将出现在图表中。

注意

控制台中不会显示在过去两周内没有任何新数据点的指标。当您在控制台的“全部指标”选项卡的搜索框中输入指标名称或维度名称时,它们也不会显示,并且 list-metrics 命令的结果中不会返回它们。检索这些指标的最佳方法是在 Amazon CLI 中使用 get-metric-data 或者 get-metric-statistics 命令。

为配额创建 CloudWatch 告警

Amazon Cognito 提供 CloudWatch 使用量指标,这些指标与 CallCountThrottleCount API 的Amazon服务配额对应。有关在 CloudWatch 中跟踪使用量的更多信息,请参阅跟踪配额使用量

在 Service Quotas 控制台中,您可以创建告警,以便在您的使用量接近服务配额时提示您。要了解如何使用 Service Quotas 控制台设置 CloudWatch 告警,请参阅 Service Quotas 和 CloudWatch 告警