Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 Amazon Web Services 服务入门。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

监控和日志记录

监控Amazon AppSync GraphQL API 并帮助调试与请求相关的问题，你可以开启日志记录到亚马逊 CloudWatch 日志。

设置和配置

要在 GraphQL API 上开启自动日志记录，请使用Amazon AppSync 控制台。

手动配置 IAM 角色

如果您选择使用现有的 IAM 角色，则该角色必须授予该角色。Amazon AppSync 将日志写入 CloudWatch 所需的权限。要手动配置此功能，必须提供服务角色 ARN 以便Amazon AppSync 可以在编写日志时担任该角色。

在IAM 控制台中，使用名称创建新策略AWSAppSyncPushToCloudWatchLogsPolicy具有以下定义：

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:PutLogEvents"
            ],
            "Resource": "*"
        }
    ]
}

接下来，使用名称创建新的角色Amazon AppSyncpushtoCloudWatch LogsRole，然后将新创建的策略附加到该角色。将此角色的信任关系编辑为以下内容：

{
    "Version": "2012-10-17",
    "Statement": [
        {
        "Effect": "Allow",
        "Principal": {
            "Service": "appsync.amazonaws.com"
        },
        "Action": "sts:AssumeRole"
        }
    ]
}

复制角色 ARN 并在为Amazon AppSync GraphQL API。

CloudWatch 指标

您可以使用 CloudWatch 指标，用于监控并提供有关特定事件的提醒，这些事件可能导致 HTTP 状态代码或延迟。将发出以下指标。

实时订阅

所有指标都在一个维度中发出：GraphQLAPIId. 这意味着所有指标都与 GraphQL API ID 相结合。以下指标与纯 WebSockets 上的 GraphQL 订阅相关：

CloudWatch Logs

您可以对任何新的或现有的 GraphQL API 配置两种类型的日志记录：请求级别和字段级别。

请求级别日志

当请求级别日志记录时 (包括详细内容) 配置后，系统会记录以下信息：

字段级别日志

配置字段级日志记录时，系统会记录以下信息：

如果您启用日志记录，Amazon AppSync 管理 CloudWatch 日志。该过程包括创建日志组和日志流，以及向日志流报告这些日志。

当您开启 GraphQL API 的日志记录并发起请求时，Amazon AppSync 创建日志组和日志组下的日志流。日志组以 /aws/appsync/apis/{graphql_api_id} 格式命名。在每个日志组内，日志会进一步分成多个日志流。当报告已记录的数据时，这些日志按上次事件时间排序。

每个日志事件都用该请求的 x-amzn-RequestId 进行标记。这可以帮助你过滤中的日志事件 CloudWatch 以获取有关该请求的所有记录信息。您可以获取 RequestId 从每个 GraphQL 的响应标头Amazon AppSync 请求.

字段级别日志记录配置为使用以下日志级别：

监控的优势

您可以使用日志记录和指标来识别、优化 GraphQL 查询和排除其问题。例如，这些将帮助您使用针对查询中的每个字段记录的跟踪信息调试延迟问题。为了对此进行演示，假设您正在使用一个或多个嵌套在 GraphQL 查询中的解析程序。中的示例现场操作 CloudWatch 日志可能类似于以下内容：

{
    "path": [
        "singlePost",
        "authors",
        0,
        "name"
    ],
    "parentType": "Post",
    "returnType": "String!",
    "fieldName": "name",
    "startOffset": 416563350,
    "duration": 11247
}

这可能对应于 GraphQL 架构，类似于以下内容：

type Post {
  id: ID!
  name: String!
  authors: [Author]
}

type Author {
  id: ID!
  name: String!
}

type Query {
  singlePost(id:ID!): Post
}

在上述日志结果中，路径显示从运行名为的查询所返回的数据中的单个项目。singlePost(). 在此示例中，它表示名称位于第一个索引 (0) 处的字段。这些区域有：startOffset给出 GraphQL 查询操作开始时的偏移量。这些区域有：持续时间是解析该字段的总时间。这些值可用来排除下面这类问题：为何来自特定数据源的数据的运行速度可能低于预期，或者特定字段是否降低了整个查询的速度等。例如，您可能选择增加 Amazon DynamoDB 表的预配置吞吐量，或者从查询中删除导致整体操作效果不佳的某个字段。

截至 2019 年 5 月 8 日，Amazon AppSync 生成日志事件为完全结构化的 JSON。这可以帮助你使用日志分析服务，例如 CloudWatch 日志 Insights 和亚马逊 OpenSearch 了解 GraphQL 请求的性能和架构字段的使用特征的服务。例如，您可以轻松识别具有较大延迟的解析程序，这可能是导致性能问题的根本原因。您还可以识别架构中最常用和最不常用的字段，并评估弃用 GraphQL 字段的影响。

冲突检测和同步日志记录

如果Amazon AppSync API 已登录 CloudWatch 配置了日志字段解析程序日志级别设置为全部，那么Amazon AppSync 向日志组发送冲突检测和解决方案信息。这提供了细致的洞察力，了解Amazon AppSync API 对冲突做出了回应。为此，为此，日志中提供以下信息：

使用令牌计数来优化您的请求

消耗少于或等于 1,500 KB 秒内存和 vCPU 时间的请求将分配一个令牌。资源消耗大于 1,500 KB 秒的请求将获得额外的令牌。例如，如果请求耗时 3,350 KB 秒，Amazon AppSync 为请求分配三个令牌（向上舍入到下一个整数值）。默认情况下，Amazon AppSync 每秒最多为 2,000 个请求令牌分配给您账户中的 API，每Amazon区域。如果您的 API 每秒平均使用两个令牌，则每秒限制为 1,000 个请求。如果您每秒需要的令牌超过分配的金额，则可以提交请求以提高请求令牌速率的默认配额。有关更多信息，请参阅 。AmazonAppSync 终端节点和配额中的Amazon一般参考指南和请求增加配额中的Service Quotas 用户指南.

