AWS KMS
Collect successful cryptographic operation request metrics published by AWS Key Management Service (KMS) in the AWS/KMS namespace.
Configuration¶
Install Func¶
We recommend enabling Guance Integrations - Extensions - Hosted Func: all prerequisites are installed automatically. Continue with script installation.
To deploy Func yourself, see Self-hosted Func.
Enable the Script¶
Tip: Prepare suitable AWS access keys in advance (for simplicity, you can grant the global read-only permission
ReadOnlyAccess).
Activate Script in DataFlux Func (Automata)¶
- Log in to the Guance console
- Click the 【Integration】 menu and select 【Cloud Account Management】
- Click 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
- Click 【Test】, and if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
- Click 【Cloud Account Management】, and you can see the added cloud account in the list. Click the corresponding cloud account to enter the details page
- Click the 【Integration】 button on the cloud account details page, find
AWS KMSunder theNot Installedlist, click the 【Install】 button, and the installation interface will pop up for installation.
Activate Script Manually¶
- Log in to the Func console, click [Script Market] to open the Guance script market, and search for
integration_aws_kms. - Click [Install], then enter the required parameters: AWS AK ID, AK Secret, and account name.
- Click [Deploy Startup Script]. The system automatically creates the
Startupscript set and configures the corresponding startup script. - Once enabled, the corresponding automatic trigger configuration appears under [Management / Automatic Trigger Configuration]. Click [Execute] to run it immediately without waiting for the scheduled time. After a short wait, check the task execution records and logs.
Verification¶
- Confirm that the task is configured under Management / Automatic Trigger Configuration. Check task records and logs for permission or API errors.
- In Guance Metrics, check the
aws_AWS/KMSmeasurement to confirm the monitoring data.
Metrics¶
The measurement is aws_AWS/KMS.
| MetricName | MetricDescribe | Dimensions | Unit | Statistics | Guance Fields |
|---|---|---|---|---|---|
SuccessfulRequest |
Successful cryptographic operation requests for a specific KMS key; Sum is the total successful requests during the collection period. | KeyArn, Operation; for ReEncrypt: SourceKeyArn, DestinationKeyArn, Operation | count | SampleCount、Average、Sum、Minimum、Maximum | SuccessfulRequest_SampleCount、SuccessfulRequest_Average、SuccessfulRequest_Sum、SuccessfulRequest_Minimum、SuccessfulRequest_Maximum |