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

创建自定义数据来源连接器。

要将自定义数据来源连接到 CloudWatch，可使用两种方法：

使用模板

使用模板可以创建示例 Lambda 函数，并帮助您更快地构建自定义连接器。这些示例函数提供了示例代码，可用于涉及构建自定义连接器的许多常见场景。在使用模板创建连接器后，您可以检查 Lambda 代码，然后对其进行修改以用于连接数据来源。

此外，如果使用该模板，CloudWatch 会负责创建 Lambda 权限策略并将资源标签附加到 Lambda 函数。

从头开始创建自定义数据来源

按照本节中的步骤创建 Lambda 函数，该函数会将 CloudWatch 连接到数据来源。

步骤 1：创建函数

自定义数据来源连接器必须支持来自 CloudWatch 的 GetMetricData 事件。您也可以实施 DescribeGetMetricData 活动，以便在 CloudWatch 控制台中向用户提供有关如何使用连接器的文档。DescribeGetMetricData 响应还可用于设置 CloudWatch 自定义查询构建器中使用的默认值。

CloudWatch 提供了代码段示例，以帮助您开始使用。有关更多信息，请参阅 https://github.com/aws-samples/cloudwatch-data-source-samples 上的示例存储库。

约束

GetMetricData 事件

请求负载

以下是作为输入发送到 Lambda 函数的 GetMetricData 请求负载示例。

{
  "EventType": "GetMetricData",
  "GetMetricDataRequest": {
    "StartTime": 1697060700,
    "EndTime": 1697061600,
    "Period": 300,
    "Arguments": ["serviceregistry_external_http_requests{host_cluster!=\"prod\"}"] 
  }
}

响应负载

以下是 Lambda 函数返回的 GetMetricData 响应负载的示例。

{
   "MetricDataResults": [
      {
         "StatusCode": "Complete",
         "Label": "CPUUtilization",
         "Timestamps": [ 1697060700, 1697061000, 1697061300 ],
         "Values": [ 15000, 14000, 16000 ]
      }
   ]
}

该响应负载将包含 MetricDataResults 字段或 Error 字段，但无法同时包含二者。

MetricDataResults 字段是 MetricDataResult 类型的时间序列字段列表。每个时间序列字段可包括以下字段。

有关 Error 对象的更多信息，请参阅以下部分。

错误响应格式

您可以选择使用错误响应来提供有关错误的更多信息。当发生验证错误时（例如缺少参数或参数类型错误），我们建议您使用代码验证返回错误。

以下是 Lambda 函数要引发 GetMetricData 验证异常时的响应示例。

{
   "Error": {
      "Code": "Validation",
      "Value": "Invalid Prometheus cluster"
   }
}

以下是 Lambda 函数表示由于访问问题而无法返回数据时的响应示例。响应被转换为单个时间序列，其状态代码为 Forbidden。

{
   "Error": {
      "Code": "Forbidden",
      "Value": "Unable to access ..."
   }
}

以下是 Lambda 函数引发整体 InternalError 异常的示例，该异常被转换为单个时间序列，其状态代码为 InternalError 并具有一条消息。只要错误代码的值不是 Validation 或 Forbidden，CloudWatch 都会认为这属于常规内部错误。

{
   "Error": {
      "Code": "PrometheusClusterUnreachable",
      "Value": "Unable to communicate with the cluster"
   }
}

DescribeGetMetricData 事件

请求负载

以下是 DescribeGetMetricData 请求负载的示例。

{
  "EventType": "DescribeGetMetricData"
}

响应负载

以下是 DescribeGetMetricData 响应负载的示例。

{
    "Description": "Data source connector",
    "ArgumentDefaults": [{
        Value: "default value"
     }]
}

CloudWatch 警报的重要注意事项

如果要使用数据来源来设置 CloudWatch 警报，则应将其设置为每分钟向 CloudWatch 报告带有时间戳的数据。有关为源自已连接的数据来源的指标创建警报的更多信息和其他注意事项，请参阅 基于连接的数据来源创建警报。

（可选）使用 Amazon Secrets Manager 存储凭证

如果您的 Lambda 函数需要使用凭证来访问数据来源，我们建议使用 Amazon Secrets Manager 来存储这些凭证，而不是将其硬编码到您的 Lambda 函数中。有关结合使用 Amazon Secrets Manager 和 Lambda 函数的更多信息，请参阅在 Amazon Lambda 函数中使用 Amazon Secrets Manager 密钥。

（可选）连接到 VPC 中的数据来源

如果数据来源位于由 Amazon Virtual Private Cloud 管理的 VPC 中，则必须配置您的 Lambda 函数才能对其进行访问。有关更多信息，请参阅将出站联网连接到 VPC 中的资源。

您可能还需要配置 VPC 服务端点才能访问 Amazon Secrets Manager 等服务。有关更多信息，请参阅使用接口 VPC 端点访问 Amazon 服务。

步骤 2：创建 Lambda 权限策略

您必须创建策略语句，授予 CloudWatch 使用您创建的 Lambda 函数的权限。您可以使用 Amazon CLI 或 Lambda 控制台创建该策略语句。

步骤 3：将资源标签附加到 Lambda 函数

CloudWatch 控制台通过使用标签来确定哪些 Lambda 函数是数据来源连接器。使用其中一个向导创建数据来源时，配置该标签的 Amazon CloudFormation 堆栈会自动应用该标签。当您自己创建数据来源时，可以将以下标签用于您的 Lambda 函数。这样一来，当您查询指标时，您的连接器就会显示在 CloudWatch 控制台的数据来源下拉列表中。