本機除錯主控台 - AWS IoT Greengrass

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

本機除錯主控台

本機偵錯主控台元件 (aws.greengrass.LocalDebugConsole) 提供本機儀表板,可顯示 AWS IoT Greengrass 核心裝置及其元件的相關資訊。您可以使用此儀表板來偵錯核心裝置並管理本機元件。

重要

我們建議您僅在開發環境中使用此元件,而不是在生產環境中使用。此元件可讓您存取通常在生產環境中不需要的資訊和作業。只將此元件部署到您需要的核心裝置,以遵循最低權限原則。

版本

此元件具有下列版本:

  • 2.3.x 版本

  • 2.2.x 版本

  • 2.1.x

  • 2.0.x

Type

這個組件是一個插件組件(aws.greengrass.plugin)。Greengrass 核在與核相同的 Java 虛擬機(JVM)中運行此組件。當您在核心裝置上變更此元件的版本時,核心會重新啟動。

此組件使用與 Greengrass 核相同的日誌文件。如需詳細資訊,請參閱 監控AWS IoT Greengrass日誌

如需詳細資訊,請參閱 元件類型

作業系統

此元件可安裝在執行下列作業系統的核心裝置上:

  • Linux

  • Windows

要求

此元件具有下列需求:

  • 您可以使用使用者名稱和密碼登入儀表板。使用者名稱debug,也就是為您提供的。您必須使用 AWS IoT Greengrass CLI 建立臨時密碼,以便透過核心裝置上的儀表板驗證您。您必須能夠使用 AWS IoT Greengrass CLI 來使用本機偵錯主控台。如需詳細資訊,請參閱 Greengrass CLI 需求。如需如何產生密碼和登入的詳細資訊,請參閱本機偵錯主控台元件使用情況

  • 支援在 VPC 中執行本機偵錯主控台元件。

相依性

部署元件時, AWS IoT Greengrass 也會部署其相依性的相容版本。這表示您必須符合元件及其所有相依性的需求,才能成功部署元件。本節列出此元件之已發行版本的相依性,以及定義每個相依性之元件版本的語意版本條件約束。您也可以在AWS IoT Greengrass 主控台中檢視元件每個版本的相依性。在元件詳細資料頁面上,尋找 [相依性] 清單。

2.4.1 – 2.4.2

下表列出此元件 2.4.1 至 2.4.2 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.10.0 硬式
Greengrass CLI > = 2.10.0 硬式
2.4.0

下表列出此元件 2.4.0 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.10.0 硬式
Greengrass CLI > = 2.10.0 硬式
2.3.0 and 2.3.1

下表列出此元件 2.3.0 和 2.3.1 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.10.0 硬式
Greengrass CLI > = 2.10.0 硬式
2.2.9

下表列出此元件 2.2.9 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.8

下表列出此元件 2.2.8 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.7

下表列出此元件 2.2.7 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.6

下表列出此元件 2.2.6 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.5

下表列出此元件 2.2.5 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.4

下表列出此元件 2.2.4 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.3

下表列出此元件 2.2.3 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 >=2.1.0 硬式
Greengrass CLI >=2.1.0 硬式
2.2.2

下表列出此元件 2.2.2 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.1

下表列出此元件 2.2.1 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.2.0

下表列出此元件 2.2.0 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.1.0

下表列出此元件 2.1.0 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.1.0 硬式
Greengrass CLI > = 2.1.0 硬式
2.0.x

下表列出此元件 2.0.x 版的相依性。

相依性 兼容版本 相依性類型
Greengrass 核 > = 2.0.3 軟式
Greengrass CLI > = 2.0.3 軟式

如需有關元件相依性的詳細資訊,請參閱元件方案參考

組態

此元件提供下列組態參數,您可以在部署元件時自訂這些參數。

v2.1.x - v2.4.x
httpsEnabled

(選擇性) 您可以為本機除錯主控台啟用 HTTPS 通訊。如果您啟用 HTTPS 通訊,本機偵錯主控台會建立自我簽署憑證。Web 瀏覽器會針對使用自我簽署憑證的網站顯示安全性警告,因此您必須手動驗證憑證。然後,您可以繞過警告。如需詳細資訊,請參閱 用量

預設:true

port

(選擇性) 用來提供本機除錯主控台的連接埠。

預設:1441

websocketPort

(選擇性) 用於本機除錯主控台的 websocket 連接埠。

預設:1442

bindHostname

(選擇性) 用於本機除錯主控台的主機名稱。

如果您在 Docker 容器中執行 AWS IoT Greengrass Core 軟體,請將此參數設定為0.0.0.0,以便您可以在 Docker 容器外開啟本機偵錯主控台。

預設:localhost

範例:組態合併更新

下列範例組態指定在非預設連接埠上開啟本機偵錯主控台,並停用 HTTPS。

{ "httpsEnabled": false, "port": "10441", "websocketPort": "10442" }
v2.0.x
port

(選擇性) 用來提供本機除錯主控台的連接埠。

