Products
Solutions
Resources
Customers
Company

Sign in
My Account.
Captures the number of seconds remaining until imported key material expires and displays them in the AppDynamics Metric Browser..This metric is valid only for CMKs whose origin is EXTERNAL and whose key material is or was set to expire.
cloudwatch:ListMetrics
cloudwatch:GetMetricStatistics
Note : This extension is compatible with Machine Agent version 4.5.13 or later.
{MACHINE_AGENT_HOME}/monitorsLibs
to httpclient-4.5.9
and httpcore-4.4.12
to make this warning go away.{MACHINE_AGENT_HOME}/monitorsLibs
has to be manually be updated to httpclient-4.5.9
and httpcore-4.4.12
.mvn clean install
from aws-kms-monitoring-extension
KMSMonitor-<version>.zip
from target
directory into <machine_agent_dir>/monitors/
<MachineAgent_Dir>/monitors/KMSMonitor
The metricPrefix of the extension has to be configured as specified here. Please make sure that the right metricPrefix is chosen based on your machine agent deployment, otherwise this could lead to metrics not being visible in the controller.In order to use the extension, you need to update the config.yml file that is present in the extension folder. The following is a step-by-step explanation of the configurable fields that are present in the config.yml
file.
<MachineAgent_Dir>/monitors/AWSKMSMonitor
The metricPrefix of the extension has to be configured as specified here. Please make sure that the right metricPrefix is chosen based on your machine agent deployment, otherwise this could lead to metrics not being visible in the controller.accounts:
- awsAccessKey: "XXXXXXXX1"
awsSecretKey: "XXXXXXXXXX1"
displayAccountName: "TestAccount_1"
regions: ["us-east-1","us-west-1","us-west-2"]
- awsAccessKey: "XXXXXXXX2"
awsSecretKey: "XXXXXXXXXX2"
displayAccountName: "TestAccount_2"
regions: ["eu-central-1","eu-west-1"]
enableDecryption
of credentialsDecryptionConfig
to true
and provide the encryption key in encryptionKey
. For example,#Encryption key for Encrypted password.
credentialsDecryptionConfig:
enableDecryption: "true"
encryptionKey: "XXXXXXXX"
To report metrics only from specific dimension values, configure the dimesion
section. Dimensions for AWS KMS are KeyId
dimensions:
- name: "KeyId"
displayName: "KeyId"
values: [".*"]
If .*
is used, all dimension values are monitored and if empty, none are monitored.Configure the metrics section.
For configuring the metrics, the following properties can be used:
Property | Default value | Possible values | Description |
---|---|---|---|
alias | metric name | Any string | The substitute name to be used in the metric browser instead of metric name. |
statType | "ave" | "AVERAGE", "SUM", "MIN", "MAX" | AWS configured values as returned by API |
aggregationType | "AVERAGE" | "AVERAGE", "SUM", "OBSERVATION" | Aggregation qualifier |
timeRollUpType | "AVERAGE" | "AVERAGE", "SUM", "CURRENT" | Time roll-up qualifier |
clusterRollUpType | "INDIVIDUAL" | "INDIVIDUAL", "COLLECTIVE" | Cluster roll-up qualifier |
multiplier | 1 | Any number | Value with which the metric needs to be multiplied. |
convert | null | Any key value map | Set of key value pairs that indicates the value to which the metrics need to be transformed. eg: UP:0, DOWN:1 |
delta | false | true, false | If enabled, gives the delta values of metrics instead of actual values. |
For example,
- name: "SecondsUntilKeyMaterialExpiration"
alias: "SecondsUntilKeyMaterialExpiration"
statType: "sum" aggregationType: "AVERAGE"
timeRollUpType: "AVERAGE"
clusterRollUpType: "INDIVIDUAL"
delta: false
multiplier: 1
Note: Please avoid using tab (\t) when editing yaml files. You may want to validate the yaml file using a yaml validator.
Please visit this page to get detailed instructions on password encryption. The steps in this document will guide you through the whole process.
Please refer to metrics available from this extension as given in the link below:
Workbench is an inbuilt feature provided with each extension in order to assist you to fine tune the extension setup before you actually deploy it on the controller. Please review the following document on How to use the Extensions WorkBench
Please look at the troubleshooting document and make sure that everything is followed correctly.
If after going through the Troubleshooting Document you have not been able to get your extension working, please file a ticket and add the following information.
For any support related questions, you can also contact help@appdynamics.com.
Always feel free to fork and contribute any changes directly via GitHub.
Version: | 1.1.1 |
Controller Compatibility | 4.5 or Later |
Agent Compatiblity | 4.5.13+ |
Last Update | 22 Jan 2021 |
List of changes to this extension can be found here