版本 Type 作業系統要求相依性組態用量本機記錄檔變更記錄

日誌管理器

日誌管理器元件 (aws.greengrass.LogManager) 會將日誌從AWS IoT Greengrass核心裝置上傳到 Amazon CloudWatch 日誌。您可以從 Greengrass 核心、其他 Greengrass 元件，以及其他不是 Greengrass 元件的應用程式和服務上傳記錄檔。如需如何在記錄檔和本機檔案系統中監視 CloudWatch 記錄的詳細資訊，請參閱監控AWS IoT Greengrass日誌。

當您使用記錄檔管理員元件寫入 CloudWatch 記錄檔時，需要考量下列事項：

記錄延遲

注意
我們建議您升級至記錄檔管理員 2.3.0 版，以減少輪換和使用中記錄檔的記錄延遲。當您升級至記錄檔管理員 2.3.0 時，我們建議您也升級至 Greengrass 核心 2.9.1。

記錄管理員元件 2.2.8 版 (及更早版本) 只會從輪換的記錄檔處理和上傳記錄檔。根據預設，AWS IoT Greengrass核心軟體會每小時或在 1,024 KB 之後輪換記錄檔。因此，記錄管理員元件只會在AWS IoT Greengrass核心軟體或 Greengrass 元件寫入超過 1,024 KB 的記錄檔之後上傳記錄檔。您可以設定較低的記錄檔大小限制，使記錄檔更頻繁地旋轉。這會導致記錄檔管理員元件更頻繁地將記錄檔上傳至 CloudWatch 記錄檔。

記錄管理員元件 2.3.0 版 (及更新版本) 會處理並上傳所有記錄檔。當您寫入新的記錄檔時，記錄檔管理員 2.3.0 版 (及更新版本) 會處理並直接上傳該使用中的記錄檔，而不是等待輪換。這意味著您可以在 5 分鐘或更短的時間內查看新日誌。

記錄管理員元件會定期上傳新的記錄檔。根據預設，記錄管理員元件會每 5 分鐘上傳一次新的記錄檔。您可以設定較低的上傳間隔，因此記錄管理員元件會將記錄檔上傳至 CloudWatch 記錄檔的頻率，方法是設定periodicUploadIntervalSec. 如需如何設定此週期間隔的相關資訊，請參閱組態。

日誌可以從相同的 Greengrass 文件系統以近乎即時的方式上傳。如果您需要即時觀察記錄，請考慮使用檔案系統記錄檔。

注意
如果您使用不同的檔案系統來寫入記錄檔，記錄檔管理員會還原為記錄檔管理員元件 2.2.8 及更早版本中的行為。如需存取檔案系統記錄檔的相關資訊，請參閱存取檔案系統記錄。
時鐘偏斜

記錄管理員元件會使用標準簽章第 4 版簽署程序來建立對 CloudWatch 記錄的 API 要求。如果核心裝置上的系統時間不同步超過 15 分鐘，則 CloudWatch Logs 會拒絕要求。如需詳細資訊，請參閱 AWS 一般參考 中的 Signature 第 4 版簽署程序。

如需有關此元件上傳記錄檔的記錄群組和記錄資料流的資訊，請參閱用量。

版本

此元件具有下列版本：

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

要求

此元件具有下列需求：

Greengrass 裝置角色必須允許logs:CreateLogGroup、logs:CreateLogStream、和logs:DescribeLogStreams動作logs:PutLogEvents，如以下範例 IAM 政策所示。
```
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": [
        "logs:CreateLogGroup",
        "logs:CreateLogStream",
        "logs:PutLogEvents",
        "logs:DescribeLogStreams"
      ],
      "Effect": "Allow",
      "Resource": "arn:aws:logs:*:*:*"
    }
  ]
}
```
注意
您在安裝 AWS IoT Greengrass Core 軟體時建立的 Greengrass 裝置角色預設包含此範例原則中的權限。