預設:1441

websocketPort

(選擇性) 用於本機除錯主控台的 websocket 連接埠。

預設:1442

bindHostname

(選擇性) 用於本機除錯主控台的主機名稱。

如果您在 Docker 容器中執行 AWS IoT Greengrass Core 軟體,請將此參數設定為0.0.0.0,以便您可以在 Docker 容器外開啟本機偵錯主控台。

預設:localhost

範例:組態合併更新

下列範例組態指定在非預設連接埠上開啟本機偵錯主控台。

{ "port": "10441", "websocketPort": "10442" }

用量

若要使用本機偵錯主控台,請從 Greengrass CLI 建立工作階段。當您建立工作階段時,Greengrass CLI 會提供使用者名稱和暫時密碼,讓您用來登入本機偵錯主控台。

請依照下列指示,在核心裝置或開發電腦上開啟本機偵錯主控台。

v2.1.x - v2.4.x

在 2.1.0 及更新版本中,本機偵錯主控台預設會使用 HTTPS。啟用 HTTPS 時,本機偵錯主控台會建立自我簽署憑證以保護連線安全。當您因為此自我簽署憑證而開啟本機偵錯主控台時,Web 瀏覽器會顯示安全性警告。當您使用 Greengrass CLI 建立工作階段時,輸出會包含憑證的指紋,因此您可以驗證憑證是否合法且連線是安全的。

您可以停用 HTTPS。如需詳細資訊,請參閱本機偵錯主控台組態

開啟本機除錯主控台
  1. (選擇性) 若要在開發電腦上檢視本機偵錯主控台,您可以透過 SSH 轉寄主控台的連接埠。不過,您必須先在核心裝置的 SSH 設定檔中啟用該AllowTcpForwarding選項。此選項預設為啟用。在開發電腦上執行下列命令,以檢視開發電腦localhost:1441上的儀表板。

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    注意

    您可以從1441和變更預設連接埠1442。如需詳細資訊,請參閱本機偵錯主控台組態

  2. 建立工作階段以使用本機偵錯主控台。當您建立工作階段時,您會產生用來驗證的密碼。本機偵錯主控台需要密碼來提高安全性,因為您可以使用此元件來檢視重要資訊並在核心裝置上執行作業。如果您在元件組態中啟用 HTTPS,本機偵錯主控台也會建立憑證來保護連線的安全。HTTPS 預設為啟用狀態。

    使用 AWS IoT Greengrass CLI 建立工作階段。此命令會產生隨機 43 個字元的密碼,該密碼會在 8 小時後過期。以 AWS IoT Greengrass V2 根資料夾的路徑取代/greengrass/v2C:\greengrass\v2

    Linux or UnixWindows
    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli get-debug-password
    Windows
    C:\greengrass\v2\bin\greengrass-cli get-debug-password

    如果您已將本機偵錯主控台設定為使用 HTTPS,命令輸出看起來像下列範例。當您開啟本機偵錯主控台時,您可以使用憑證指紋來確認連線是否安全。

    Username: debug Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE Password expires at: 2021-04-01T17:01:43.921999931-07:00 The local debug console is configured to use TLS security. The certificate is self-signed so you will need to bypass your web browser's security warnings to open the console. Before you bypass the security warning, verify that the certificate fingerprint matches the following fingerprints. SHA-256: 15 0B 2C E2 54 8B 22 DE 08 46 54 8A B1 2B 25 DE FB 02 7D 01 4E 4A 56 67 96 DA A6 CC B1 D2 C4 1B SHA-1: BC 3E 16 04 D3 80 70 DA E0 47 25 F9 90 FA D6 02 80 3E B5 C1

    調試視圖組件創建持續 8 小時的會話。之後,您必須產生新密碼才能再次檢視本機偵錯主控台。

  3. 開啟並登入儀表板。在 Greengrass 核心裝置上檢視儀表板,或者如果您透過 SSH 轉送連接埠,請在開發電腦上檢視儀表板。執行以下任意一項:

    • 如果您在本機除錯主控台中啟用 HTTPS (此為預設設定),請執行下列動作:

      1. 在核心設備https://localhost:1441上打開,或者在開發計算機上打開(如果您通過 SSH 轉發端口)。

        您的瀏覽器可能會顯示有關無效安全性憑證的安全性警告。

      2. 如果您的瀏覽器顯示安全性警告,請確認憑證是否合法並略過安全性警告。請執行下列操作:

        1. 找出憑證的 SHA-256 或 SHA-1 指紋,並確認它是否符合先前列印的指get-debug-password令的 SHA-256 或 SHA-1 指紋。您的瀏覽器可能會提供一個或兩個指紋。請參閱瀏覽器的文件,以檢視憑證及其指紋。在某些瀏覽器中,憑證指紋稱為指紋。

          注意

          如果憑證指紋不相符,請移步驟 2至建立新的工作階段。如果憑證指紋仍不相符,表示您的連線可能不安全。

        2. 如果憑證指紋相符,請略過瀏覽器的安全性警告,以開啟本機偵錯主控台。請參閱瀏覽器的文件,以略過瀏覽器安全性警告。

      3. 使用先前列印的get-debug-password命令的使用者名稱和密碼登入網站。

        本機除錯主控台隨即開啟。

      4. 如果本機偵錯主控台顯示錯誤,指出 WebSocket 由於 TLS 交涉失敗而無法連線到,您必須略過 WebSocket URL 的自我簽署安全性警告。

        本機偵錯主控台中的 WebSocket TLS 交握錯誤。

        請執行下列操作:

        1. https://localhost:1442在您開啟本機偵錯主控台的相同瀏覽器中開啟。

        2. 驗證憑證並略過安全性警告。

          略過警告後,瀏覽器可能會顯示 HTTP 404 頁面。

        3. https://localhost:1441再次打開。

          本機偵錯主控台會顯示核心裝置的相關資訊。

    • 如果您在本機偵錯主控台中停用 HTTPS,請執行下列動作:

      1. 在核心設備http://localhost:1441上打開,或者如果您通過 SSH 轉發端口,請在開發計算機上打開它。

      2. 使用先前列印的get-debug-password命令的使用者名稱和密碼登入網站。

        本機除錯主控台隨即開啟。

