使用 Amazon IoT Greengrass V2 记录 Amazon CloudTrail API 调用 - Amazon IoT Greengrass
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

使用 Amazon IoT Greengrass V2 记录 Amazon CloudTrail API 调用

Amazon IoT Greengrass V2 与 Amazon CloudTrail 集成,后者是在 Amazon 中记录用户、角色或 Amazon IoT Greengrass Version 2 服务所执行操作的服务。CloudTrail 将 Amazon IoT Greengrass 的所有 API 调用作为事件捕获。捕获的调用包括来自 Amazon IoT Greengrass 控制台的调用和对 Amazon IoT Greengrass API 操作的代码调用。

如果您创建跟踪记录,则可以使 CloudTrail 事件持续传送到 S3 存储桶(包括 Amazon IoT Greengrass 的事件)。如果您不配置跟踪记录,则仍可在 CloudTrail 控制台中的 事件历史记录 中查看最新事件。使用 CloudTrail 收集的信息,您可以确定向 Amazon IoT Greengrass 发出了什么请求、发出请求的 IP 地址、何人发出的请求、请求的发出时间以及其他详细信息。

有关 CloudTrail 的更多信息,请参阅《Amazon CloudTrail 用户指南》https://docs.amazonaws.cn/awscloudtrail/latest/userguide/cloudtrail-user-guide.html

Amazon IoT Greengrass V2CloudTrail 中的 信息

在您创建 Amazon Web Services 账户时,将在该账户上启用 CloudTrail。当 Amazon IoT Greengrass 中发生活动时,该活动将记录在 CloudTrail 事件中,并与其他 Amazon 服务事件一同保存在 Event history(事件历史记录)中。您可以在 Amazon Web Services 账户 中查看、搜索和下载最新事件。有关更多信息,请参阅 Viewing events with CloudTrail Event history

对于 Amazon Web Services 账户中的事件的持续记录(包括 Amazon IoT Greengrass 的事件),请创建跟踪记录。通过跟踪记录,CloudTrail 可将日志文件传送至 S3 存储桶。默认情况下,在控制台中创建跟踪记录时,此跟踪记录应用于所有Amazon Web Services 区域。跟踪记录 Amazon 分区所有区域的事件,将日志文件传送至指定的 S3 存储桶。此外,您可以配置其他Amazon服务,进一步分析在 CloudTrail 日志中收集的事件数据并采取行动。有关更多信息,请参阅下列内容:

CloudTrail 记录所有 Amazon IoT Greengrass V2 操作,Amazon IoT Greengrass V2 API 参考中介绍了这些操作。例如,对 CreateComponentVersionCreateDeploymentCancelDeployment 操作的调用会在 CloudTrail 日志文件中生成条目。

每个事件或日志条目都包含有关生成请求的人员信息。身份信息可帮助您确定以下内容:

  • 请求是使用根用户凭证还是 Amazon Identity and Access Management(IAM)用户凭证发出的。

  • 请求是使用角色还是联合用户的临时安全凭证发出的。

  • 请求是否由其他 Amazon 服务发出。

有关更多信息,请参阅 CloudTrail userIdentity 元素

CloudTrail 中的 Amazon IoT Greengrass 数据事件

数据事件提供有关对资源或在资源中执行的资源操作(例如,获取组件版本或部署配置)的信息。这些也称为数据层面操作。数据事件通常是高容量活动。默认情况下,CloudTrail 不记录数据事件。CloudTrail 事件历史记录不记录数据事件。

记录数据事件将收取额外费用。有关 CloudTrail 定价的更多信息,请参阅 Amazon CloudTrail 定价

可以使用 CloudTrail 控制台、Amazon CLI 或 CloudTrail API 操作来记录 Amazon IoT Greengrass 资源类型的数据事件。本节中的显示了 Amazon IoT Greengrass 可用的资源类型。

  • 要使用 CloudTrail 控制台记录数据事件,请创建跟踪事件数据存储来记录数据事件,或更新现有的跟踪或事件数据存储来记录数据事件。

    1. 选择数据事件来记录数据事件。

    2. 数据事件类型列表中,选择要对其记录数据事件的资源类型。

    3. 选择要使用的记录选择器模板。可以记录资源类型的所有数据事件、记录所有 readOnly 事件、记录所有 writeOnly 事件,或者创建自定义记录选择器模板来根据 readOnlyeventNameresources.ARN 字段进行筛选。

  • 要使用 Amazon CLI 记录数据事件,请配置 --advanced-event-selectors 参数,以便将 eventCategory 字段设置为等于 Data,并将 resources.type 字段设置为等于资源类型值(请参阅)。可以添加条件来根据 readOnlyeventNameresources.ARN 字段的值进行筛选。

下表列出了 Amazon IoT Greengrass 资源类型。数据事件类型(控制台)列显示可从 CloudTrail 控制台上的数据事件类型列表中选择的值。resources.type 值列显示了您在使用 Amazon CLI 或 CloudTrail API 配置高级事件选择器时需要指定的 resources.type 值。记录到 CloudTrail 的数据 API 列显示了针对该资源类型记录到 CloudTrail 的 API 调用。

数据事件类型(控制台) resources.type 值 记录至 CloudTrail 的数据 API
IoT 证书 AWS::IoT::Certificate
  • VerifyClientDeviceIdentity

  • VerifyClientDeviceIoTCertificateAssociation