如需詳細資訊，請參閱 Amazon CloudWatch 日誌使用者指南中的對 CloudWatch 日誌使用身分型政策 (IAM 政策)。
支援在 VPC 中執行記錄管理員元件。若要在 VPC 中部署此元件，需要下列項目。
- 記錄管理員元件必須具有logs.region.amazonaws.com的 VPC 端點的com.amazonaws.us-east-1.logs連線。

端點和連接埠

除了基本作業所需的端點和連接埠之外，此元件還必須能夠對下列端點和連接埠執行輸出要求。如需詳細資訊，請參閱允許裝置流量透過 Proxy 或防火牆。

端點	連線埠	必要	描述
`logs.region.amazonaws.com`	443	否	如果您將記錄寫入記錄檔，則為 CloudWatch 必要項

相依性

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

組態

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

v2.3.6 – v2.3.7

logsUploaderConfiguration

(選擇性) 記錄檔管理員元件上傳的記錄檔組態。此物件包含下列資訊：

systemLogsConfiguration

(選擇性) AWS IoT Greengrass 核心軟體系統記錄的組態，其中包括 Greengrass 核心核心和外掛程式元件的記錄。指定此組態可讓記錄管理員元件管理系統記錄檔管理員。此物件包含下列資訊：

uploadToCloudWatch

(選擇性) 您可以將系統記錄上傳至 CloudWatch 記錄檔。

預設：false

minimumLogLevel

(選擇性) 要上傳的記錄訊息的最低層級。只有當您將 Greengrass 核心元件設定為輸出 JSON 格式記錄時，才會套用此最低層級。若要啟用 JSON 格式記錄檔，JSON請指定記錄格式參數 (logging.format)。

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

(選擇性) Greengrass 系統記錄檔的大小上限 (以您在中指定的單位表示)。diskSpaceLimitUnit在 Greengrass 系統記錄檔的總大小超過此總大小上限之後，AWS IoT Greengrass核心軟體會刪除最舊的 Greengrass 系統記錄檔。

此參數相當於 Greengrass 核元件的記錄檔大小限制參數 (totalLogsSizeKB)。AWS IoT Greengrass核心軟體使用兩個值中的最小值做為 Greengrass 系統記錄檔大小的最大總計。

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

componentLogsConfigurationMap

(選擇性) 核心裝置上元件的記錄組態對映。此對映中的每個componentName物件都會定義元件或應用程式的記錄組態。記錄管理員元件會將這些元件記錄檔上傳至 CloudWatch 記錄檔。

重要

我們強烈建議每個元件使用單一組態金鑰。您應該只鎖定只有一個記錄檔的檔案群組，這些記錄檔在使用logFileRegex. 不遵循此建議可能會導致重複的記錄檔上傳到 CloudWatch。如果您使用單一規則運算式鎖定多個使用中記錄檔，建議您升級至 log Manager v2.3.1 或更新版本，並考慮使用範例組態變更組態。

注意

如果您要從 v2.2.0 之前的日誌管理器版本升級，則可以繼續使用該componentLogsConfiguration列表而不是。componentLogsConfigurationMap但是，我們強烈建議您使用對映格式，以便您可以使用合併和重設更新來修改特定零組件的模型組態。如需有關componentLogsConfiguration參數的資訊，請參閱此元件 v2.1.x 的組態參數。

componentName

此記錄組態之componentName元件或應用程式的記錄組態。您可以指定 Greengrass 元件的名稱或其他值來識別此記錄群組。

每個物件都包含下列資訊：

minimumLogLevel

(選擇性) 要上傳的記錄訊息的最低層級。此最低層級僅適用於此元件的記錄檔使用特定的 JSON 格式，您可以在上的AWS IoT Greengrass記錄模組存放庫中找到 GitHub。

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

(選擇性) 此元件的所有記錄檔總大小上限 (以您在中指定的單位表示) diskSpaceLimitUnit。在此元件的記錄檔總大小超過此最大總大小之後，AWS IoT GreengrassCore 軟體就會刪除此元件最舊的記錄檔。

此參數與 Greengrass 核元件的記錄檔大小限制參數 (totalLogsSizeKB) 有關。AWS IoT Greengrass核心軟體會使用兩個值中的最小值做為此元件的最大總記錄大小。

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

logFileDirectoryPath

(選擇性) 包含此元件記錄檔之資料夾的路徑。

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

預設：/greengrass/v2/logs。

logFileRegex

(選擇性) 規則運算式，指定元件或應用程式使用的記錄檔名稱格式。記錄管理員元件會使用此規則運算式來識別位於資料夾中的記錄檔logFileDirectoryPath。

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

如果您的組件或應用程序旋轉日誌文件，請指定與旋轉的日誌文件名稱匹配的正則表達式。例如，您可hello_world\\\\w*.log以指定為 Hello World 應用程式上傳記錄檔。該\\\\w*模式匹配零個或多個單詞字符，其中包括字母數字字符和底線。這個正則表達式匹配名稱中有和沒有時間戳的日誌文件。在此範例中，記錄管理員會上傳下列記錄檔：

hello_world.log— Hello World 應用程式的最新記錄檔。
hello_world_2020_12_15_17_0.log— Hello World 應用程式的較舊記錄檔。

預設值：componentName\\\\w*.log，其中元件名稱是此記錄檔組態的元件名稱。

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

multiLineStartPattern

(選擇性) 識別新行上的記錄訊息何時是新記錄訊息的規則運算式。如果規則運算式不符合新行，則記錄管理員元件會將新行附加至上一行的記錄檔訊息。

根據預設，記錄管理員元件會檢查該行是否以空白字元開頭，例如索引標籤或空格。如果沒有，日誌管理器處理該行作為新的日誌消息。否則，它會將該行附加到當前日誌消息中。此行為可確保記錄檔管理員元件不會分割跨越多行的郵件，例如堆疊追蹤。

periodicUploadIntervalSec

(選擇性) 記錄管理員元件檢查要上傳之新記錄檔的期間 (以秒為單位)。

預設值：300(5 分鐘)

最小值：0.000001（1 微秒）

deprecatedVersionSupport

指出記錄檔管理員是否應該使用記錄檔管理員 v2.3.5 中引入的記錄速度改進。將值設定為以false使用改良功能。

如果您將此值設定為，false當您從記錄管理員 v2.3.1 升級或更早版本的重複記錄項目時，可能會上傳。

預設值為 true。

範例：組態合併更新

下列範例組態指定將系統記錄檔和com.example.HelloWorld元件記錄檔上傳至 CloudWatch 記錄檔。


{
  "logsUploaderConfiguration": {
    "systemLogsConfiguration": {
      "uploadToCloudWatch": "true",
      "minimumLogLevel": "INFO",
      "diskSpaceLimit": "10",
      "diskSpaceLimitUnit": "MB",
      "deleteLogFileAfterCloudUpload": "false"
    },
    "componentLogsConfigurationMap": {
      "com.example.HelloWorld": {
        "minimumLogLevel": "INFO",
        "diskSpaceLimit": "20",
        "diskSpaceLimitUnit": "MB",
        "deleteLogFileAfterCloudUpload": "false"
      }
    }
  },
  "periodicUploadIntervalSec": "300",
  "deprecatedVersionSupport": "false"
}

範例：使用記錄管理員 v2.3.1 上傳多個使用中記錄檔的組態

如果您要將多個使用中記錄檔鎖定為目標，則建議使用下列範例組態。此範例組態指定您要上傳到哪些使用中記錄檔 CloudWatch。使用此配置範例配置也會上傳符合的任何旋轉檔案logFileRegex。日誌管理器 v2.3.1 支持此示例配置。


{
  "logsUploaderConfiguration": {
    "componentLogsConfigurationMap": {
      "com.example.A": {
        "logFileRegex": "com.example.A\\w*.log",
        "deleteLogFileAfterCloudUpload": "false"
      }
      "com.example.B": {
        "logFileRegex": "com.example.B\\w*.log",
        "deleteLogFileAfterCloudUpload": "false"
      }
    }
  },
  "periodicUploadIntervalSec": "10"
}

v2.3.x

logsUploaderConfiguration

(選擇性) 記錄檔管理員元件上傳的記錄檔組態。此物件包含下列資訊：

systemLogsConfiguration

uploadToCloudWatch

(選擇性) 您可以將系統記錄上傳至 CloudWatch 記錄檔。

預設：false

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

componentLogsConfigurationMap

重要

我們強烈建議每個元件使用單一組態金鑰。您應該只鎖定只有一個記錄檔的檔案群組，這些記錄檔在使用logFileRegex. 不遵循此建議可能會導致重複的記錄檔上傳到 CloudWatch。如果您使用單一規則運算式鎖定多個使用中記錄檔，建議您升級至 log Manager v2.3.1，並考慮使用範例設定來變更組態。

注意

componentName

此記錄組態之componentName元件或應用程式的記錄組態。您可以指定 Greengrass 元件的名稱或其他值來識別此記錄群組。

每個物件都包含下列資訊：

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

此參數與 Greengrass 核元件的記錄檔大小限制參數 (totalLogsSizeKB) 有關。AWS IoT Greengrass核心軟體會使用兩個值中的最小值做為此元件的最大總記錄大小。

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

logFileDirectoryPath

(選擇性) 包含此元件記錄檔之資料夾的路徑。

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

預設：/greengrass/v2/logs。

logFileRegex

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

hello_world.log— Hello World 應用程式的最新記錄檔。
hello_world_2020_12_15_17_0.log— Hello World 應用程式的較舊記錄檔。

預設值：componentName\\\\w*.log，其中元件名稱是此記錄檔組態的元件名稱。

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

multiLineStartPattern

periodicUploadIntervalSec

(選擇性) 記錄管理員元件檢查要上傳之新記錄檔的期間 (以秒為單位)。

預設值：300(5 分鐘)

最小值：0.000001（1 微秒）

範例：組態合併更新

下列範例組態指定將系統記錄檔和com.example.HelloWorld元件記錄檔上傳至 CloudWatch 記錄檔。


{
  "logsUploaderConfiguration": {
    "systemLogsConfiguration": {
      "uploadToCloudWatch": "true",
      "minimumLogLevel": "INFO",
      "diskSpaceLimit": "10",
      "diskSpaceLimitUnit": "MB",
      "deleteLogFileAfterCloudUpload": "false"
    },
    "componentLogsConfigurationMap": {
      "com.example.HelloWorld": {
        "minimumLogLevel": "INFO",
        "diskSpaceLimit": "20",
        "diskSpaceLimitUnit": "MB",
        "deleteLogFileAfterCloudUpload": "false"
      }
    }
  },
  "periodicUploadIntervalSec": "300"
}

範例：使用記錄管理員 v2.3.1 上傳多個使用中記錄檔的組態


{
  "logsUploaderConfiguration": {
    "componentLogsConfigurationMap": {
      "com.example.A": {
        "logFileRegex": "com.example.A\\w*.log",
        "deleteLogFileAfterCloudUpload": "false"
      }
      "com.example.B": {
        "logFileRegex": "com.example.B\\w*.log",
        "deleteLogFileAfterCloudUpload": "false"
      }
    }
  },
  "periodicUploadIntervalSec": "10"
}

v2.2.x

logsUploaderConfiguration

(選擇性) 記錄檔管理員元件上傳的記錄檔組態。此物件包含下列資訊：

systemLogsConfiguration

uploadToCloudWatch

(選擇性) 您可以將系統記錄上傳至 CloudWatch 記錄檔。

預設：false

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

componentLogsConfigurationMap

注意

componentName

此記錄組態之componentName元件或應用程式的記錄組態。您可以指定 Greengrass 元件的名稱或其他值來識別此記錄群組。

每個物件都包含下列資訊：

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

