本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
启用 CloudWatch 日志
Hub SDK 提供全面的日志记录功能。默认情况下,Hub SDK 会将日志写入本地文件系统。但是,您可以利用云 API 将日志流配置为 CloudWatch 日志,它提供:
-
监控设备性能:捕获详细的运行时日志,进行主动设备管理。在您的设备群中启用高级日志分析和监控
-
故障排除:生成精细的日志条目以进行快速诊断分析。记录系统和应用程序级事件以进行深入调查。
-
灵活而集中的日志记录:无需直接访问设备即可进行远程日志管理。将来自多个设备的日志聚合到一个可搜索的存储库中。
先决条件
-
将受管设备载入云端。有关详细信息,请参阅Hub 入职设置。
-
验证 Hub 代理已启动并成功初始化。有关详细信息,请参阅安装并验证托管集成 Hub SDK。
注意
要创建日志配置,详情请参阅 PutRuntimeLogConfiguration API。
警告
启用日志计入分层配额计量。增加日志级别将导致更高的消息量和额外的成本。
设置 Hub SDK 日志配置
通过调用 API 来设置运行时日志配置,配置 Hub SDK 日志设置。
例 API 请求示例
aws iot-managed-integrations put-runtime-log-configuration \ --managed-thing-id MANAGED_THING_ID \ --runtime-log-configurations LogLevel=DEBUG,UploadLog=TRUE
RuntimeLogConfigurations 属性
以下属性是可选的,可以在 RuntimeLogConfigurations
API 中进行配置。
- LogLevel
-
设置运行时跟踪的最低严重性级别。值:
DEBUG, ERROR, INFO, WARN
默认:
WARN
(已发布版本) - LogFlushLevel
-
确定立即将数据刷新到本地存储的严重性级别。值:
DEBUG, ERROR, INFO, WARN
默认值:
DISABLED
- LocalStoreLocation
-
指定运行时跟踪的存储位置。默认值:
/var/log/awsiotmi
-
活动日志:
/var/log/awsiotmi/ManagedIntegrationsDeviceSdkHub.log
-
轮换日志:
/var/log/awsiotmi/ManagedIntegrationsDeviceSdkHub.N.log
(N 表示轮换顺序)
-
- LocalStoreFileRotationMaxBytes
-
当当前文件超过指定大小时触发文件轮换。
重要
为了获得最佳效率,请将文件大小保持在 125 KB 以下。将自动限制大于 125 KB 的值。
- LocalStoreFileRotationMaxFiles,
-
设置日志守护程序允许的最大轮换文件数。
- UploadLog
-
控制将运行时跟踪传输到云端。日志存储在
/aws/iotmanagedintegration
CloudWatch 日志组中。默认值:
false
。 - UploadPeriodMinutes
-
定义运行时跟踪上传的频率。默认值:
5
- DeleteLocalStoreAfterUpload
-
控制上传后的文件删除。默认值:
true
注意
如果设置为 false,则上传的文件将重命名为:
/var/log/awsiotmi/ManagedIntegrationsDeviceSdkHub.uploaded.{uploaded_timestamp}
示例日志文件
参见下面的 CloudWatch 日志文件示例:
