版本 Type 作業系統要求相依性組態輸入資料輸出資料授權本機日誌檔案變更記錄另請參閱

CloudWatch 指標

Amazon CloudWatch 指標元件 (aws.greengrass.Cloudwatch) 會將自訂指標從 Greengrass 核心裝置發佈至 Amazon CloudWatch。元件可讓元件發佈指標，您可以使用這些 CloudWatch 指標來監控和分析 Greengrass 核心裝置的環境。如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的使用 Amazon 指標。 CloudWatch

若要使用此元件發佈 CloudWatch 指標，請將訊息發佈至此元件訂閱的主題。根據預設，此元件會訂閱cloudwatch/metric/put本機發佈/訂閱主題。您可以在部署此元件時指定其他主題，包括 AWS IoT Core MQTT主題。

此元件會批次處理位於相同命名空間中的指標，並 CloudWatch 定期將其發佈至。

注意

此元件提供與 AWS IoT Greengrass V1 中 CloudWatch 指標連接器類似的功能。如需詳細資訊，請參閱《AWS IoT Greengrass V1 開發人員指南》中的CloudWatch 指標連接器。

版本

此元件具有下列版本：

3.2.x
3.1.x 版本
3.0.x
2.1.x
2.0.x

如需每個版本元件變更的相關資訊，請參閱變更日誌。

Type

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

作業系統

要求

此元件有下列需求：

3.x

Python 3.7 版安裝在核心裝置上，並新增至PATH環境變數。
Greengrass 裝置角色必須允許 cloudwatch:PutMetricData動作，如下列範例IAM政策所示。
```
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": [
        "cloudwatch:PutMetricData"
      ],
      "Effect": "Allow",
      "Resource": "*"
    }
  ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的 Amazon 許可參考。 CloudWatch

2.x

您的核心裝置必須符合執行 Lambda 函數的要求。如果您希望核心裝置執行容器化 Lambda 函數，則裝置必須符合執行此作業的要求。如需詳細資訊，請參閱Lambda 函數需求。
Python 3.7 版安裝在核心裝置上，並新增至PATH環境變數。
Greengrass 裝置角色必須允許 cloudwatch:PutMetricData動作，如下列範例IAM政策所示。
```
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": [
        "cloudwatch:PutMetricData"
      ],
      "Effect": "Allow",
      "Resource": "*"
    }
  ]
}
```
如需詳細資訊，請參閱《Amazon CloudWatch 使用者指南》中的 Amazon 許可參考。 CloudWatch
若要從此元件接收輸出資料，您必須在部署此元件時，合併舊版訂閱路由器元件 (aws.greengrass.LegacySubscriptionRouter) 的下列組態更新。此組態會指定此元件發佈回應的主題。
Legacy subscription router v2.1.xLegacy subscription router v2.0.x
Legacy subscription router v2.1.x
```
{
  "subscriptions": {
    "aws-greengrass-cloudwatch": {
      "id": "aws-greengrass-cloudwatch",
      "source": "component:aws.greengrass.Cloudwatch",
      "subject": "cloudwatch/metric/put/status",
      "target": "cloud"
    }
  }
}
```
Legacy subscription router v2.0.x
```
{
  "subscriptions": {
    "aws-greengrass-cloudwatch": {
      "id": "aws-greengrass-cloudwatch",
      "source": "arn:aws:lambda:region:aws:function:aws-greengrass-cloudwatch:version",
      "subject": "cloudwatch/metric/put/status",
      "target": "cloud"
    }
  }
}
```
region 將取代 AWS 區域為您使用的。

version 以此元件執行的 Lambda 函數版本取代。若要尋找 Lambda 函數版本，您必須檢視要部署之此元件版本的配方。在 AWS IoT Greengrass 主控台中開啟此元件的詳細資訊頁面，並尋找 Lambda 函數鍵/值對。此鍵/值對包含 Lambda 函數的名稱和版本。
重要
每次部署此元件時，都必須更新舊版訂閱路由器上的 Lambda 函數版本。這可確保您使用正確的 Lambda 函數版本來部署元件版本。
如需詳細資訊，請參閱建立部署。

端點和連接埠

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

端點	連線埠	必要	描述
`monitoring.region.amazonaws.com`	443	是	上傳 CloudWatch 指標。

相依性

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

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <3.0.0	軟式
權杖交換服務	>=0.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <3.0.0	軟式
權杖交換服務	>=0.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <3.0.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <3.0.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <2.8.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <2.7.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <2.6.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <2.5.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <2.4.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <2.3.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.0 <2.2.0	硬式
Lambda 啟動器	^2.0.0	硬式
Lambda 執行階段	^2.0.0	軟式
權杖交換服務	^2.0.0	硬式

相依性	相容版本	相依性類型
Greengrass 核	>=2.0.3 <2.1.0	硬式
Lambda 啟動器	>=1.0.0	硬式
Lambda 執行階段	>=1.0.0	軟式
權杖交換服務	>=1.0.0	硬式

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

組態

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

v3.x

PublishInterval

（選用）在元件發佈指定命名空間的批次指標之前等待的秒數上限。若要設定元件在接收時發佈指標，這表示無需批次處理，請指定 0。

元件在相同命名空間中收到 20 個指標 CloudWatch 後，或在您指定的間隔後發佈至。

注意

元件不會指定事件發佈的順序。

此值最多可達 900 秒。

預設：10 秒

MaxMetricsToRetain

（選用）在元件將它們取代為較新的指標之前，所有命名空間中要儲存在記憶體中的指標數量上限。

當核心裝置沒有網際網路連線時，就會套用此限制，因此元件會緩衝稍後發佈的指標。當緩衝區已滿時，元件會將最舊的指標取代為較新的指標。指定命名空間中的指標只會取代相同命名空間中的指標。

注意

如果元件的主機程序中斷，則元件不會儲存指標。例如，這可能會在部署期間或核心裝置重新啟動時發生。

此值必須至少為 2，000 個指標。

預設：5，000 個指標

InputTopic

（選用）元件訂閱接收訊息的主題。如果您true為指定 PubSubToIoTCore，則可以在此主題中使用MQTT萬用字元 (+ 和 #)。

預設：cloudwatch/metric/put

OutputTopic

（選用）元件發佈狀態回應的主題。

預設：cloudwatch/metric/put/status

PubSubToIoTCore

（選用）字串值，定義是否發佈和訂閱 AWS IoT Core MQTT主題。支援的值為 true 和 false。

預設：false

UseInstaller

（選用）布林值，定義是否使用此元件中的安裝程式指令碼來安裝此元件的SDK相依性。

false 如果您想要使用自訂指令碼安裝相依性，或想要在預先建置的 Linux 映像中包含執行時間相依性，請將此值設定為。若要使用此元件，您必須安裝下列程式庫，包括任何相依性，並將其提供給預設的 Greengrass 系統使用者。

預設：true

PublishRegion

（選用）要發佈 CloudWatch 指標 AWS 區域的。此值會覆寫核心裝置的預設區域。只有跨區域指標需要此參數。

accessControl

（選用）包含授權政策的物件，允許元件發佈和訂閱指定的主題。如果您為 InputTopic和指定自訂值OutputTopic，則必須更新此物件中的資源值。

預設：


{
  "aws.greengrass.ipc.pubsub": {
    "aws.greengrass.Cloudwatch:pubsub:1": {
      "policyDescription": "Allows access to subscribe to input topics.",
      "operations": [
        "aws.greengrass#SubscribeToTopic"
      ],
      "resources": [
        "cloudwatch/metric/put"
      ]
    },
    "aws.greengrass.Cloudwatch:pubsub:2": {
      "policyDescription": "Allows access to publish to output topics.",
      "operations": [
        "aws.greengrass#PublishToTopic"
      ],
      "resources": [
        "cloudwatch/metric/put/status"
      ]
    }
  },
  "aws.greengrass.ipc.mqttproxy": {
    "aws.greengrass.Cloudwatch:mqttproxy:1": {
      "policyDescription": "Allows access to subscribe to input topics.",
      "operations": [
        "aws.greengrass#SubscribeToIoTCore"
      ],
      "resources": [
        "cloudwatch/metric/put"
      ]
    },
    "aws.greengrass.Cloudwatch:mqttproxy:2": {
      "policyDescription": "Allows access to publish to output topics.",
      "operations": [
        "aws.greengrass#PublishToIoTCore"
      ],
      "resources": [
        "cloudwatch/metric/put/status"
      ]
    }
  }
}

範例：組態合併更新


{
  "PublishInterval": 0,
  "PubSubToIoTCore": true
}

v2.x

注意

此元件的預設組態包含 Lambda 函數參數。建議您只編輯下列參數，以在裝置上設定此元件。

lambdaParams

包含此元件 Lambda 函數參數的物件。此物件包含下列資訊：

EnvironmentVariables

包含 Lambda 函數參數的物件。此物件包含下列資訊：

PUBLISH_INTERVAL

（選用）在元件發佈指定命名空間的批次指標之前等待的秒數上限。若要設定元件在接收時發佈指標，這表示無需批次處理，請指定 0。

元件在相同命名空間中收到 20 個指標 CloudWatch 後，或在您指定的間隔後，會發佈至。

注意

元件不保證事件發佈的順序。

此值最多可達 900 秒。

預設：10 秒

MAX_METRICS_TO_RETAIN

（選用）元件將指標取代為較新的指標之前，所有命名空間中要儲存在記憶體中的指標數量上限。

當核心裝置沒有網際網路連線時，此限制適用，因此元件會緩衝稍後發佈的指標。當緩衝區已滿時，元件會將最舊的指標取代為較新的指標。指定命名空間中的指標只會取代相同命名空間中的指標。

注意

如果元件的主機程序中斷，則元件不會儲存指標。例如，這可能會在部署期間或核心裝置重新啟動時發生。

此值必須至少為 2，000 個指標。

預設：5，000 個指標

PUBLISH_REGION

（選用）要發佈 CloudWatch 指標 AWS 區域的。此值會覆寫核心裝置的預設區域。只有跨區域指標需要此參數。

containerMode

（選用）此元件的容器化模式。您可以從以下選項中選擇：

NoContainer – 元件不會在隔離的執行時間環境中執行。
GreengrassContainer – 元件會在 AWS IoT Greengrass 容器內的隔離執行期環境中執行。

預設：GreengrassContainer

containerParams

（選用）包含此元件容器參數的物件。如果您GreengrassContainer為指定，元件會使用這些參數containerMode。

此物件包含下列資訊：

memorySize

（選用）要配置給元件的記憶體量（以 KB 為單位）。

預設為 64 MB (65，535 KB)。

pubsubTopics

（選用）物件，其中包含元件訂閱接收訊息的主題。您可以指定每個主題，以及元件是從訂閱MQTT主題， AWS IoT Core 還是從本機發佈/訂閱主題。

此物件包含下列資訊：

0 – 這是做為字串的陣列索引。

包含下列資訊的物件：

type

（選用）此元件用來訂閱訊息的發佈/訂閱訊息類型。您可以從以下選項中選擇：

PUB_SUB - 訂閱本機發佈/訂閱訊息。如果您選擇此選項，主題不能包含MQTT萬用字元。如需在指定此選項時如何從自訂元件傳送訊息的詳細資訊，請參閱發佈/訂閱本機訊息。
IOT_CORE – 訂閱 AWS IoT Core MQTT訊息。如果您選擇此選項，主題可以包含MQTT萬用字元。如需在指定此選項時如何從自訂元件傳送訊息的詳細資訊，請參閱發佈/訂閱 AWS IoT Core MQTT訊息。

預設：PUB_SUB

topic

（選用）元件訂閱接收訊息的主題。如果您IotCore為指定 type，則可以在此主題中使用MQTT萬用字元 (+ 和 #)。

範例：組態合併更新（容器模式）


{
  "containerMode": "GreengrassContainer"
}

範例：組態合併更新（無容器模式）


{
  "containerMode": "NoContainer"
}

輸入資料

此元件接受下列主題的指標，並將指標發佈至 CloudWatch。根據預設，此元件會訂閱本機發佈/訂閱訊息。如需如何從自訂元件發佈訊息至此元件的詳細資訊，請參閱發佈/訂閱本機訊息。

從元件版本 3.0.0 開始，您可以選擇將此元件設定為訂閱MQTT主題，方法是將PubSubToIoTCore組態參數設定為 true。如需將訊息發佈至自訂元件中MQTT主題的詳細資訊，請參閱發佈/訂閱 AWS IoT Core MQTT訊息。

預設主題： cloudwatch/metric/put

訊息接受下列屬性。輸入訊息的JSON格式必須是。

request

此訊息中的指標。

請求物件包含要發佈到 CloudWatch 的指標資料。指標值必須符合 PutMetricData 操作的規格。

類型：object包含下列資訊：

namespace

此 request. 中指標資料的使用者定義命名空間 CloudWatch ，使用命名空間做為指標資料點的容器。

注意

您無法指定以預留字串開頭的命名空間AWS/。

類型：string

有效模式： [^:].*

metricData

指標的資料。

類型：object包含下列資訊：

metricName

指標的名稱

類型：string

value

指標的值。

注意

CloudWatch 拒絕太小或太大的值。值必須介於 8.515920e-109和 1.174271e+108（第 10 條）或 2e-360和 2e360（第 2 條）之間。 CloudWatch 不支援特殊值，例如 NaN、 +Infinity和 -Infinity。

類型：double

dimensions

（選用）指標的維度。維度提供指標及其資料的其他資訊。一個指標可以定義最多 10 個維度。

此元件會自動包含名為的維度coreName，其中值是核心裝置的名稱。

類型： array 的物件，每個物件都包含下列資訊：

name

（選用）維度名稱。

類型：string

value

（選用）維度值。

類型：string

timestamp

（選用）收到指標資料的時間，以秒為單位，以 Unix epoch 時間表示。

預設為元件接收訊息的時間。

類型：double

注意

如果您在此元件的 2.0.3 和 2.0.7 版之間使用，我們建議您從單一來源傳送多個指標時，分別擷取每個指標的時間戳記。請勿使用變數來存放時間戳記。

unit

（選用）指標的單位。

類型：string

有效值：Seconds、Microseconds、Milliseconds、Bytes、Kilobytes、、MegabytesGigabytesTerabytes、BitsKilobits、、Megabits、、Gigabits、Terabits、Percent、CountBytes/Second、Kilobytes/Second、、、Megabytes/Second、、 Gigabytes/Second Terabytes/Second Bits/Second Kilobits/Second Megabits/Second Gigabits/Second Terabits/Second Count/Second None

預設為 None。

注意

套用至 CloudWatch PutMetricData 的所有配額API都會套用至您使用此元件發佈的指標。下列配額特別重要：

API 承載的 40 KB 限制
每個API請求 20 個指標
每秒 150 筆交易 (TPS) PutMetricData API

如需詳細資訊，請參閱CloudWatch 《使用者指南》中的CloudWatch 服務配額。

範例輸入


{
  "request": {
    "namespace": "Greengrass",
    "metricData": {
      "metricName": "latency",
      "dimensions": [
        {
          "name": "hostname",
          "value": "test_hostname"
        }
      ],
      "timestamp": 1539027324,
      "value": 123.0,
      "unit": "Seconds"
    }
  }
}

輸出資料

此元件預設會將回應發佈為下列本機發佈/訂閱主題的輸出資料。如需如何在自訂元件中訂閱此主題訊息的詳細資訊，請參閱發佈/訂閱本機訊息。

您可以選擇將此元件設定為，將PubSubToIoTCore組態參數設定為以發佈至 MQTT主題true。如需訂閱自訂元件中MQTT主題訊息的詳細資訊，請參閱發佈/訂閱 AWS IoT Core MQTT訊息。

注意

元件版本 2.0.x 預設會將回應發佈為MQTT主題上的輸出資料。您必須在舊版訂閱路由器元件的組態subject中，將主題指定為。

預設主題： cloudwatch/metric/put/status

範例輸出：成功

回應包含指標資料的命名空間，以及 CloudWatch 回應中的 RequestId 欄位。


{
  "response": {
    "cloudwatch_rid": "70573243-d723-11e8-b095-75ff2EXAMPLE",
    "namespace": "Greengrass",
    "status": "success"
  }
}

範例輸出：失敗


{
  "response" : {
    "namespace": "Greengrass",
    "error": "InvalidInputException",
    "error_message": "cw metric is invalid",
    "status": "fail"
  }
}

注意

如果元件偵測到可以重試的錯誤，例如連線錯誤，則會在下一個批次中重試發佈。

授權

此元件包含下列第三方軟體/授權：

AWS SDK for Python (Boto3)/Apache License 2.0
botocore/Apache License 2.0
dateutil/PSF 授權
docutils/BSD License、GNU一般公有授權 (GPL)、Python Software Foundation License、公有網域
jmespath/MIT 授權
s3transfer/Apache License 2.0
urllib3/MIT 授權

此元件根據 Greengrass Core 軟體授權合約發行。

本機日誌檔案

此元件使用以下日誌檔案。

檢視此元件的日誌

在核心裝置上執行下列命令，以即時檢視此元件的日誌檔案。將 /greengrass/v2或取代C:\greengrass\v2為 AWS IoT Greengrass 根資料夾的路徑。
Linux
```
sudo tail -f /greengrass/v2/logs/aws.greengrass.Cloudwatch.log
```
Windows (PowerShell)
```
Get-Content C:\greengrass\v2\logs\aws.greengrass.Cloudwatch.log -Tail 10 -Wait
```

變更記錄

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

v3.x

版本	變更
3.2.0	新功能新增 Greengrass nucleus lite 的配方支援
3.1.0	錯誤修正和改善新增對HTTPS網路代理組態的支援。如需詳細資訊，請參閱連線至連接埠 443 或透過網路代理和讓核心裝置信任HTTPS代理。
3.0.0	此版本的 CloudWatch 指標元件預期組態參數與 2.x 版不同。如果您使用 2.x 版的非預設組態，而且想要從 v2.x 升級到 v3.x，則必須更新元件的組態。如需詳細資訊，請參閱CloudWatch指標元件組態。新功能新增對執行 Windows 之核心裝置的支援。將元件類型從 Lambda 元件變更為一般元件。此元件現在不再依賴舊版訂閱路由器元件來建立訂閱。新增新`InputTopic`組態參數，以指定元件訂閱接收訊息的主題。新增新`OutputTopic`組態參數，以指定元件發佈狀態回應的主題。新增新的`PubSubToIoTCore`組態參數，以指定是否要發佈和訂閱 AWS IoT Core MQTT主題。新增新的`UseInstaller`組態參數，可讓您選擇性地停用安裝元件相依性的安裝指令碼。錯誤修正和改善新增對輸入資料中重複時間戳記的支援。

v2.x

版本	變更
2.1.8	針對 Greengrass nucleus 2.13.0 版更新版本。
2.1.3	針對 Greengrass nucleus 2.11.0 版更新版本。
2.1.2	針對 Greengrass nucleus 2.7.0 版更新版本。
2.1.1	針對 Greengrass nucleus 2.6.0 版更新版本。
2.1.0	新功能新增對HTTPS網路代理組態的支援。如需詳細資訊，請參閱連線至連接埠 443 或透過網路代理和讓核心裝置信任HTTPS代理。
2.0.8	錯誤修正和改善新增對輸入資料中重複時間戳記的支援。針對 Greengrass nucleus 2.5.0 版更新版本。
2.0.7	針對 Greengrass nucleus 2.4.0 版更新版本。
2.0.6	針對 Greengrass nucleus 2.3.0 版更新版本。
2.0.5	針對 Greengrass nucleus 2.2.0 版更新版本。
2.0.4	針對 Greengrass nucleus 2.1.0 版更新版本。
2.0.3	初始版本。

另請參閱

Amazon CloudWatch 使用者指南中的使用 Amazon 指標 CloudWatch
PutMetricData Amazon CloudWatch API 參考中的

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

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

文件慣用形式

用戶端裝置驗證

AWS IoT Device Defender

CloudWatch 指標

注意

主題

版本

Type

作業系統

要求

重要

端點和連接埠

相依性

組態

注意

注意

範例：組態合併更新

注意

注意

注意

範例：組態合併更新 （容器模式）

範例：組態合併更新 （無容器模式）

輸入資料

注意

注意

注意

注意

範例輸入

輸出資料

注意

範例輸出：成功

範例輸出：失敗

注意

授權

本機日誌檔案

檢視此元件的日誌

變更記錄

另請參閱

範例：組態合併更新（容器模式）

範例：組態合併更新（無容器模式）