此參數與 Greengrass 核元件的記錄檔大小限制參數 (totalLogsSizeKB) 有關。AWS IoT Greengrass核心軟體會使用兩個值中的最小值做為此元件的最大總記錄大小。

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

logFileDirectoryPath

(選擇性) 包含此元件記錄檔之資料夾的路徑。

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

預設：/greengrass/v2/logs。

logFileRegex

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

hello_world.log— Hello World 應用程式的最新記錄檔。
hello_world_2020_12_15_17_0.log— Hello World 應用程式的較舊記錄檔。

預設值：componentName\\\\w*.log，其中元件名稱是此記錄檔組態的元件名稱。

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

multiLineStartPattern

periodicUploadIntervalSec

(選擇性) 記錄管理員元件檢查要上傳之新記錄檔的期間 (以秒為單位)。

預設值：300(5 分鐘)

最小值：0.000001（1 微秒）

範例：組態合併更新

下列範例組態指定將系統記錄檔和com.example.HelloWorld元件記錄檔上傳至 CloudWatch 記錄檔。


{
  "logsUploaderConfiguration": {
    "systemLogsConfiguration": {
      "uploadToCloudWatch": "true",
      "minimumLogLevel": "INFO",
      "diskSpaceLimit": "10",
      "diskSpaceLimitUnit": "MB",
      "deleteLogFileAfterCloudUpload": "false"
    },
    "componentLogsConfigurationMap": {
      "com.example.HelloWorld": {
        "minimumLogLevel": "INFO",
        "diskSpaceLimit": "20",
        "diskSpaceLimitUnit": "MB",
        "deleteLogFileAfterCloudUpload": "false"
      }
    }
  },
  "periodicUploadIntervalSec": "300"
}

v2.1.x

logsUploaderConfiguration

(選擇性) 記錄檔管理員元件上傳的記錄檔組態。此物件包含下列資訊：

systemLogsConfiguration

uploadToCloudWatch

(選擇性) 您可以將系統記錄上傳至 CloudWatch 記錄檔。

預設：false

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

componentLogsConfiguration

(選擇性) 核心裝置上元件的記錄組態清單。此清單中的每個組態都會定義元件或應用程式的記錄組態。記錄管理員元件會將這些元件記錄檔上傳至 CloudWatch 記錄

每個物件都包含下列資訊：

componentName

此記錄組態的元件或應用程式名稱。您可以指定 Greengrass 元件的名稱或其他值來識別此記錄群組。

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

此參數與 Greengrass 核元件的記錄檔大小限制參數 (totalLogsSizeKB) 有關。AWS IoT Greengrass核心軟體會使用兩個值中的最小值做為此元件的最大總記錄大小。

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

logFileDirectoryPath

(選擇性) 包含此元件記錄檔之資料夾的路徑。

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

預設：/greengrass/v2/logs。

logFileRegex

您不需要為打印到標準輸出（標準輸出）和標準錯誤（stderr）的 Greengrass 組件指定此參數。

hello_world.log— Hello World 應用程式的最新記錄檔。
hello_world_2020_12_15_17_0.log— Hello World 應用程式的較舊記錄檔。

預設值：componentName\\\\w*.log，其中元件名稱是此記錄檔組態的元件名稱。

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

multiLineStartPattern

periodicUploadIntervalSec

(選擇性) 記錄管理員元件檢查要上傳之新記錄檔的期間 (以秒為單位)。

預設值：300(5 分鐘)

最小值：0.000001（1 微秒）

範例：組態合併更新

下列範例組態指定將系統記錄檔和com.example.HelloWorld元件記錄檔上傳至 CloudWatch 記錄檔。


