本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
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.1.x 版本
-
3.0.x
-
2.1.x
-
2.0.x
如需元件每個版本中變更的相關資訊,請參閱變更記錄檔。
Type
如需詳細資訊,請參閱元件類型。
作業系統
要求
此元件具有下列需求:
端點和連接埠
除了基本作業所需的端點和連接埠之外,此元件還必須能夠對下列端點和連接埠執行輸出要求。如需詳細資訊,請參閱允許裝置流量透過 Proxy 或防火牆。
端點 | 連線埠 | 必要 | 描述 |
---|---|---|---|
|
443 | 是 |
上傳 CloudWatch 指標。 |
相依性
部署元件時, AWS IoT Greengrass 也會部署其相依性的相容版本。這表示您必須符合元件及其所有相依性的需求,才能成功部署元件。本節列出此元件之已發行版本的相依性,以及定義每個相依性之元件版本的語意版本條件約束。您也可以在AWS IoT Greengrass 主控台
如需有關元件相依性的詳細資訊,請參閱元件方案參考。
組態
此元件提供下列組態參數,您可以在部署元件時自訂這些參數。
輸入資料
此元件接受下列主題的測量結果,並將量度發佈至 CloudWatch。根據預設,此元件會訂閱本機發佈/訂閱訊息。如需如何從自訂元件將訊息發佈至此元件的詳細資訊,請參閱發佈/訂閱本地訊息。
從元件版本 v3.0.0 開始,您可以選擇將PubSubToIoTCore
組態參數設定為,將此元件設定為訂閱MQTT主題。true
如需將訊息發佈至自訂元件中MQTT主題的詳細資訊,請參閱發佈/訂閱訊 AWS IoT Core MQTT息。
預設主題:cloudwatch/metric/put
該消息接受以下屬性。輸入訊息必須是JSON格式。
-
request
-
此訊息中的量度。
要求物件包含要發佈至的測量結果資料 CloudWatch。測量結果值必須符合
PutMetricData
作業規格。類型:
object
包含下列資訊:-
namespace
-
此要求中測量結果資料的使用者定義命名空間。 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 紀元時間為單位,以秒表示。
預設為元件接收訊息的時間。
類型:
double
注意
如果您在此元件的 2.0.3 版和 2.0.7 版之間使用,建議您在從單一來源傳送多個量度時,分別擷取每個量度的時間戳記。請勿使用變數來儲存時間戳記。
-
unit
-
(選擇性) 量度的單位。
類型:
string
有效值:
Seconds
,Microseconds
,Milliseconds
,Bytes
,Kilobytes
,Megabytes
,Gigabytes
,Terabytes
,,Bits
,Kilobits
,Megabits
,Gigabits
,Terabits
,Percent
,Count
,,Bytes/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 -
文件/許可證
PSF -
合作@@ 路徑/許
可 MIT -
s3transfer
/Apache License 2.0 -
網址 3 /許可證
MIT
此元件是根據 Greengrass 核心軟體
本機記錄檔
此元件使用下列記錄檔。
若要檢視此元件的記錄
-
在核心裝置上執行下列命令,即時檢視此元件的記錄檔。更換
或/greengrass/v2
C:\greengrass\v2
與 AWS IoT Greengrass 根文件夾的路徑。
變更記錄
下表說明元件每個版本中的變更。
另請參閱
-
PutMetricData在 Amazon CloudWatch API 參考