本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 日誌管理員
**警告**
我們建議您升級至 Log Manager 2.3.5 版或更新版本。2.3.5 版可最佳化 Log Manager 組態寫入、降低 IO 操作並改善日誌上傳速度、整體裝置效能，以及可能延長的裝置生命週期。
日誌管理員元件 (`aws.greengrass.LogManager`) 會將日誌從 AWS IoT Greengrass 核心裝置上傳至 Amazon CloudWatch Logs。您可以從 Greengrass 核、其他 Greengrass 元件，以及其他非 Greengrass 元件的應用程式和服務上傳日誌。如需如何在 CloudWatch Logs 和本機檔案系統上監控日誌的詳細資訊，請參閱 [監控 AWS IoT Greengrass 日誌](monitor-logs.md)。
當您使用日誌管理員元件寫入 CloudWatch Logs 時，適用下列考量：
+ **日誌延遲**
日誌管理員元件 2.2.8 版 （及更舊版本） 只會從輪換的日誌檔案處理和上傳日誌。根據預設， AWS IoT Greengrass 核心軟體會每小時輪換日誌檔案，或在它們為 1，024 KB 之後輪換日誌檔案。因此，日誌管理員元件只會在 AWS IoT Greengrass Core 軟體或 Greengrass 元件寫入超過 1，024 KB 的日誌之後上傳日誌。您可以設定較低的日誌檔案大小限制，讓日誌檔案更頻繁地輪換。這會導致日誌管理員元件更頻繁地將日誌上傳至 CloudWatch Logs。
日誌管理員元件 2.3.0 版 （及更新版本） 會處理和上傳所有日誌。當您撰寫新的日誌時，日誌管理員 2.3.0 版 （及更新版本） 會處理並直接上傳該作用中日誌檔案，而不是等待輪換。這表示您可以在 5 分鐘內檢視新日誌。
日誌管理員元件會定期上傳新日誌。根據預設，日誌管理員元件會每 5 分鐘上傳新日誌。您可以設定較低的上傳間隔，讓日誌管理員元件透過設定 ，更頻繁地將日誌上傳至 CloudWatch Logs`periodicUploadIntervalSec`。如需如何設定此定期間隔的詳細資訊，請參閱[組態](https://docs.aws.amazon.com/greengrass/v2/developerguide/log-manager-component.html#log-manager-component-configuration)。
日誌可以近乎即時地從相同的 Greengrass 檔案系統上傳。如果您需要即時觀察日誌，請考慮使用[檔案系統日誌](monitor-logs.md#access-local-logs)。
**注意**
如果您使用不同的檔案系統來寫入日誌，日誌管理員會還原為日誌管理員元件 2.2.8 版和更早版本中的行為。如需有關存取檔案系統日誌的資訊，請參閱[存取檔案系統日誌](https://docs.aws.amazon.com/greengrass/v2/developerguide/monitor-logs.html#access-local-logs)。
+ **時鐘扭曲**
日誌管理員元件使用標準 Signature 第 4 版簽署程序來建立對 CloudWatch Logs 的 API 請求。如果核心裝置上的系統時間不同步超過 15 分鐘，則 CloudWatch Logs 會拒絕請求。如需詳細資訊，請參閱 *AWS 一般參考* 中的 [Signature 第 4 版簽署程序](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)。
如需此元件上傳日誌之日誌群組和日誌串流的相關資訊，請參閱 [Usage](#log-manager-component-usage)。
**Topics**
+ [版本](#log-manager-component-versions)
+ [Type](#log-manager-component-type)
+ [作業系統](#log-manager-component-os-support)
+ [要求](#log-manager-component-requirements)
+ [相依性](#log-manager-component-dependencies)
+ [Configuration](#log-manager-component-configuration)
+ [Usage](#log-manager-component-usage)
+ [本機日誌檔案](#log-manager-component-log-file)
+ [變更記錄](#log-manager-component-changelog)
## 版本
此元件具有下列版本：
+ 2.3.x 版本
+ 2.2.x 版本
+ 2.1.x
+ 2.0.x
## Type
此元件是外掛程式元件 (`aws.greengrass.plugin`)。[Greengrass 核心](greengrass-nucleus-component.md)會在與核心相同的 Java 虛擬機器 (JVM) 中執行此元件。當您在核心裝置上變更此元件的版本時，核會重新啟動。
此元件使用與 Greengrass 核相同的日誌檔案。如需詳細資訊，請參閱[監控 AWS IoT Greengrass 日誌](monitor-logs.md)。
如需詳細資訊，請參閱[元件類型](develop-greengrass-components.md#component-types)。
## 作業系統
此元件可以安裝在執行下列作業系統的核心裝置上：
+ Linux
+ Windows
## 要求
此元件有下列需求：
+ [Greengrass 裝置角色](device-service-role.md)必須允許 `logs:CreateLogGroup`、`logs:PutLogEvents`、 `logs:CreateLogStream`和 `logs:DescribeLogStreams`動作，如下列範例 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 裝置角色](device-service-role.md)包含此範例政策中的許可。
如需詳細資訊，請參閱《Amazon [ CloudWatch Logs 使用者指南》中的針對 CloudWatch Logs 使用身分型政策 (IAM 政策）](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-identity-based-access-control-cwl.html)。 *Amazon CloudWatch *
+ 日誌管理員元件支援在 VPC 中執行。若要在 VPC 中部署此元件，需要下列項目。
+ 日誌管理員元件必須具有`logs.region.amazonaws.com`具有 VPC 端點 的連線`com.amazonaws.us-east-1.logs`能力。
### 端點和連接埠
除了基本操作所需的端點和連接埠之外，此元件還必須能夠對下列端點和連接埠執行傳出請求。如需詳細資訊，請參閱[允許透過代理或防火牆的裝置流量](allow-device-traffic.md)。
| Endpoint | 站點 | 必要 | Description |
| --- | --- | --- | --- |
| `logs.region.amazonaws.com` | 443 | 否 | 如果您將日誌寫入 CloudWatch Logs，則為必要項目。 |
## 相依性
當您部署元件時， AWS IoT Greengrass 也會部署其相依性的相容版本。這表示您必須符合元件及其所有相依性的要求，才能成功部署元件。本節列出此元件[發行版本的](#log-manager-component-changelog)相依性，以及為每個相依性定義元件版本的語意版本限制。您也可以在 [AWS IoT Greengrass 主控台](https://console.aws.amazon.com//greengrass)中檢視每個版本元件的相依性。在元件詳細資訊頁面上，尋找**相依性**清單。
------
#### [ 2.3.11 ]
下表列出此元件 2.3.11 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.17.0 | 軟式 |
------
#### [ 2.3.10 ]
下表列出此元件 2.3.10 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.16.0 | 軟式 |
------
#### [ 2.3.9 ]
下表列出此元件 2.3.9 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.15.0 | 軟式 |
------
#### [ 2.3.8 ]
下表列出此元件 2.3.8 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.14.0 | 軟式 |
------
#### [ 2.3.7 ]
下表列出此元件 2.3.7 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.13.0 | 軟式 |
------
#### [ 2.3.5 and 2.3.6 ]
下表列出此元件 2.3.5 和 2.3.6 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.12.0 | 軟式 |
------
#### [ 2.3.3 – 2.3.4 ]
下表列出此元件 2.3.3 至 2.3.4 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.11.0 | 軟式 |
------
#### [ 2.2.8 – 2.3.2 ]
下表列出此元件 2.2.8 至 2.3.2 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.10.0 | 軟式 |
------
#### [ 2.2.7 ]
下表列出此元件 2.2.7 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.9.0 | 軟式 |
------
#### [ 2.2.6 ]
下表列出此元件 2.2.6 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.8.0 | 軟式 |
------
#### [ 2.2.5 ]
下表列出此元件 2.2.5 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.7.0 | 軟式 |
------
#### [ 2.2.1 - 2.2.4 ]
下表列出此元件 2.2.1 - 2.2.4 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.6.0 | 軟式 |
------
#### [ 2.1.3 and 2.2.0 ]
下表列出此元件 2.1.3 和 2.2.0 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.5.0 | 軟式 |
------
#### [ 2.1.2 ]
下表列出此元件 2.1.2 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.4.0 | 軟式 |
------
#### [ 2.1.1 ]
下表列出此元件 2.1.1 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.3.0 | 軟式 |
------
#### [ 2.1.0 ]
下表列出此元件 2.1.0 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.1.0 <2.2.0 | 軟式 |
------
#### [ 2.0.x ]
下表列出此元件 2.0.x 版的相依性。
| 相依性 | 相容版本 | 相依性類型 |
| --- | --- | --- |
| [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.3 <2.1.0 | 軟式 |
------
如需元件相依性的詳細資訊，請參閱[元件配方參考](component-recipe-reference.md#recipe-reference-component-dependencies)。
## Configuration
此元件提供下列組態參數，您可以在部署元件時自訂這些參數。
------
#### [ v2.3.10 ]
`logsUploaderConfiguration`
（選用） 日誌管理員元件上傳之日誌的組態。此物件包含下列資訊：
`systemLogsConfiguration`
（選用） AWS IoT Greengrass 核心軟體系統日誌的組態，其中包含來自 [Greengrass 核](greengrass-nucleus-component.md)和[外掛程式元件](develop-greengrass-components.md#component-types)的日誌。指定此組態，讓日誌管理員元件能夠管理系統日誌。此物件包含下列資訊：
`uploadToCloudWatch`
（選用） 您可以將系統日誌上傳至 CloudWatch Logs。
預設：`false`
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。此最低層級僅適用於您將 [Greengrass 核元件](greengrass-nucleus-component.md)設定為輸出 JSON 格式日誌的情況。若要啟用 JSON 格式日誌，請`JSON`為[記錄格式](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-logging-format)參數 () 指定 `logging.format`。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） Greengrass 系統日誌檔案的總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。在 Greengrass 系統日誌檔案的總大小超過此總大小上限之後， AWS IoT Greengrass Core 軟體會刪除最舊的 Greengrass 系統日誌檔案。
此參數等同於 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`)。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為 Greengrass 系統日誌大小總計上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`componentLogsConfigurationMap`
（選用） 核心裝置上元件的日誌組態映射。此映射中的每個`componentName`物件都會定義元件或應用程式的日誌組態。日誌管理員元件會將這些元件日誌上傳至 CloudWatch Logs。
我們強烈建議每個元件使用單一組態金鑰。您只能將只有一個日誌檔案在使用 時主動寫入的一組檔案設為目標`logFileRegex`。未遵循此建議可能會導致重複的日誌上傳到 CloudWatch。如果您以單一 regex 鎖定多個作用中日誌檔案，建議您升級至 log Manager v2.3.1 或更新版本，並考慮使用[範例組態變更您的組態](#log-manager-multiple-logs-v2.3.10)。
如果您要從 v2.2.0 之前的日誌管理員版本升級，您可以繼續使用`componentLogsConfiguration`清單，而不是 `componentLogsConfigurationMap`。不過，我們強烈建議您使用映射格式，以便您可以使用合併和重設更新來修改特定元件的組態。如需 `componentLogsConfiguration` 參數的相關資訊，請參閱此元件 v2.1.x 的組態參數。
*`componentName`*
此日誌組態之*`componentName`*元件或應用程式的日誌組態。您可以指定 Greengrass 元件的名稱或其他值來識別此日誌群組。
每個物件都包含下列資訊：
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。此最低層級僅適用於此元件的日誌使用特定的 JSON 格式時，您可以在 GitHub 上的[AWS IoT Greengrass 記錄模組](https://github.com/aws-greengrass/aws-greengrass-logging-java)儲存庫中找到該格式。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） 此元件的所有日誌檔案總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。此元件日誌檔案的總大小超過此總大小上限後， AWS IoT Greengrass 核心軟體會刪除此元件最舊的日誌檔案。
此參數與 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`) 有關。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為此元件的總日誌大小上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`logFileDirectoryPath`
（選用） 包含此元件日誌檔案之資料夾的路徑。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
預設：`/greengrass/v2/logs`。
`logFileRegex`
（選用） 規則表達式，指定元件或應用程式使用的日誌檔案名稱格式。日誌管理員元件使用此規則表達式來識別 資料夾中的日誌檔案`logFileDirectoryPath`。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
如果您的元件或應用程式輪換日誌檔案，請指定符合輪換日誌檔案名稱的 regex。例如，您可以指定 **hello\$1world\$1\$1\$1\$1w\$1.log**上傳 Hello World 應用程式的日誌。`\\\\w*` 模式符合零個或多個單字字元，其中包含英數字元和底線。此 regex 會比對名稱中含和不含時間戳記的日誌檔案。在此範例中，日誌管理員會上傳下列日誌檔案：
+ `hello_world.log` – Hello World 應用程式的最新日誌檔案。
+ `hello_world_2020_12_15_17_0.log` – Hello World 應用程式的較舊日誌檔案。
預設：`componentName\\\\w*.log`，其中 *componentName* 是此日誌組態的元件名稱。
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`multiLineStartPattern`
（選用） 規則表達式，可識別新行上的日誌訊息何時是新的日誌訊息。如果規則表達式不符合新行，日誌管理員元件會將新行附加到上一行的日誌訊息。
根據預設，日誌管理員元件會檢查該行是否以空格字元開頭，例如標籤或空格。如果沒有，日誌管理員會將該行視為新的日誌訊息處理。否則，它會將該行附加到目前的日誌訊息。此行為可確保日誌管理員元件不會分割跨越多行的訊息，例如堆疊追蹤。
`periodicUploadIntervalSec`
（選用） 以秒為單位的期間，日誌管理員元件會檢查要上傳的新日誌檔案。
預設：`300`(5 分鐘）
下限：`0.000001`(1 微秒）
`updateToTlogIntervalSec`
（選用） 以秒為單位的期間，表示 nucleus 將 Amazon CloudWatch Events 日誌上傳事件詳細資訊寫入本機交易日誌 () 的頻率`config.tlog`。預設為 中指定的值`periodicUploadIntervalSec`。您可以修改此參數來增加寫入間隔。
預設：`periodicUploadIntervalSec`
下限：`periodicUploadIntervalSec`
`deprecatedVersionSupport`
指出日誌管理員是否應使用日誌管理員 v2.3.5 中引入的記錄速度改進。將 值設定為 `false`以使用改進。
當您從日誌管理員 v2.3.1 或更早的重複日誌項目升級`false`時，如果您將此值設定為 ，則可能會上傳重複的日誌項目。
預設值為 `true`。
**Example 範例：組態合併更新**
下列範例組態指定 將系統日誌和`com.example.HelloWorld`元件日誌上傳至 CloudWatch Logs。
```
{
"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"
}
```
**Example 範例：使用 Log Manager 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.6 – v2.3.9 ]
`logsUploaderConfiguration`
（選用） 日誌管理員元件上傳之日誌的組態。此物件包含下列資訊：
`systemLogsConfiguration`
（選用） AWS IoT Greengrass 核心軟體系統日誌的組態，其中包含來自 [Greengrass 核](greengrass-nucleus-component.md)和[外掛程式元件](develop-greengrass-components.md#component-types)的日誌。指定此組態，讓日誌管理員元件能夠管理系統日誌。此物件包含下列資訊：
`uploadToCloudWatch`
（選用） 您可以將系統日誌上傳至 CloudWatch Logs。
預設：`false`
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。只有在您將 [Greengrass 核元件](greengrass-nucleus-component.md)設定為輸出 JSON 格式日誌時，才會套用此最低層級。若要啟用 JSON 格式日誌，請`JSON`為[記錄格式](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-logging-format)參數 () 指定 `logging.format`。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） Greengrass 系統日誌檔案的總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。在 Greengrass 系統日誌檔案的總大小超過此總大小上限之後， AWS IoT Greengrass Core 軟體會刪除最舊的 Greengrass 系統日誌檔案。
此參數等同於 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`)。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為 Greengrass 系統日誌大小總計上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`componentLogsConfigurationMap`
（選用） 核心裝置上元件的日誌組態映射。此映射中的每個`componentName`物件都會定義元件或應用程式的日誌組態。日誌管理員元件會將這些元件日誌上傳至 CloudWatch Logs。
我們強烈建議每個元件使用單一組態金鑰。您只能將只有一個日誌檔案在使用 時主動寫入的一組檔案設為目標`logFileRegex`。未遵循此建議可能會導致重複的日誌上傳到 CloudWatch。如果您以單一 regex 鎖定多個作用中日誌檔案，建議您升級至 log Manager v2.3.1 或更新版本，並考慮使用[範例組態變更您的組態](#log-manager-multiple-logs-v2.3.1)。
如果您要從 v2.2.0 之前的日誌管理員版本升級，您可以繼續使用`componentLogsConfiguration`清單，而不是 `componentLogsConfigurationMap`。不過，我們強烈建議您使用映射格式，以便您可以使用合併和重設更新來修改特定元件的組態。如需 `componentLogsConfiguration` 參數的相關資訊，請參閱此元件 v2.1.x 的組態參數。
*`componentName`*
此日誌組態之*`componentName`*元件或應用程式的日誌組態。您可以指定 Greengrass 元件的名稱或其他值來識別此日誌群組。
每個物件都包含下列資訊：
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。此最低層級僅適用於此元件的日誌使用特定的 JSON 格式時，您可以在 GitHub 上的[AWS IoT Greengrass 記錄模組](https://github.com/aws-greengrass/aws-greengrass-logging-java)儲存庫中找到該格式。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） 此元件的所有日誌檔案總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。此元件日誌檔案的總大小超過此總大小上限後， AWS IoT Greengrass 核心軟體會刪除此元件最舊的日誌檔案。
此參數與 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`) 有關。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為此元件的總日誌大小上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`logFileDirectoryPath`
（選用） 包含此元件日誌檔案之資料夾的路徑。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
預設：`/greengrass/v2/logs`。
`logFileRegex`
（選用） 規則表達式，指定元件或應用程式使用的日誌檔案名稱格式。日誌管理員元件使用此規則表達式來識別 資料夾中的日誌檔案`logFileDirectoryPath`。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
如果您的元件或應用程式輪換日誌檔案，請指定符合輪換日誌檔案名稱的 regex。例如，您可以指定 **hello\$1world\$1\$1\$1\$1w\$1.log**上傳 Hello World 應用程式的日誌。`\\\\w*` 模式符合零個或多個單字字元，其中包含英數字元和底線。此 regex 會比對名稱中含和不含時間戳記的日誌檔案。在此範例中，日誌管理員會上傳下列日誌檔案：
+ `hello_world.log` – Hello World 應用程式的最新日誌檔案。
+ `hello_world_2020_12_15_17_0.log` – Hello World 應用程式的較舊日誌檔案。
預設：`componentName\\\\w*.log`，其中 *componentName* 是此日誌組態的元件名稱。
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`multiLineStartPattern`
（選用） 規則表達式，可識別新行上的日誌訊息何時是新的日誌訊息。如果規則表達式不符合新行，日誌管理員元件會將新行附加到上一行的日誌訊息。
根據預設，日誌管理員元件會檢查該行是否以空格字元開頭，例如標籤或空格。如果沒有，日誌管理員會將該行視為新的日誌訊息處理。否則，它會將該行附加到目前的日誌訊息。此行為可確保日誌管理員元件不會分割跨越多行的訊息，例如堆疊追蹤。
`periodicUploadIntervalSec`
（選用） 以秒為單位的期間，日誌管理員元件會檢查要上傳的新日誌檔案。
預設：`300`(5 分鐘）
下限：`0.000001`(1 微秒）
`deprecatedVersionSupport`
指出日誌管理員是否應使用日誌管理員 v2.3.5 中引入的記錄速度改進。將 值設定為 `false`以使用改進。
當您從日誌管理員 v2.3.1 或更早的重複日誌項目升級`false`時，如果您將此值設定為 ，則可能會上傳重複的日誌項目。
預設值為 `true`。
**Example 範例：組態合併更新**
下列範例組態指定 將系統日誌和`com.example.HelloWorld`元件日誌上傳至 CloudWatch Logs。
```
{
"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"
}
```
**Example 範例：使用 Log Manager 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.0 – 2.3.5 ]
`logsUploaderConfiguration`
（選用） 日誌管理員元件上傳之日誌的組態。此物件包含下列資訊：
`systemLogsConfiguration`
（選用） AWS IoT Greengrass 核心軟體系統日誌的組態，其中包含來自 [Greengrass 核](greengrass-nucleus-component.md)和[外掛程式元件](develop-greengrass-components.md#component-types)的日誌。指定此組態，讓日誌管理員元件能夠管理系統日誌。此物件包含下列資訊：
`uploadToCloudWatch`
（選用） 您可以將系統日誌上傳至 CloudWatch Logs。
預設：`false`
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。只有在您將 [Greengrass 核元件](greengrass-nucleus-component.md)設定為輸出 JSON 格式日誌時，才會套用此最低層級。若要啟用 JSON 格式日誌，請`JSON`為[記錄格式](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-logging-format)參數 () 指定 `logging.format`。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） Greengrass 系統日誌檔案的總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。在 Greengrass 系統日誌檔案的總大小超過此總大小上限之後， AWS IoT Greengrass Core 軟體會刪除最舊的 Greengrass 系統日誌檔案。
此參數等同於 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`)。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為 Greengrass 系統日誌大小總計上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`componentLogsConfigurationMap`
（選用） 核心裝置上元件的日誌組態映射。此映射中的每個`componentName`物件都會定義元件或應用程式的日誌組態。日誌管理員元件會將這些元件日誌上傳至 CloudWatch Logs。
我們強烈建議每個元件使用單一組態金鑰。您只能將只有一個日誌檔案在使用 時主動寫入的一組檔案設為目標`logFileRegex`。未遵循此建議可能會導致重複的日誌上傳到 CloudWatch。如果您以單一 regex 鎖定多個作用中日誌檔案，建議您升級至 log Manager v2.3.1，並考慮使用[範例組態變更您的組態](#log-manager-multiple-logs-v2.3.1)。
如果您要從 v2.2.0 之前的日誌管理員版本升級，您可以繼續使用`componentLogsConfiguration`清單，而不是 。 `componentLogsConfigurationMap`不過，我們強烈建議您使用映射格式，以便您可以使用合併和重設更新來修改特定元件的組態。如需 `componentLogsConfiguration` 參數的相關資訊，請參閱此元件 v2.1.x 的組態參數。
*`componentName`*
此日誌組態之*`componentName`*元件或應用程式的日誌組態。您可以指定 Greengrass 元件的名稱或其他值來識別此日誌群組。
每個物件都包含下列資訊：
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。此最低層級僅適用於此元件的日誌使用特定的 JSON 格式時，您可以在 GitHub 上的[AWS IoT Greengrass 記錄模組](https://github.com/aws-greengrass/aws-greengrass-logging-java)儲存庫中找到該格式。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） 您在 中指定的單位中，此元件所有日誌檔案的總大小上限`diskSpaceLimitUnit`。此元件日誌檔案的總大小超過此總大小上限後， AWS IoT Greengrass 核心軟體會刪除此元件最舊的日誌檔案。
此參數與 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`) 有關。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為此元件的總日誌大小上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`logFileDirectoryPath`
（選用） 包含此元件日誌檔案之資料夾的路徑。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
預設：`/greengrass/v2/logs`。
`logFileRegex`
（選用） 規則表達式，指定元件或應用程式使用的日誌檔案名稱格式。日誌管理員元件使用此規則表達式來識別 資料夾中的日誌檔案`logFileDirectoryPath`。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
如果您的元件或應用程式輪換日誌檔案，請指定符合輪換日誌檔案名稱的 regex。例如，您可以指定 **hello\$1world\$1\$1\$1\$1w\$1.log**上傳 Hello World 應用程式的日誌。`\\\\w*` 模式符合零個或多個單字字元，其中包含英數字元和底線。此 regex 會比對名稱中具有和沒有時間戳記的日誌檔案。在此範例中，日誌管理員會上傳下列日誌檔案：
+ `hello_world.log` – Hello World 應用程式的最新日誌檔案。
+ `hello_world_2020_12_15_17_0.log` – Hello World 應用程式的較舊日誌檔案。
預設：`componentName\\\\w*.log`，其中 *componentName* 是此日誌組態的元件名稱。
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`multiLineStartPattern`
（選用） 規則表達式，可識別新行上的日誌訊息何時是新的日誌訊息。如果規則表達式不符合新行，日誌管理員元件會將新行附加到前一行的日誌訊息。
根據預設，日誌管理員元件會檢查該行是否以空格字元開頭，例如標籤或空格。如果沒有，日誌管理員會將該行視為新的日誌訊息處理。否則，它會將該行附加到目前的日誌訊息。此行為可確保日誌管理員元件不會分割跨越多行的訊息，例如堆疊追蹤。
`periodicUploadIntervalSec`
（選用） 以秒為單位的期間，日誌管理員元件會檢查要上傳的新日誌檔案。
預設：`300`(5 分鐘）
最小值：`0.000001`(1 微秒）
**Example 範例：組態合併更新**
下列範例組態指定 將系統日誌和`com.example.HelloWorld`元件日誌上傳至 CloudWatch Logs。
```
{
"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"
}
```
**Example 範例：使用 Log Manager 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.2.x ]
`logsUploaderConfiguration`
（選用） 日誌管理員元件上傳之日誌的組態。此物件包含下列資訊：
`systemLogsConfiguration`
（選用） AWS IoT Greengrass 核心軟體系統日誌的組態，其中包含來自 [Greengrass 核](greengrass-nucleus-component.md)和[外掛程式元件](develop-greengrass-components.md#component-types)的日誌。指定此組態，讓日誌管理員元件能夠管理系統日誌。此物件包含下列資訊：
`uploadToCloudWatch`
（選用） 您可以將系統日誌上傳至 CloudWatch Logs。
預設：`false`
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。只有在您將 [Greengrass 核元件](greengrass-nucleus-component.md)設定為輸出 JSON 格式日誌時，才會套用此最低層級。若要啟用 JSON 格式日誌，請`JSON`為[記錄格式](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-logging-format)參數 () 指定 `logging.format`。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） Greengrass 系統日誌檔案的總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。在 Greengrass 系統日誌檔案的總大小超過此總大小上限之後， AWS IoT Greengrass Core 軟體會刪除最舊的 Greengrass 系統日誌檔案。
此參數等同於 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`)。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為 Greengrass 系統日誌大小總計上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`componentLogsConfigurationMap`
（選用） 核心裝置上元件的日誌組態映射。此映射中的每個`componentName`物件都會定義元件或應用程式的日誌組態。日誌管理員元件會將這些元件日誌上傳至 CloudWatch Logs。
如果您要從 v2.2.0 之前的日誌管理員版本升級，您可以繼續使用`componentLogsConfiguration`清單，而不是 。 `componentLogsConfigurationMap`不過，我們強烈建議您使用映射格式，以便您可以使用合併和重設更新來修改特定元件的組態。如需 `componentLogsConfiguration` 參數的相關資訊，請參閱此元件 v2.1.x 的組態參數。
*`componentName`*
此日誌組態之*`componentName`*元件或應用程式的日誌組態。您可以指定 Greengrass 元件的名稱或其他值來識別此日誌群組。
每個物件都包含下列資訊：
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。此最低層級僅適用於此元件的日誌使用特定的 JSON 格式時，您可以在 GitHub 上的[AWS IoT Greengrass 記錄模組](https://github.com/aws-greengrass/aws-greengrass-logging-java)儲存庫中找到該格式。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） 此元件的所有日誌檔案總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。此元件日誌檔案的總大小超過此總大小上限後， AWS IoT Greengrass 核心軟體會刪除此元件最舊的日誌檔案。
此參數與 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`) 有關。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為此元件的總日誌大小上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`logFileDirectoryPath`
（選用） 包含此元件日誌檔案的資料夾路徑。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
預設：`/greengrass/v2/logs`。
`logFileRegex`
（選用） 規則表達式，指定元件或應用程式使用的日誌檔案名稱格式。日誌管理員元件使用此規則表達式來識別 資料夾中的日誌檔案`logFileDirectoryPath`。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
如果您的元件或應用程式輪換日誌檔案，請指定符合輪換日誌檔案名稱的 regex。例如，您可以指定 **hello\$1world\$1\$1\$1\$1w\$1.log**上傳 Hello World 應用程式的日誌。`\\\\w*` 模式符合零個或多個單字字元，其中包含英數字元和底線。此 regex 會比對名稱中含和不含時間戳記的日誌檔案。在此範例中，日誌管理員會上傳下列日誌檔案：
+ `hello_world.log` – Hello World 應用程式的最新日誌檔案。
+ `hello_world_2020_12_15_17_0.log` – Hello World 應用程式的較舊日誌檔案。
預設：`componentName\\\\w*.log`，其中 *componentName* 是此日誌組態的元件名稱。
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`multiLineStartPattern`
（選用） 規則表達式，可識別新行上的日誌訊息何時是新的日誌訊息。如果規則表達式不符合新行，日誌管理員元件會將新行附加到前一行的日誌訊息。
根據預設，日誌管理員元件會檢查該行是否以空格字元開頭，例如標籤或空格。如果沒有，日誌管理員會將該行視為新的日誌訊息處理。否則，它會將該行附加到目前的日誌訊息。此行為可確保日誌管理員元件不會分割跨越多行的訊息，例如堆疊追蹤。
`periodicUploadIntervalSec`
（選用） 以秒為單位的期間，日誌管理員元件會檢查要上傳的新日誌檔案。
預設：`300`(5 分鐘）
下限：`0.000001`(1 微秒）
**Example 範例：組態合併更新**
下列範例組態指定 將系統日誌和`com.example.HelloWorld`元件日誌上傳至 CloudWatch Logs。
```
{
"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`
（選用） AWS IoT Greengrass 核心軟體系統日誌的組態，其中包含來自 [Greengrass 核](greengrass-nucleus-component.md)和[外掛程式元件](develop-greengrass-components.md#component-types)的日誌。指定此組態，讓日誌管理員元件能夠管理系統日誌。此物件包含下列資訊：
`uploadToCloudWatch`
（選用） 您可以將系統日誌上傳至 CloudWatch Logs。
預設：`false`
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。只有在您將 [Greengrass 核元件](greengrass-nucleus-component.md)設定為輸出 JSON 格式日誌時，才會套用此最低層級。若要啟用 JSON 格式日誌，請`JSON`為[記錄格式](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-logging-format)參數 () 指定 `logging.format`。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） Greengrass 系統日誌檔案的總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。在 Greengrass 系統日誌檔案的總大小超過此總大小上限之後， AWS IoT Greengrass Core 軟體會刪除最舊的 Greengrass 系統日誌檔案。
此參數等同於 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`)。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為 Greengrass 系統日誌大小總計上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`componentLogsConfiguration`
（選用） 核心裝置上元件的日誌組態清單。此清單中的每個組態都會定義元件或應用程式的日誌組態。日誌管理員元件會將這些元件日誌上傳至 CloudWatch Logs
每個物件都包含下列資訊：
`componentName`
此日誌組態的元件或應用程式名稱。您可以指定 Greengrass 元件的名稱或其他值來識別此日誌群組。
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。此最低層級僅適用於此元件的日誌使用特定的 JSON 格式，您可以在 GitHub 的記錄[AWS IoT Greengrass 模組](https://github.com/aws-greengrass/aws-greengrass-logging-java)儲存庫中找到該格式。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） 此元件的所有日誌檔案總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。此元件日誌檔案的總大小超過此總大小上限後， AWS IoT Greengrass 核心軟體會刪除此元件最舊的日誌檔案。
此參數與 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`) 有關。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為此元件的總日誌大小上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`logFileDirectoryPath`
（選用） 包含此元件日誌檔案的資料夾路徑。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
預設：`/greengrass/v2/logs`。
`logFileRegex`
（選用） 規則表達式，指定元件或應用程式使用的日誌檔案名稱格式。日誌管理員元件使用此規則表達式來識別 資料夾中的日誌檔案`logFileDirectoryPath`。
您不需要為列印為標準輸出 (stdout) 和標準錯誤 (stderr) 的 Greengrass 元件指定此參數。
如果您的元件或應用程式輪換日誌檔案，請指定符合輪換日誌檔案名稱的 regex。例如，您可以指定 **hello\$1world\$1\$1\$1\$1w\$1.log**上傳 Hello World 應用程式的日誌。`\\\\w*` 模式符合零個或多個單字字元，其中包含英數字元和底線。此 regex 會比對名稱中含和不含時間戳記的日誌檔案。在此範例中，日誌管理員會上傳下列日誌檔案：
+ `hello_world.log` – Hello World 應用程式的最新日誌檔案。
+ `hello_world_2020_12_15_17_0.log` – Hello World 應用程式的較舊日誌檔案。
預設：`componentName\\\\w*.log`，其中 *componentName* 是此日誌組態的元件名稱。
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`multiLineStartPattern`
（選用） 規則表達式，可識別新行上的日誌訊息何時是新的日誌訊息。如果規則表達式不符合新行，日誌管理員元件會將新行附加到前一行的日誌訊息。
根據預設，日誌管理員元件會檢查該行是否以空格字元開頭，例如標籤或空格。如果沒有，日誌管理員會將該行視為新的日誌訊息處理。否則，它會將該行附加到目前的日誌訊息。此行為可確保日誌管理員元件不會分割跨越多行的訊息，例如堆疊追蹤。
`periodicUploadIntervalSec`
（選用） 以秒為單位的期間，日誌管理員元件會檢查要上傳的新日誌檔案。
預設：`300`(5 分鐘）
下限：`0.000001`(1 微秒）
**Example 範例：組態合併更新**
下列範例組態指定 將系統日誌和`com.example.HelloWorld`元件日誌上傳至 CloudWatch Logs。
```
{
"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 核心軟體系統日誌的組態。指定此組態，讓日誌管理員元件能夠管理系統日誌。此物件包含下列資訊：
`uploadToCloudWatch`
（選用） 您可以將系統日誌上傳至 CloudWatch Logs。
預設：`false`
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。只有在您將 [Greengrass 核元件](greengrass-nucleus-component.md)設定為輸出 JSON 格式日誌時，才會套用此最低層級。若要啟用 JSON 格式日誌，請`JSON`為[記錄格式](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-logging-format)參數 () 指定 `logging.format`。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） Greengrass 系統日誌檔案的總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。在 Greengrass 系統日誌檔案的總大小超過此總大小上限之後， AWS IoT Greengrass Core 軟體會刪除最舊的 Greengrass 系統日誌檔案。
此參數等同於 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`)。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為 Greengrass 系統日誌大小總計上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`componentLogsConfiguration`
（選用） 核心裝置上元件的日誌組態清單。此清單中的每個組態都會定義元件或應用程式的日誌組態。日誌管理員元件會將這些元件日誌上傳至 CloudWatch Logs
每個物件都包含下列資訊：
`componentName`
此日誌組態的元件或應用程式名稱。您可以指定 Greengrass 元件的名稱或其他值來識別此日誌群組。
`minimumLogLevel`
（選用） 要上傳的日誌訊息最低層級。此最低層級僅適用於此元件的日誌使用特定的 JSON 格式時，您可以在 GitHub 上的[AWS IoT Greengrass 記錄模組](https://github.com/aws-greengrass/aws-greengrass-logging-java)儲存庫中找到該格式。
從下列日誌層級中選擇，此處依層級順序列出：
+ `DEBUG`
+ `INFO`
+ `WARN`
+ `ERROR`
預設：`INFO`
`diskSpaceLimit`
（選用） 此元件的所有日誌檔案總大小上限，以您在 中指定的單位表示`diskSpaceLimitUnit`。此元件日誌檔案的總大小超過此總大小上限後， AWS IoT Greengrass 核心軟體會刪除此元件最舊的日誌檔案。
此參數與 [Greengrass 核元件](greengrass-nucleus-component.md)的[日誌大小限制](greengrass-nucleus-component.md#greengrass-nucleus-component-configuration-system-logs-limit)參數 (`totalLogsSizeKB`) 有關。Core AWS IoT Greengrass 軟體會使用兩個值的最小值作為此元件的總日誌大小上限。
`diskSpaceLimitUnit`
（選用） 的單位`diskSpaceLimit`。您可以從以下選項中選擇：
+ `KB` – KB
+ `MB` – MB
+ `GB` – GB
預設：`KB`
`logFileDirectoryPath`
包含此元件日誌檔案的資料夾路徑。
若要上傳 Greengrass 元件的日誌，請指定 **`/greengrass/v2`/logs**，並將 取代`/greengrass/v2`為您的 Greengrass 根資料夾。
`logFileRegex`
規則表達式，指定元件或應用程式使用的日誌檔案名稱格式。日誌管理員元件使用此規則表達式來識別 資料夾中的日誌檔案`logFileDirectoryPath`。
若要上傳 Greengrass 元件的日誌，請指定符合輪換日誌檔案名稱的 regex。例如，您可以指定 **com.example.HelloWorld\$1\$1w\$1.log**上傳 Hello World 元件的日誌。`\\w*` 模式符合零個或多個單字字元，其中包含英數字元和底線。此 regex 會比對名稱中含和不含時間戳記的日誌檔案。在此範例中，日誌管理員會上傳下列日誌檔案：
+ `com.example.HelloWorld.log` – Hello World 元件的最新日誌檔案。
+ `com.example.HelloWorld_2020_12_15_17_0.log` – Hello World 元件的較舊日誌檔案。Greengrass 核將輪換時間戳記新增至日誌檔案。
`deleteLogFileAfterCloudUpload`
（選用） 您可以在日誌管理員元件將日誌上傳至 CloudWatch Logs 後刪除日誌檔案。
預設：`false`
`multiLineStartPattern`
（選用） 規則表達式，可識別新行上的日誌訊息何時是新的日誌訊息。如果規則表達式不符合新行，日誌管理員元件會將新行附加到上一行的日誌訊息。
根據預設，日誌管理員元件會檢查該行是否以空格字元開頭，例如標籤或空格。如果沒有，日誌管理員會將該行視為新的日誌訊息處理。否則，它會將該行附加到目前的日誌訊息。此行為可確保日誌管理員元件不會分割跨越多行的訊息，例如堆疊追蹤。
`periodicUploadIntervalSec`
（選用） 以秒為單位的期間，日誌管理員元件會檢查要上傳的新日誌檔案。
預設：`300`(5 分鐘）
下限：`0.000001`(1 微秒）
**Example 範例：組態合併更新**
下列範例組態指定 將系統日誌和`com.example.HelloWorld`元件日誌上傳至 CloudWatch Logs。
```
{
"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"
}
```
------
## Usage
日誌管理員元件會上傳至下列日誌群組和日誌串流。
------
#### [ 2.1.0 and later ]
**日誌群組名稱**
```
/aws/greengrass/componentType/region/componentName
```
日誌群組名稱使用下列變數：
+ `componentType` – 元件的類型，可以是下列其中一項：
+ `GreengrassSystemComponent` – 此日誌群組包含核心和外掛程式元件的日誌，這些元件在與 Greengrass 核心相同的 JVM 中執行。元件是 [Greengrass 核](greengrass-nucleus-component.md)的一部分。
+ `UserComponent` – 此日誌群組包含一般元件、Lambda 元件和裝置上的其他應用程式的日誌。元件不是 Greengrass 核的一部分。
如需詳細資訊，請參閱[元件類型](develop-greengrass-components.md#component-types)。
+ `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` – 元件是 [Greengrass 核](greengrass-nucleus-component.md)的一部分。
+ `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 核組態](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html#greengrass-nucleus-component-configuration)。
文字格式為自由格式，並接受任何字串。下列機群狀態服務訊息是字串格式化記錄的範例：
```
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 日誌](https://docs.aws.amazon.com/greengrass/v2/developerguide/gg-cli-logs.html)命令檢視日誌或以程式設計方式與日誌互動，您應該使用 JSON 格式。下列範例概述 JSON 形狀：
```
{
"loggerName": ,
"level": <"DEBUG" | "INFO" | "ERROR" | "TRACE" | "WARN">,
"eventType": ,
"cause": ,
"contexts": {},
"thread": ,
"message": ,
"timestamp": # Needs to be epoch time
}
```
若要控制元件日誌的輸出，您可以使用 `minimumLogLevel`組態選項。若要使用此選項，您的元件必須以 JSON 格式寫入其日誌項目。您應該使用與系統日誌檔案相同的格式。
## 本機日誌檔案
此元件使用與 [Greengrass 核](greengrass-nucleus-component.md)元件相同的日誌檔案。
------
#### [ Linux ]
```
/greengrass/v2/logs/greengrass.log
```
------
#### [ Windows ]
```
C:\greengrass\v2\logs\greengrass.log
```
------
**檢視此元件的日誌**
+ 在核心裝置上執行下列命令，以即時檢視此元件的日誌檔案。將 `/greengrass/v2`或 *C：\$1greengrass\$1v2* 取代為 AWS IoT Greengrass 根資料夾的路徑。
------
#### [ Linux ]
```
sudo tail -f /greengrass/v2/logs/greengrass.log
```
------
#### [ Windows (PowerShell) ]
```
Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait
```
------
## 變更記錄
下表說明每個版本元件的變更。
| **版本** | **變更** |
| --- | --- |
| 2.3.11 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.3.10 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.3.9 | 針對 Greengrass nucleus 2.14.0 版更新版本。 |
| 2.3.8 | 針對 Greengrass nucleus 2.13.0 版更新版本。 |
| 2.3.7 | 針對 Greengrass nucleus 2.12.0 版更新版本。 |
| 2.3.6 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.3.5 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) 針對 Greengrass nucleus 2.11.0 版更新版本。 |
| 2.3.4 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.3.3 | 針對 Greengrass nucleus 2.10.0 版更新版本。 |
| 2.3.2 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.3.1 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.3.0 | 當您升級至 log Manager 2.3.0 時，我們建議您升級至 Greengrass 核 2.9.1。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.2.8 | 針對 Greengrass nucleus 2.9.0 版更新版本。 |
| 2.2.7 | 針對 Greengrass nucleus 2.8.0 版更新版本。 |
| 2.2.6 | 針對 Greengrass nucleus 2.7.0 版更新版本。 |
| 2.2.5 | 針對 Greengrass nucleus 2.6.0 版更新版本。 |
| 2.2.4 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.2.3 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.2.2 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.2.1 | 針對 Greengrass nucleus 2.5.0 版更新版本。 |
| 2.2.0 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.1.3 | 針對 Greengrass nucleus 2.4.0 版更新版本。 |
| 2.1.2 | 針對 Greengrass nucleus 2.3.0 版更新版本。 |
| 2.1.1 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.1.0 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/log-manager-component.html) |
| 2.0.x | 初始版本。 |