{
  "logsUploaderConfiguration": {
    "systemLogsConfiguration": {
      "uploadToCloudWatch": "true",
      "minimumLogLevel": "INFO",
      "diskSpaceLimit": "10",
      "diskSpaceLimitUnit": "MB",
      "deleteLogFileAfterCloudUpload": "false"
    },
    "componentLogsConfiguration": [
      {
        "componentName": "com.example.HelloWorld",
        "minimumLogLevel": "INFO",
        "diskSpaceLimit": "20",
        "diskSpaceLimitUnit": "MB",
        "deleteLogFileAfterCloudUpload": "false"
      }
    ]
  },
  "periodicUploadIntervalSec": "300"
}

v2.0.x

logsUploaderConfiguration

(選擇性) 記錄檔管理員元件上傳的記錄檔組態。此物件包含下列資訊：

systemLogsConfiguration

(選擇性) AWS IoT Greengrass Core 軟體系統記錄檔的組態。指定此組態可讓記錄管理員元件管理系統記錄檔管理員。此物件包含下列資訊：

uploadToCloudWatch

(選擇性) 您可以將系統記錄上傳至 CloudWatch 記錄檔。

預設：false

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

componentLogsConfiguration

每個物件都包含下列資訊：

componentName

此記錄組態的元件或應用程式名稱。您可以指定 Greengrass 元件的名稱或其他值來識別此記錄群組。

minimumLogLevel

從下列記錄層級中進行選擇，依照層級順序列出：

DEBUG
INFO
WARN
ERROR

預設：INFO

diskSpaceLimit

此參數與 Greengrass 核元件的記錄檔大小限制參數 (totalLogsSizeKB) 有關。AWS IoT Greengrass核心軟體會使用兩個值中的最小值做為此元件的最大總記錄大小。

diskSpaceLimitUnit

(選擇性) 的單位diskSpaceLimit。您可以從以下選項中選擇：

KB— 千字節
MB— 兆字節
GB— 千兆字節

預設：KB

logFileDirectoryPath

包含此元件記錄檔之資料夾的路徑。

若要上傳 Greengrass 元件的記錄檔，請指定/greengrass/v2/logs您的 Greengrass 根資料夾並取代/greengrass/v2這些記錄檔。

logFileRegex

規則運算式；指定元件或應用程式使用的記錄檔名稱格式。記錄管理員元件會使用此規則運算式來識別位於資料夾中的記錄檔logFileDirectoryPath。

若要上傳 Greengrass 元件的記錄檔，請指定符合旋轉記錄檔名稱的正則運算式。例如，您可com.example.HelloWorld\\w*.log以指定為 Hello World 元件上傳記錄檔。該\\w*模式匹配零個或多個單詞字符，其中包括字母數字字符和底線。這個正則表達式匹配名稱中有和沒有時間戳的日誌文件。在此範例中，記錄管理員會上傳下列記錄檔：

com.example.HelloWorld.log— 您好世界元件的最新記錄檔。
com.example.HelloWorld_2020_12_15_17_0.log— 您好世界元件的較舊記錄檔。Greengrass 核添加了一個旋轉時間戳記到日誌文件。

deleteLogFileAfterCloudUpload

(選擇性) 您可以在記錄管理員元件將記錄檔上傳至「記錄檔」之後刪除 CloudWatch 記錄檔。

預設：false

multiLineStartPattern

periodicUploadIntervalSec

(選擇性) 記錄管理員元件檢查要上傳之新記錄檔的期間 (以秒為單位)。

預設值：300(5 分鐘)

最小值：0.000001（1 微秒）

範例：組態合併更新

下列範例組態指定將系統記錄檔和com.example.HelloWorld元件記錄檔上傳至 CloudWatch 記錄檔。


{
  "logsUploaderConfiguration": {
    "systemLogsConfiguration": {
      "uploadToCloudWatch": "true",
      "minimumLogLevel": "INFO",
      "diskSpaceLimit": "10",
      "diskSpaceLimitUnit": "MB",
      "deleteLogFileAfterCloudUpload": "false"
    },
    "componentLogsConfiguration": [
      {
        "componentName": "com.example.HelloWorld",
        "minimumLogLevel": "INFO",
        "logFileDirectoryPath": "/greengrass/v2/logs",
        "logFileRegex": "com.example.HelloWorld\\w*.log",
        "diskSpaceLimit": "20",
        "diskSpaceLimitUnit": "MB",
        "deleteLogFileAfterCloudUpload": "false"
      }
    ]
  },
  "periodicUploadIntervalSec": "300"
}