IoT Greengrass 组件版本 AWS::GreengrassV2::ComponentVersion
IoT Greengrass 部署 AWS::GreengrassV2::Deployment
  • GetDeploymentConfiguration

IoT 事物 AWS::IoT::Thing
  • ListThingGroupsForCoreDevices

  • PutCertificateAuthorities

  • VerifyClientDeviceIoTCertificateAssociation

您可以将高级事件选择器配置为在 eventNamereadOnlyresources.ARN 字段上进行筛选,从而仅记录那些对您很重要的事件。

添加 eventName 筛选条件以包含或排除特定数据 API。

有关这些字段的更多信息,请参阅。AdvancedFieldSelector

以下示例演示如何使用 Amazon CLI 来配置高级选择器。将 TrailNameregion 替换为您自己的信息。

例 – 记录 IoT 事物的数据事件
aws cloudtrail put-event-selectors --trail-name TrailName --region region \ --advanced-event-selectors \ ‘[ { “Name”: “Log all thing data events”, “FieldSelectors”: [ { “Field”: “eventCategory”, “Equals”: [“Data”] }, { “Field”: “resources.type”, “Equals”: [“AWS::IoT::Thing”] } ] } ]’
例 – 筛选特定 IoT 事物 API
aws cloudtrail put-event-selectors --trail-name TrailName --region region \ --advanced-event-selectors \ ‘[ { “Name”: “Log IoT Greengrass PutCertificateAuthorities API calls”, “FieldSelectors”: [ { “Field”: “eventCategory”, “Equals”: [“Data”] }, { “Field”: “resources.type”, “Equals”: [“AWS::IoT::Thing”] }, { “Field”: “eventName”, “Equals”: [“PutCertificateAuthorities”] } ] } ]’
例 – 记录所有 Greengrass 数据事件
aws cloudtrail put-event-selectors --trail-name TrailName --region region \ --advanced-event-selectors \ ‘[ { “Name”: “Log all certificate data events”, “FieldSelectors”: [ { “Field”: “eventCategory”, “Equals”: [ “Data” ] }, { “Field”: “resources.type”, “Equals”: [ “AWS::IoT::Certificate” ] } ] }, { “Name”: “Log all component version data events”, “FieldSelectors”: [ { “Field”: “eventCategory”, “Equals”: [ “Data” ] }, { “Field”: “resources.type”, “Equals”: [ “AWS::GreengrassV2::ComponentVersion” ] } ] }, { “Name”: “Log all deployment version”, “FieldSelectors”: [ { “Field”: “eventCategory”, “Equals”: [ “Data” ] }, { “Field”: “resources.type”, “Equals”: [ “AWS::GreengrassV2::Deployment” ] } ] }, { “Name”: “Log all thing data events”, “FieldSelectors”: [ { “Field”: “eventCategory”, “Equals”: [ “Data” ] }, { “Field”: “resources.type”, “Equals”: [ “AWS::IoT::Thing” ] } ] } ]’

CloudTrail 中的 Amazon IoT Greengrass 管理事件

管理事件提供对您 Amazon 账户内的资源所执行管理操作的相关信息。这些也称为控制面板操作。默认情况下,CloudTrail 会记录管理事件。

Amazon IoT Greengrass 将所有 Amazon IoT Greengrass 控制面板操作记录为管理事件。有关 Amazon IoT Greengrass 记录到 CloudTrail 的 Amazon IoT Greengrass 控制面板操作的列表,请参阅 Amazon IoT Greengrass API 参考,第 2 版

了解 Amazon IoT Greengrass V2 日志文件条目

跟踪记录是一种配置,可用于将事件作为日志文件传送到您指定的 S3 存储桶。CloudTrail 日志文件包含一个或多个日志条目。事件表示来自任何源的单个请求。它包括有关所请求操作的信息、操作的日期和时间、请求参数等。CloudTrail 日志文件不是公用 API 调用的有序堆栈跟踪,因此它们不会按任何具体顺序显示。

下面的示例显示了一个 CloudTrail 日志条目,该条目说明了 CreateDeployment 操作。

{ "eventVersion": "1.08", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::123456789012:user/Administrator", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "Administrator" }, "eventTime": "2021-01-06T02:38:05Z", "eventSource": "greengrass.amazonaws.com", "eventName": "CreateDeployment", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.0", "userAgent": "aws-cli/2.1.9 Python/3.7.9 Windows/10 exe/AMD64 prompt/off command/greengrassv2.create-deployment", "requestParameters": { "deploymentPolicies": { "failureHandlingPolicy": "DO_NOTHING", "componentUpdatePolicy": { "timeoutInSeconds": 60, "action": "NOTIFY_COMPONENTS" }, "configurationValidationPolicy": { "timeoutInSeconds": 60 } }, "deploymentName": "Deployment for MyGreengrassCoreGroup", "components": { "aws.greengrass.Cli": { "componentVersion": "2.0.3" } }, "iotJobConfiguration": {}, "targetArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/MyGreengrassCoreGroup" }, "responseElements": { "iotJobArn": "arn:aws:iot:us-west-2:123456789012:job/fdfeba1d-ac6d-44ef-ab28-54f684ea578d", "iotJobId": "fdfeba1d-ac6d-44ef-ab28-54f684ea578d", "deploymentId": "4196dddc-0a21-4c54-a985-66a525f6946e" }, "requestID": "311b9529-4aad-42ac-8408-c06c6fec79a9", "eventID": "c0f3aa2c-af22-48c1-8161-bad4a2ab1841", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "123456789012" }