支援終止通知:2026 年 10 月 7 日 AWS 將停止 的支援 AWS IoT Greengrass Version 1。2026 年 10 月 7 日之後,您將無法再存取 AWS IoT Greengrass V1 資源。如需詳細資訊,請造訪從 遷移 AWS IoT Greengrass Version 1。
本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
CloudWatch 指標連接器
CloudWatch Metrics 連接器會將自訂指標從 Greengrass 裝置發佈至 Amazon CloudWatch。連接器提供集中式基礎設施來發佈 CloudWatch 指標,您可以使用它來監控和分析 Greengrass 核心環境,並對本機事件採取行動。如需詳細資訊,請參閱《Amazon CloudWatch 使用者指南》中的使用 Amazon CloudWatch 指標。 Amazon CloudWatch
此連接器會接收指標資料當做 MQTT 訊息。連接器會批次處理位於相同命名空間中的指標,並定期將其發佈至 CloudWatch。
此連接器具有下列版本。
版本 |
ARN |
|---|---|
5 |
|
4 |
|
3 |
|
2 |
|
1 |
|
如需版本變更的詳細資訊,請參閱 Changelog。
要求
此連接器有下列要求:
連接器參數
此連接器提供下列參數:
建立範例連接器 (AWS CLI)
下列 CLI 命令ConnectorDefinition會使用包含 CloudWatch Metrics 連接器的初始版本來建立 。
aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{ "Connectors": [ { "Id": "MyCloudWatchMetricsConnector", "ConnectorArn": "arn:aws:greengrass:region::/connectors/CloudWatchMetrics/versions/4", "Parameters": { "PublishInterval" : "600", "PublishRegion" : "us-west-2", "MemorySize" : "16", "MaxMetricsToRetain" : "2500", "IsolationMode" : "GreengrassContainer" } } ] }'
在 AWS IoT Greengrass 主控台中,您可以從群組的連接器頁面新增連接器。如需詳細資訊,請參閱Greengrass 連接器入門 (主控台)。
輸入資料
此連接器接受 MQTT 主題的指標,並將指標發佈至 CloudWatch。輸入訊息必須是 JSON 格式。
- 訂閱中的主題篩選條件
-
cloudwatch/metric/put - 訊息屬性
-
request-
此訊息中指標的相關資訊。
請求物件包含要發佈至 CloudWatch 的指標資料。指標值必須符合
PutMetricDataAPI 的規格。只需要namespace、metricData.metricName和metricData.value屬性。必要:
true類型:
object包含下列屬性:namespace-
此請求中指標資料的使用者定義命名空間。CloudWatch 使用命名空間做為指標資料點的容器。
注意
您無法指定以預留字串 開頭的命名空間
AWS/。必要:
true類型:
string有效模式:
[^:].* metricData-
指標的資料。
必要:
true類型:
object包含下列屬性:metricName-
指標的名稱
必要:
true類型:
string dimensions-
與指標相關聯的維度。維度提供指標及其資料的詳細資訊。一個指標可以定義最多 10 個維度。
此連接器會自動包含名為 的維度
coreName,其中 值是核心的名稱。必要:
false類型:包含下列屬性
array的維度物件:name-
維度名稱。
必要:
false類型:
string value-
維度值。
必要:
false類型:
string
timestamp-
收到指標資料的時間,以自 以來的秒數表示
Jan 1, 1970 00:00:00 UTC。如果省略這個值,連接器會使用收到訊息的時間。必要:
false類型:
timestamp注意
如果您在此連接器的版本 1 和 4 之間使用 ,我們建議您從單一來源傳送多個指標時,分別擷取每個指標的時間戳記。請勿使用變數來存放時間戳記。
value-
指標的值。
注意
CloudWatch 會拒絕太小或太大的值。值的範圍必須在
8.515920e-109到1.174271e+108(Base 10) 或2e-360到2e360(Base 2) 之間。不支援特殊值 (例如,NaN、+Infinity、-Infinity)。必要:
true類型:
double unit-
指標的單位。
必要:
false類型:
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
- 限制
-
CloudWatch
PutMetricDataAPI 實施的所有限制都適用於使用此連接器時的指標。以下限制特別重要:-
API 承載有 40 KB 限制
-
每一 API 請求 20 個指標
-
PutMetricDataAPI 每秒 150 筆交易 (TPS)
如需詳細資訊,請參閱《Amazon CloudWatch 使用者指南》中的 CloudWatch 限制。 Amazon CloudWatch
-
- 範例輸入
-
{ "request": { "namespace": "Greengrass", "metricData": { "metricName": "latency", "dimensions": [ { "name": "hostname", "value": "test_hostname" } ], "timestamp": 1539027324, "value": 123.0, "unit": "Seconds" } } }
輸出資料
這個連接器會將狀態資訊發佈為輸出資料,且主題為 MQTT。
- 訂閱中的主題篩選條件
-
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" } }注意
如果連接器偵測到可重試的錯誤 (例如連線錯誤),它會在下一個批次中重試發佈。
用量範例
使用下列高階步驟來設定範例 Python 3.7 Lambda 函數,您可以用來嘗試連接器。
注意
-
如果您使用其他 Python 執行期,則可以建立從 Python3.x 到 Python 3.7 的符號連結。
-
連接器入門 (主控台) 和 連接器入門 (CLI) 主題包含詳細步驟,說明如何設定和部署範例 Twilio 通知連接器。
-
確定您符合連接器的要求。
針對群組角色要求,您必須設定角色以授與必要的許可,並確認已將角色新增至群組。如需詳細資訊,請參閱 管理 Greengrass 群組角色 (主控台) 或 管理 Greengrass 群組角色 (CLI) 。
-
建立並發佈 Lambda 函數,將輸入資料傳送至連接器。
將範例程式碼儲存為 PY 檔案。下載並解壓縮AWS IoT Greengrass 適用於 Python 的 Core SDK。然後,建立在根層級包含 PY 檔案和
greengrasssdk資料夾的 zip 套件。此 zip 套件是您上傳至 的部署套件 AWS Lambda。建立 Python 3.7 Lambda 函數後,發佈函數版本並建立別名。
-
設定 Greengrass 群組。
-
部署群組。
-
在 AWS IoT 主控台的測試頁面上,訂閱輸出資料主題,以檢視連接器的狀態訊息。Lambda 函數範例為長期函數,並在群組部署後立即開始傳送訊息。
完成測試後,您可以將 Lambda 生命週期設定為隨需 (或在 CLI
"Pinned": false中) 並部署群組。這會讓函數停止傳送訊息。
範例
下列範例 Lambda 函數會將輸入訊息傳送至連接器。
import greengrasssdk import time import json iot_client = greengrasssdk.client('iot-data') send_topic = 'cloudwatch/metric/put' def create_request_with_all_fields(): return { "request": { "namespace": "Greengrass_CW_Connector", "metricData": { "metricName": "Count1", "dimensions": [ { "name": "test", "value": "test" } ], "value": 1, "unit": "Seconds", "timestamp": time.time() } } } def publish_basic_message(): messageToPublish = create_request_with_all_fields() print("Message To Publish: ", messageToPublish) iot_client.publish(topic=send_topic, payload=json.dumps(messageToPublish)) publish_basic_message() def lambda_handler(event, context): return
授權
CloudWatch Metrics 連接器包含下列第三方軟體/授權:
-
適用於 Python (Boto3) 的 AWS SDK
/Apache License 2.0 -
botocore
/Apache License 2.0 -
dateutil
/PSF License -
docutils
/BSD 授權、GNU 一般公有授權 (GPL)、Python 軟體基金會授權、公有網域 -
jmespath
/MIT License -
s3transfer
/Apache License 2.0 -
urllib3
/MIT License
此連接器根據 Greengrass 核心軟體授權合約
變更記錄
下表說明每個版本連接器的變更。
版本 |
變更 |
|---|---|
5 |
修正在輸入資料中新增重複時間戳記的支援。 |
4 |
已新增 |
3 |
將 Lambda 執行時間升級至 Python 3.7,這會變更執行時間需求。 |
2 |
可減少過多記錄的修正。 |
1 |
初始版本。 |
Greengrass 群組一次只能包含一個版本的連接器。若要取得有關升級連接器版本的資訊,請參閱升級連接器版本。
另請參閱
-
《Amazon CloudWatch 使用者指南》中的使用 Amazon CloudWatch 指標 Amazon CloudWatch
-
Amazon CloudWatch API 參考中的 PutMetricData