用量

記錄管理員元件會上傳至下列記錄群組和記錄資料流。

2.1.0 and later

記錄群組名稱


/aws/greengrass/componentType/region/componentName

記錄群組名稱會使用下列變數：

componentType— 元件的類型，可以是下列其中一種：
- GreengrassSystemComponent— 此記錄群組包含核心和外掛程式元件的記錄，這些元件與 Greengrass 核心在相同的 JVM 中執行。該組件是 Greengr ass 核的一部分。
- UserComponent— 此日誌群組包含一般元件、Lambda 元件和裝置上其他應用程式的記錄。該組件不是 Greengrass 核的一部分。
如需詳細資訊，請參閱元件類型。
region— 核心設備使用的AWS區域。
componentName— 元件的名稱。對於系統記錄檔，此值為System。

記錄串流名稱


/date/thing/thingName

記錄資料流名稱會使用下列變數：

date— 記錄的日期，例如2020/12/15。記錄管理員元件會使用此yyyy/MM/dd格式。
thingName— 核心裝置的名稱。

注意

如果物件名稱包含冒號 (:)，則記錄管理員會以加號 (+) 取代冒號。

2.0.x

記錄群組名稱


/aws/greengrass/componentType/region/componentName

記錄群組名稱會使用下列變數：

componentType— 元件的類型，可以是下列其中一種：
- GreengrassSystemComponent— 該組件是 Greengr ass 核的一部分.
- UserComponent— 該組件不是 Greengrass 核的一部分. 日誌管理器將此類型用於設備上的 Greengrass 組件和其他應用程序。
region— 核心設備使用的AWS區域。
componentName— 元件的名稱。對於系統記錄檔，此值為System。

記錄串流名稱


/date/deploymentTargets/thingName

記錄資料流名稱會使用下列變數：

date— 記錄的日期，例如2020/12/15。記錄管理員元件會使用此yyyy/MM/dd格式。
deploymentTargets— 其部署包含元件的物件。記錄管理員元件會以斜線分隔每個目標。如果元件因為本機部署而在核心裝置上執行，則此值為LOCAL_DEPLOYMENT。

假設您有一個名為的核心裝置MyGreengrassCore，且核心裝置具有兩個部署的範例：
- 以核心裝置為目標的部署MyGreengrassCore。
- 以名稱為MyGreengrassCoreGroup物件群組 (包含核心裝置) 為目標的部署。
這deploymentTargets個核心設備是thing/MyGreengrassCore/thinggroup/MyGreengrassCoreGroup。
thingName— 核心裝置的名稱。

記錄項目的格式。

格 Greengrass 核以字符串或 JSON 格式寫入日誌文件。對於系統記錄檔，您可以透過設定logging項目的format欄位來控制格式。您可以在 Greengrass 核組件的配置文件中找到該logging條目。如需詳細資訊，請參閱 Greengrass 核組態。

文字格式為自由格式，可接受任何字串。下列叢集狀態服務訊息是字串格式化記錄的範例：


2023-03-26T18:18:27.271Z [INFO] (pool-1-thread-2)
com.aws.greengrass.status.FleetStatusService: fss-status-update-published. 
Status update published to FSS. {trigger=CADENCE, serviceName=FleetStatusService, 
currentState=RUNNING}

如果您想要使用 Greengrass CLI 記錄檔命令檢視記錄檔，或以程式設計方式與記錄檔互動，請使用 JSON 格式。下面的例子概述了 JSON 形狀：


{
   "loggerName": <string>,
   "level": <"DEBUG" | "INFO" | "ERROR" | "TRACE" | "WARN">,
   "eventType": <string, optional>,
   "cause": <string, optional>,
   "contexts": {},
   "thread": <string>,
   "message": <string>,
   "timestamp": <epoch time> # Needs to be epoch time
}