v2.0.x
開啟本機除錯主控台
  1. (選擇性) 若要在開發電腦上檢視本機偵錯主控台,您可以透過 SSH 轉寄主控台的連接埠。不過,您必須先在核心裝置的 SSH 設定檔中啟用該AllowTcpForwarding選項。此選項預設為啟用。在開發電腦上執行下列命令,以檢視開發電腦localhost:1441上的儀表板。

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    注意

    您可以從1441和變更預設連接埠1442。如需詳細資訊,請參閱本機偵錯主控台組態

  2. 建立工作階段以使用本機偵錯主控台。當您建立工作階段時,您會產生用來驗證的密碼。本機偵錯主控台需要密碼來提高安全性,因為您可以使用此元件來檢視重要資訊並在核心裝置上執行作業。

    使用 AWS IoT Greengrass CLI 建立工作階段。此命令會產生隨機 43 個字元的密碼,該密碼會在 8 小時後過期。以 AWS IoT Greengrass V2 根資料夾的路徑取代/greengrass/v2C:\greengrass\v2

    Linux or UnixWindows
    Linux or Unix
    sudo /greengrass/v2/bin/greengrass-cli get-debug-password
    Windows
    C:\greengrass\v2\bin\greengrass-cli get-debug-password

    命令輸出如下列範例所示。

    Username: debug Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE Password will expire at: 2021-04-01T17:01:43.921999931-07:00

    調試視圖組件創建會話持續 4 小時,然後你必須生成一個新的密碼再次查看本地調試控制台。

  3. 在核心設備http://localhost:1441上打開,或者如果您通過 SSH 轉發端口,請在開發計算機上打開它。

  4. 使用先前列印的get-debug-password命令的使用者名稱和密碼登入網站。

    本機除錯主控台隨即開啟。

本機記錄檔

此元件使用與 Greengrass 核元件相同的記錄檔。

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
若要檢視此元件的記錄
  • 在核心裝置上執行下列命令,即時檢視此元件的記錄檔。以 AWS IoT Greengrass 根資料夾的路徑取代/greengrass/v2C:\greengrass\v2

    Linux
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

變更記錄

下表說明元件每個版本中的變更。

版本

變更

2.4.2

錯誤修復和改進
  • 一般錯誤修正與改進。

2.4.1

版本更新 Greengrass 2.12.0 版本釋放。

2.4.0

新功能
  • 添加流管理器調試控制台。

2.3.1

版本更新了 Greengrass 核 2.11.0 版本釋放。

2.3.0

版本更新了 Greengrass 2.10.0 版本。
新功能
  • 包括 PubSub 和 AWS IoT Core MQTT 調試客戶端。

2.2.7

版本更新 Greengrass 2.9.0 版本釋放。

2.2.6

版本更新 Greengrass 2.8.0 版本的版本。

2.2.5

版本更新了 Greengrass 核 2.7.0 版本釋放。

2.2.4

版本更新 Greengrass 2.6.0 版本發布。

2.2.3

錯誤修復和改進
  • 修正當元件無法解密包含 SSL 私密金鑰的金鑰儲存庫時,無法啟動的問題。

  • 版本更新了 Greengrass 核 2.5.0 版本。

2.2.2

版本更新 Greengrass 2.4.0 版本的版本。

2.2.1

版本更新了 Greengrass 核 2.3.0 版本。

2.2.0

版本更新了 Greengrass 核 2.2.0 版本。

2.1.0

新功能
  • 使用 HTTPS 來保護您與本機偵錯主控台的連線安全。HTTPS 預設為啟用狀態。

錯誤修復和改進
  • 您可以在設定編輯器中關閉快閃列訊息。

2.0.3

初始版本。