导出配置以获得支持Amazon Web Services 云目的地 - Amazon IoT Greengrass
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

导出配置以获得支持Amazon Web Services 云目的地

用户定义的 Greengrass 组件StreamManagerClient在流管理器 SDK 中与流管理器交互。当组件创建流要么更新流,它通过了MessageStreamDefinition表示流属性,包括导出定义的对象。这些区域有:ExportDefinition对象包含为流定义的导出配置。Stream Manager 使用这些导出配置来确定导出流的位置和方式。


      的对象模型图 ExportDefinition 属性类型。

您可以在一个流上定义零个或多个导出配置,包括单个目标类型的多个导出配置。例如,您可以将流导出到两个Amazon IoT Analytics频道和一个 Kinesis 数据流。

对于失败的导出尝试,直播管理器会不断重试将数据导出到Amazon Web Services 云每隔最多五分钟。重试次数没有最大限制。

注意

StreamManagerClient还提供了一个可用于将流导出到 HTTP 服务器的目标目标。此目标仅用于测试目的。它不稳定或支持在生产环境中使用。

你有责任维护这些Amazon Web Services 云资源的费用。

Amazon IoT Analytics 通道

直播管理器支持自动导出到Amazon IoT Analytics.Amazon IoT Analytics允许您对数据执行高级分析,以帮助做出业务决策并改进机器学习模型。有关更多信息,请参阅 。是什么Amazon IoT Analytics?中的Amazon IoT Analytics用户指南.

在 Stream Manager SDK 中,您的 Greengrass 组件使用IoTAnalyticsConfig定义此目标类型的导出配置。有关更多信息,请参阅适用于您的目标语言的 SDK 参考:

要求

此出口目的地具有以下要求:

  • 目标频道Amazon IoT Analytics均必须位于同一位置Amazon Web Services 账户和Amazon Web Services 区域作为 Greengrass 核心设备。

  • 这些区域有:授权核心设备与Amazon服务必须允许iotanalytics:BatchPutMessage目标频道的权限。例如:

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iotanalytics:BatchPutMessage" ], "Resource": [ "arn:aws:iotanalytics:region:account-id:channel/channel_1_name", "arn:aws:iotanalytics:region:account-id:channel/channel_2_name" ] } ] }

    例如,您可以通过使用通配符授予对资源的具体或条件访问权限。*命名方案。有关更多信息,请参阅 。添加和删除 IAM 策略中的IAM 用户指南.

导出到 Amazon IoT Analytics

创建导出到的流Amazon IoT Analytics,您的 Greengrass 组件创建流具有包含一个或多个的导出定义IoTAnalyticsConfig对象。此对象定义导出设置,例如目标渠道、批量大小、批处理间隔和优先级。

当你的 Greengrass 组件从设备接收数据时,它们附加消息其中包含到目标流的一组数据。

然后,流媒体管理器根据流的导出配置中定义的批处理设置和优先级导出数据。

Amazon Kinesis 数据流

流管理器支持将自动导出到 Amazon Kinesis Data Streams。Kinesis Data Streams 常用于聚合大容量数据并将其加载到数据仓库中或 MapReduce 集群。有关更多信息,请参阅 。什么是 Amazon Kinesis Data Streams?中的Amazon Kinesis 开发人员指南.

在 Stream Manager SDK 中,您的 Greengrass 组件使用KinesisConfig定义此目标类型的导出配置。有关更多信息,请参阅适用于您的目标语言的 SDK 参考:

要求

此出口目的地具有以下要求:

  • Kinesis Data Streams 中的目标流必须位于相同位置Amazon Web Services 账户和Amazon Web Services 区域作为 Greengrass 核心设备。

  • 这些区域有:授权核心设备与Amazon服务必须允许kinesis:PutRecords目标数据流的权限。例如:

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "kinesis:PutRecords" ], "Resource": [ "arn:aws:kinesis:region:account-id:stream/stream_1_name", "arn:aws:kinesis:region:account-id:stream/stream_2_name" ] } ] }

    例如,您可以通过使用通配符授予对资源的具体或条件访问权限。*命名方案。有关更多信息,请参阅 。添加和删除 IAM 策略中的IAM 用户指南.