若要控制元件記錄檔的輸出，您可以使用minimumLogLevel組態選項。若要使用此選項，您的元件必須以 JSON 格式寫入其記錄項目。您應該使用與系統記錄檔相同的格式。

本機記錄檔

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

若要檢視此元件的記錄

在核心裝置上執行下列命令，即時檢視此元件的記錄檔。以AWS IoT Greengrass根資料夾的路徑取代/greengrass/v2或 C:\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.3.7	版本更新 Greengrass 2.12.0 版本釋放。
2.3.6	錯誤修復和改進調整某些錯誤的日誌級別。
2.3.5	改善項目提高了日誌上傳速度。版本更新 Greengrass 2.11.0 版本釋放。
2.3.4	錯誤修復和改進添加對將參數設置為分`periodicUploadIntervalSec`數值的支援。最小值為 1 微秒。修正記錄管理員不遵守 CloudWatch`putLogEvents`限制的問題。
2.3.3	版本更新了 Greengrass 2.10.0 版本。
2.3.2	錯誤修復和改進改進了空間管理，以便在上傳之前不會刪除日誌文件。修復了緩存管理的問題。其他小錯誤修復和改進。
2.3.1	錯誤修復和改進修正了具有多個活動日誌文件的目標文件組將重複條目上傳到 CloudWatch的問題。其他小錯誤修復和改進。
2.3.0	注意我們建議您升級至記錄檔管理員 2.3.0 時，升級至 Greengrass 核心 2.9.1。新功能透過處理和直接上傳作用中的記錄檔，而不是等待輪換新檔案來減少記錄延遲。錯誤修復和改進改進了旋轉具有唯一名稱的文件時對日誌旋轉的支持。其他小錯誤修復和改進。
2.2.8	版本更新 Greengrass 2.9.0 版本釋放。
2.2.7	版本更新 Greengrass 2.8.0 版本的版本。
2.2.6	版本更新了 Greengrass 核 2.7.0 版本釋放。
2.2.5	版本更新 Greengrass 2.6.0 版本發布。
2.2.4	錯誤修復和改進改善處理無效組態時的穩定性。其他小修正和改進。
2.2.3	錯誤修復和改進改善元件重新啟動或發生錯誤的特定情況下的穩定性。修正在特定情況下無法上傳大型記錄訊息和大型記錄檔的問題。修正此元件如何處理組態重設更新的問題。修正組`nulldiskSpaceLimit`態值造成元件無法部署的問題。
2.2.2	錯誤修復和改進添加對大於 256 KB 的日誌消息的支持。記錄管理員元件會將這些大型記錄檔訊息分割成具有相同記錄事件時間戳記的多個訊息。
2.2.1	版本更新了 Greengrass 核 2.5.0 版本。
2.2.0	新功能新增組`componentLogsConfigurationMap`態參數以支援元件記錄組態的對映格式。對映中的每個`componentName`物件都會定義元件或應用程式的記錄組態。
2.1.3	版本更新 Greengrass 2.4.0 版本的版本。
2.1.2	版本更新了 Greengrass 核 2.3.0 版本。
2.1.1	錯誤修復和改進修正了某些情況下系統日誌配置未更新的問題。
2.1.0	錯誤修復和改進對於打印到標準輸出（標準輸出）`logFileDirectoryPath`和`logFileRegex`標準錯誤（stderr）的 Greengrass 組件使用默認值和工作。將記錄檔上傳至 CloudWatch 記錄檔時，透過設定的網路 Proxy 正確路由傳送流量。正確處理記錄資料流名稱中的冒號字元 (`:`)。 CloudWatch 記錄檔資料流名稱不支援冒號。從記錄串流中移除物件群組名稱，以簡化記錄資料流名稱。移除在正常行為期間列印的錯誤記錄訊息。
2.0.x	初始版本。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

本機除錯主控台

機器學習元件