ESP Insights 系列 #2 | 新增功能

ESP Insights 系列文章 #2

目录

HTTPS 传输

使用 HTTPS 启用 ESP Insights 

分组分析​​​​​​​

---

ESP Insights Beta 版本于 2021 年 7 月发布后，在 ESP 开发者社区中引起了积极反响，点此阅读 ESP Insights 相关介绍。在 ESP Insights 最新版本中，我们进一步优化了用户界面、修复了系统稳定性，并引入了以下新功能：

• 支持基于 HTTPs/REST API 的设备通信
• 分组分析

接下来，让我们详细地了解一下这些新功能。

HTTPS 传输

在推出 ESP Insights 时，我们借鉴了 ESP RainMaker 中的一些概念，特别是 Claiming（指 ESP32 芯片从 ESP RainMaker Claiming Service 中获取证书的过程）和基于 MQTT 进行数据传输这两个概念。这样一来，ESP RainMaker 云数据与 ESP Insights 诊断数据传输，都可以使用同一条 MQTT 连接。但是，如果用户只需要使用 ESP Insights 功能而无需 ESP RainMaker 云，就可以省去连接 ESP RainMaker 云所需要的 Claiming 过程。

现在，ESP Insights 诊断数据上报除了支持 MQTT 通信方式，也同样支持基于 HTTPs/REST API 的通信方式。相较于专有的 X.509 密钥—证书对，一个 HTTP API 密钥可以被多个节点使用，有效简化了用户对设备的设置和管理。

值得一提的是，目前大部分用户都会选择使用 MQTT 通信方式接入云平台，ESP Insights 诊断数据也可以借助这一条连云的 MQTT 链路进行传输，相较于使用 HTTPs/REST API 传输，减少了用户内存消耗。所以我们会在未来引入的功能中，着重优化基于 MQTT 的数据传输方式。

使用 HTTPS 启用 ESP Insights 

您只需要在应用程序中添加几行代码，就可以轻松地在固件中启用 ESP Insights。代码如下：

#include <esp_insights.h>

#define ESP_INSIGHTS_AUTH_KEY "<Paste-Auth-Key-Here>"

{
    esp_insights_config_t config  = {
        .log_type = ESP_DIAG_LOG_TYPE_ERROR,
        .auth_key = ESP_INSIGHTS_AUTH_KEY,
    };
    esp_insights_init(&config);

    /* Rest of my application initialisation */
}

输入这段代码后，应用程序就可以将 ESP Insights 数据上报至 Insights 云了。万事俱备，现在我们需要将专有的 Auth Key（认证密钥）ESP_INSIGHTS_AUTH_KEY 嵌入到固件中。Auth Key（认证密钥）的获取方式如下：

• 前往 ESP Insights 仪表板，注册或登录您的账号；
• 前往 Manage Auth Keys 界面，生成 Auth Key（认证密钥）；
• 将 Auth Key（认证密钥）复制到您的固件上。

设备启动后，您可以在如下日志中找到节点 ID。使用它就能够在 ESP Insights 仪表板中监控到节点的日志，崩溃、重启情况，以及各项指标和变量。

I (4161) esp_insights: =========================================
I (4171) esp_insights: Insights enabled for Node ID 246F2880371C
I (4181) esp_insights: =========================================

想了解更多相关信息，请参阅快速入门指南。

分组分析

目前，ESP Insights 支持节点层面的诊断，会上报所有异常事件，以及单个节点的指标和时间变量值。

最新的 ESP Insights 版本引入了分组分析功能，您可以基于项目、项目版本或事件类别对设备进行分组，深入了解各组设备的表现情况。

• 纵向对比同一项目不同版本的固件情况。
• 深度掌握项目情况，可具体分析某一事件类型的数据。

图 1 应用固件项目和版本的分组分析

以下是几个分组分析的数据示例：

• 在选定的时间间隔内，统计一个特定项目和版本中，“错误” 事件分组下所有节点的错误数据。您也可以把时间间隔设置为小时、周或是月。

以小时为单位，项目 1.0 版本中发生”错误”事件的数量

• 在选定的时间间隔内，一个”崩溃”事件分组下节点崩溃数据的分布情况。

• 在选定的时间间隔内，一个”重启原因”事件分组下数据的分布情况。您可以在此基础上进一步探寻设备重启的原因，找到报告特定事件的节点。

• 在选定的时间间隔内，某一特定节点报告的特定事件（重启/错误/警告）数量。

• 列出发生事件次数最多的节点，进一步分析其类别。

---

敬请期待 ESP Insights 的更多功能！