导出到 Kinesis Data Streams

要创建导出到 Kinesis Data Streams 的流,您的 Greengrass 组件创建流具有包含一个或多个的导出定义KinesisConfig对象。此对象定义导出设置,例如目标数据流、批量大小、批处理间隔和优先级。

当你的 Greengrass 组件从设备接收数据时,它们附加消息其中包含到目标流的一组数据。然后,流媒体管理器根据流的导出配置中定义的批处理设置和优先级导出数据。

直播管理器为上传到 Amazon Kinesis 的每条记录生成一个唯一的随机 UUID 作为分区密钥。

Amazon IoT SiteWise资产属性

直播管理器支持自动导出到Amazon IoT SiteWise.Amazon IoT SiteWise借助,您可以从工业设备中大规模收集、组织和分析数据。有关更多信息,请参阅 。是什么Amazon IoT SiteWise?中的Amazon IoT SiteWise用户指南.

在 Stream Manager SDK 中,您的 Greengrass 组件使用IoTSiteWiseConfig定义此目标类型的导出配置。有关更多信息,请参阅适用于您的目标语言的 SDK 参考:

注意

Amazon还提供Amazon IoT SiteWise组件,它提供了一个预构建的解决方案,您可以使用该解决方案来流处理 OPC-UA 源的数据 有关更多信息,请参阅 IoT SiteWise OPC-UA 收集器

要求

此出口目的地具有以下要求:

  • 中的目标资产属性Amazon IoT SiteWise均必须位于同一位置Amazon Web Services 账户和Amazon Web Services 区域作为 Greengrass 核心设备。

    注意

    列表Amazon Web Services 区域是的Amazon IoT SiteWise支持,请参阅Amazon IoT SiteWise终端节点和配额中的Amazon一般参考.

  • 这些区域有:授权核心设备与Amazon服务必须允许iotsitewise:BatchPutAssetPropertyValue目标资产属性的权限。以下示例策略使用iotsitewise:assetHierarchyPath为目标根资产及其子级授予访问权限。你可以删除Condition从策略中允许访问您的所有Amazon IoT SiteWise资产或指定单个资产的 ARN。

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iotsitewise:BatchPutAssetPropertyValue", "Resource": "*", "Condition": { "StringLike": { "iotsitewise:assetHierarchyPath": [ "/root node asset ID", "/root node asset ID/*" ] } } } ] }

    例如,您可以通过使用通配符授予对资源的具体或条件访问权限。*命名方案。有关更多信息,请参阅 。添加和删除 IAM 策略中的IAM 用户指南.

    有关重要的安全信息,请参阅 BatchPutAssetPropertyValue 授权中的Amazon IoT SiteWise用户指南.

导出到 Amazon IoT SiteWise

创建导出到的流Amazon IoT SiteWise,您的 Greengrass 组件创建流具有包含一个或多个的导出定义IoTSiteWiseConfig对象。此对象定义导出设置,例如批处理大小、批次间隔和优先级。

当您的 Greengrass 组件从设备接收资产属性数据时,它们会将包含该数据的消息附加到目标流。消息是 JSON 序列化的PutAssetPropertyValueEntry包含一个或多个资产属性的属性值的对象。有关更多信息,请参阅 。附加消息为了Amazon IoT SiteWise出口目标。

注意

将数据发送给Amazon IoT SiteWise,您的数据必须满足BatchPutAssetPropertyValueaction. 有关更多信息,请参阅 Amazon IoT SiteWise API 参考中的 BatchPutAssetPropertyValue

然后,流媒体管理器根据流的导出配置中定义的批处理设置和优先级导出数据。

您可以调整直播管理器设置和 Greengrass 组件逻辑来设计导出策略。例如:

  • 对于接近实时的导出,请设置较低的批量大小和间隔设置,然后在收到数据时将数据附加到流。

  • 为了优化批处理、缓解带宽限制或最大限度地降低成本,您的 Greengrass 组件可以将 timestamp-quality-value (TQV) 在将数据追加到直播之前,为单个资产属性收到的数据点。一种策略是在一条消息中批量输入最多 10 种不同的财产-资产组合或属性别名,而不是为同一属性发送多个条目。这有助于直播管理器留在内部Amazon IoT SiteWise配额.

Amazon S3 对象

流管理器支持将自动导出到 Amazon S3。您可以使用 Amazon S3 存储和检索大量数据。有关更多信息,请参阅 。什么是 Amazon S3?中的Amazon Simple Storage Service 开发人员指南.

在 Stream Manager SDK 中,您的 Greengrass 组件使用S3ExportTaskExecutorConfig定义此目标类型的导出配置。有关更多信息,请参阅适用于您的目标语言的 SDK 参考:

要求

此出口目的地具有以下要求:

  • 目标 Amazon S3 存储桶必须位于同一个位置Amazon Web Services 账户作为 Greengrass 核心设备。

  • 如果运行在中的 Lambda 函数Greengrass 容器模式将输入文件写入到输入文件目录中,必须将该目录作为具有写入权限的卷挂载到容器中。这可确保将文件写入根文件系统并对在容器之外运行的流管理器组件可见。

  • 如果 Docker 容器组件将输入文件写入到输入文件目录,则必须将该目录作为具有写入权限的容器中的卷挂载。这可确保将文件写入根文件系统并对在容器之外运行的流管理器组件可见。

  • 这些区域有:授权核心设备与Amazon服务必须允许对目标存储桶拥有以下权限。例如:

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:PutObject", "s3:AbortMultipartUpload", "s3:ListMultipartUploadParts" ], "Resource": [ "arn:aws:s3:::bucket-1-name/*", "arn:aws:s3:::bucket-2-name/*" ] } ] }

    例如,您可以通过使用通配符授予对资源的具体或条件访问权限。*命名方案。有关更多信息,请参阅 。添加和删除 IAM 策略中的IAM 用户指南.

导出到 Amazon S3

要创建导出到 Amazon S3 的直播,您的 Greengrass 组件使用S3ExportTaskExecutorConfig对象来配置导出策略。该策略定义了导出设置,例如分段上传阈值和优先级。对于 Amazon S3 导出,流管理器会上传从核心设备上的本地文件中读取的数据。要启动上传,您的 Greengrass 组件将导出任务追加到目标流。导出任务包含有关输入文件和目标 Amazon S3 对象的信息。直播管理器按照附加到直播的顺序运行任务。

注意

您的目标存储桶必须已存在于Amazon Web Services 账户. 如果指定密钥的对象不存在,则流管理器会为您创建对象。

直播管理器使用分段上传阈值属性,最小分段大小设置和输入文件的大小,以确定如何上传数据。分段上传阈值必须大于或等于最小分段大小。如果要 parallel 上传数据,您可以创建多个流。

指定目标 Amazon S3 对象的密钥可以包含有效的Java DateTimeFormatter中的字符串!{timestamp:value}占位符。您可以使用这些时间戳占位符根据输入文件数据的上传时间对 Amazon S3 中的数据进行分区。例如,以下键名称解析为一个值,例如my-key/2020/12/31/data.txt.

my-key/!{timestamp:YYYY}/!{timestamp:MM}/!{timestamp:dd}/data.txt
注意

如果要监控流的导出状态,请先创建状态流,然后将导出流配置为使用它。有关更多信息,请参阅 监控导出任务

管理输入数据

您可以创作代码,IoT 应用程序用于管理输入数据的生命周期。以下示例工作流说明了如何使用 Greengrass 组件管理此数据。

  1. 本地进程从设备或外围设备接收数据,然后将数据写入核心设备目录中的文件。这些是直播管理器的输入文件。

  2. Greengrass 组件扫描目录并附加导出任务创建新文件时转到目标流。任务是 JSON 序列化S3ExportTaskDefinition对象,指定输入文件的 URL、目标 Amazon S3 存储桶和密钥以及可选的用户元数据。

  3. 流管理器读取输入文件并按附加任务的顺序将数据导出到 Amazon S3。您的目标存储桶必须已存在于Amazon Web Services 账户. 如果指定密钥的对象不存在,则流管理器会为您创建对象。

  4. Greengrass 组件读取消息从状态流来监视导出状态。导出任务完成后,Greengrass 组件可以删除相应的输入文件。有关更多信息,请参阅 监控导出任务

监控导出任务

您可以创建代码,让 IoT 应用程序用于监控 Amazon S3 导出状态。您的 Greengrass 组件必须创建状态流,然后将导出流配置为将状态更新写入状态流。单个状态流可以从导出到 Amazon S3 的多个流中接收状态更新。

首先,创建流用作状态流。您可以配置流的大小和保留策略以控制状态消息的使用寿命。例如:

  • SetPersistenceMemory如果不想存储状态消息。

  • SetStrategyOnFullOverwriteOldestData以便不会丢失新的状态消息。

然后,创建或更新导出流以使用状态流。具体来说,设置直播的状态配置属性S3ExportTaskExecutorConfig导出配置。此设置告诉流管理器将有关导出任务的状态消息写入状态流。在StatusConfig对象中,指定状态流的名称和详细程度级别。以下支持的值范围从最小的详细程度(ERROR) 到最详细的 (TRACE)。默认为 INFO

  • ERROR

  • WARN

  • INFO

  • DEBUG

  • TRACE

以下示例工作流显示了 Greengrass 组件如何使用状态流监控导出状态。

  1. 如上一个工作流程中所述,Greengrass 组件附加导出任务到配置为向状态流写入有关导出任务的状态消息的流。追加操作返回表示任务 ID 的序列号。

  2. Greengrass 组件读取消息按顺序从状态流中进行,然后根据流名称和任务 ID 或根据消息上下文中的导出任务属性过滤消息。例如,Greengrass 组件可以按导出任务的输入文件 URL 进行筛选,该 URL 由S3ExportTaskDefinition消息上下文中的对象。

    以下状态代码表示导出任务已达到已完成状态:

    • Success. 已成功完成上传。

    • Failure. 流管理器遇到错误,例如,指定的存储桶不存在。解决问题后,你可以再次将导出任务追加到直播。

    • Canceled. 该任务已停止,原因是流或导出定义已删除,或者 time-to-live (TTL) 任务期限已过期。

    注意

    该任务的状态也可能为InProgress要么Warning. 当事件返回不影响任务执行的错误时,Stream Manager 会发出警告。例如,未能清理部分上传将返回警告。

  3. 导出任务完成后,Greengrass 组件可以删除相应的输入文件。

以下示例说明 Greengrass 组件如何读取和处理状态消息。

Python
import time from stream_manager import ( ReadMessagesOptions, Status, StatusConfig, StatusLevel, StatusMessage, StreamManagerClient, ) from stream_manager.util import Util client = StreamManagerClient() try: # Read the statuses from the export status stream is_file_uploaded_to_s3 = False while not is_file_uploaded_to_s3: try: messages_list = client.read_messages( "StatusStreamName", ReadMessagesOptions(min_message_count=1, read_timeout_millis=1000) ) for message in messages_list: # Deserialize the status message first. status_message = Util.deserialize_json_bytes_to_obj(message.payload, StatusMessage) # Check the status of the status message. If the status is "Success", # the file was successfully uploaded to S3. # If the status was either "Failure" or "Cancelled", the server was unable to upload the file to S3. # We will print the message for why the upload to S3 failed from the status message. # If the status was "InProgress", the status indicates that the server has started uploading # the S3 task. if status_message.status == Status.Success: logger.info("Successfully uploaded file at path " + file_url + " to S3.") is_file_uploaded_to_s3 = True elif status_message.status == Status.Failure or status_message.status == Status.Canceled: logger.info( "Unable to upload file at path " + file_url + " to S3. Message: " + status_message.message ) is_file_uploaded_to_s3 = True time.sleep(5) except StreamManagerException: logger.exception("Exception while running") except StreamManagerException: pass # Properly handle errors. except ConnectionError or asyncio.TimeoutError: pass # Properly handle errors.

Python 开发工具包参考:read_messages|StatusMessage

Java
import com.amazonaws.greengrass.streammanager.client.StreamManagerClient; import com.amazonaws.greengrass.streammanager.client.StreamManagerClientFactory; import com.amazonaws.greengrass.streammanager.client.utils.ValidateAndSerialize; import com.amazonaws.greengrass.streammanager.model.ReadMessagesOptions; import com.amazonaws.greengrass.streammanager.model.Status; import com.amazonaws.greengrass.streammanager.model.StatusConfig; import com.amazonaws.greengrass.streammanager.model.StatusLevel; import com.amazonaws.greengrass.streammanager.model.StatusMessage; try (final StreamManagerClient client = StreamManagerClientFactory.standard().build()) { try { boolean isS3UploadComplete = false; while (!isS3UploadComplete) { try { // Read the statuses from the export status stream List<Message> messages = client.readMessages("StatusStreamName", new ReadMessagesOptions().withMinMessageCount(1L).withReadTimeoutMillis(1000L)); for (Message message : messages) { // Deserialize the status message first. StatusMessage statusMessage = ValidateAndSerialize.deserializeJsonBytesToObj(message.getPayload(), StatusMessage.class); // Check the status of the status message. If the status is "Success", the file was successfully uploaded to S3. // If the status was either "Failure" or "Canceled", the server was unable to upload the file to S3. // We will print the message for why the upload to S3 failed from the status message. // If the status was "InProgress", the status indicates that the server has started uploading the S3 task. if (Status.Success.equals(statusMessage.getStatus())) { System.out.println("Successfully uploaded file at path " + FILE_URL + " to S3."); isS3UploadComplete = true; } else if (Status.Failure.equals(statusMessage.getStatus()) || Status.Canceled.equals(statusMessage.getStatus())) { System.out.println(String.format("Unable to upload file at path %s to S3. Message %s", statusMessage.getStatusContext().getS3ExportTaskDefinition().getInputUrl(), statusMessage.getMessage())); sS3UploadComplete = true; } } } catch (StreamManagerException ignored) { } finally { // Sleep for sometime for the S3 upload task to complete before trying to read the status message. Thread.sleep(5000); } } catch (e) { // Properly handle errors. } } catch (StreamManagerException e) { // Properly handle exception. }

Java 开发工具包参考:readMessages|StatusMessage

Node.js
const { StreamManagerClient, ReadMessagesOptions, Status, StatusConfig, StatusLevel, StatusMessage, util, } = require(*'aws-greengrass-stream-manager-sdk'*); const client = new StreamManagerClient(); client.onConnected(async () => { try { let isS3UploadComplete = false; while (!isS3UploadComplete) { try { // Read the statuses from the export status stream const messages = await c.readMessages("StatusStreamName", new ReadMessagesOptions() .withMinMessageCount(1) .withReadTimeoutMillis(1000)); messages.forEach((message) => { // Deserialize the status message first. const statusMessage = util.deserializeJsonBytesToObj(message.payload, StatusMessage); // Check the status of the status message. If the status is 'Success', the file was successfully uploaded to S3. // If the status was either 'Failure' or 'Cancelled', the server was unable to upload the file to S3. // We will print the message for why the upload to S3 failed from the status message. // If the status was "InProgress", the status indicates that the server has started uploading the S3 task. if (statusMessage.status === Status.Success) { console.log(`Successfully uploaded file at path ${FILE_URL} to S3.`); isS3UploadComplete = true; } else if (statusMessage.status === Status.Failure || statusMessage.status === Status.Canceled) { console.log(`Unable to upload file at path ${FILE_URL} to S3. Message: ${statusMessage.message}`); isS3UploadComplete = true; } }); // Sleep for sometime for the S3 upload task to complete before trying to read the status message. await new Promise((r) => setTimeout(r, 5000)); } catch (e) { // Ignored } } catch (e) { // Properly handle errors. } }); client.onError((err) => { // Properly handle connection errors. // This is called only when the connection to the StreamManager server fails. });

Node.js 开发工具包参考:readMessages|StatusMessage