较高的每个请求令牌数可能表明有机会优化请求并提高 API 的性能。可以增加每个请求令牌数量的因素包括：

日志类型引用

RequestSummary

{
     "logType": "RequestSummary",
     "requestId": "dbe87af3-c114-4b32-ae79-8af11f3f96f1",
     "graphQLAPIId": "pmo28inf75eepg63qxq4ekoeg4",
     "statusCode": 200,
     "latency": 242000000
}

ExecutionSummary

{
    "duration": 217406145,
    "logType": "ExecutionSummary",
    "requestId": "dbe87af3-c114-4b32-ae79-8af11f3f96f1",
    "startTime": "2019-01-01T06:06:18.956Z",
    "endTime": "2019-01-01T06:06:19.174Z",
    "parsing": {
        "startOffset": 49033,
        "duration": 34784
    },
    "version": 1,
    "validation": {
        "startOffset": 129048,
        "duration": 69126
    },
    "graphQLAPIId": "pmo28inf75eepg63qxq4ekoeg4"
}

跟踪

{
    "duration": 216820346,
    "logType": "Tracing",
    "path": [
        "putItem"
    ],
    "fieldName": "putItem",
    "startOffset": 178156,
    "resolverArn": "arn:aws:appsync:us-east-1:111111111111:apis/pmo28inf75eepg63qxq4ekoeg4/types/Mutation/fields/putItem",
    "requestId": "dbe87af3-c114-4b32-ae79-8af11f3f96f1",
    "parentType": "Mutation",
    "returnType": "Item",
    "graphQLAPIId": "pmo28inf75eepg63qxq4ekoeg4"
}

使用分析日志 CloudWatch 日志见解

以下是您可以运行的查询示例，以获取有关 GraphQL 操作的性能和运行状况的可行的见解。这些示例可作为示例查询提供在 CloudWatch 日志 Insights 控制台。在CloudWatch 控制台，选择日志见解中，选择Amazon AppSync GraphQL API 的日志组，然后选择Amazon AppSync查询下示例查询.

以下查询返回具有最大令牌消耗的前 10 个 GraphQL 请求：

filter @message like "Tokens Consumed"
| parse @message "* Tokens Consumed: *" as requestId, tokens
| sort tokens desc
| display requestId, tokens
| limit 10

以下查询返回具有最大延迟的前 10 个解析程序：

  fields resolverArn, duration
| filter logType = "Tracing"
| limit 10
| sort duration desc

以下查询返回最常调用的解析程序：

  fields ispresent(resolverArn) as isRes
| stats count() as invocationCount by resolverArn
| filter isRes and logType = "Tracing"
| limit 10
| sort invocationCount desc

以下查询返回映射模板中具有最多错误的解析程序：

  fields ispresent(resolverArn) as isRes
| stats count() as errorCount by resolverArn, logType
| filter isRes and (logType = "RequestMapping" or logType = "ResponseMapping") and fieldInError
| limit 10
| sort errorCount desc

以下查询返回解析程序延迟统计数据：

  fields ispresent(resolverArn) as isRes
| stats min(duration), max(duration), avg(duration) as avg_dur by resolverArn
| filter isRes and logType = "Tracing"
| limit 10
| sort avg_dur desc

以下查询返回字段延迟统计数据：

  stats min(duration), max(duration), avg(duration) as avg_dur
  by concat(parentType, '/', fieldName) as fieldKey
| filter logType = "Tracing"
| limit 10
| sort avg_dur desc

的结果 CloudWatch Logs Insights 查询可以导出到 CloudWatch 控制面板。

使用分析日志 OpenSearch 服务

你可以搜索、分析和可视化Amazon AppSync 使用 Amazon 进行日志 OpenSearch 确定性能瓶颈和运营问题的根本原因的服务。您可以识别具有最大延迟和最多错误的解析程序。此外，您还可以使用 OpenSearch 用于创建具有强大可视化效果的仪表板。 OpenSearch Destboard 是中提供的开源数据可视化和挖掘工具。 OpenSearch 服务 。使用 OpenSearch 控制面板，您可以持续监控 GraphQL 操作的性能和运行状况。例如，您可以创建控制面板以可视化 GraphQL 请求的 P90 延迟，并深入了解每个解析程序的 P90 延迟。

使用时间 OpenSearch 服务，使用“cwl*”作为搜索的筛选器模式 OpenSearch 索引。 OpenSearch 服务为流式传输的日志编制索引 CloudWatch 前缀为的日志“cwl-”. 为了区分Amazon AppSync 来自其他 API 日志 CloudWatch 发送到的日志 OpenSearch 服务，我们建议添加额外的过滤器表达式graphQLAPIID.keyword=YourGraphQLAPIID到你的搜索中。

日志格式迁移

记录事件Amazon AppSync 在 2019 年 5 月 8 日或之后生成的生成的格式为完全结构化的 JSON。要在 2019 年 5 月 8 日之前分析 GraphQL 请求，您可以使用GitHub 示例. 如果需要在 2019 年 5 月 8 日之前使用日志格式，请使用以下设置创建支持服务单：将 Type (类型) 设置为 Account Management (账户管理)，然后将 Category (类别) 设置为 General Account Question (一般账户问题)。

您还可以使用指标筛选器在 CloudWatch 将日志数据转换为数字 CloudWatch 指标，以便对它们生成图表或设置警报。