Captures AWS Elasticsearch statistics from Amazon CloudWatch and displays them in the AppDynamics Metric Browser.
The alternative to providing keys in the extension is installing the machine agent with the extension on an AWS EC2 instance and providing the instance with a role that has the above permissions.
mvn clean installfrom
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
Note: Please avoid using tab (\t) when editing yaml files. Please copy all the contents of the config.yml file and go to Yaml Validator . On reaching the website, paste the contents and press the “Go” button on the bottom left. If you get a valid output, that means your formatting is correct and you may move on to the next step.
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.
Provide accessKey(required) and secretKey(required) of your account(s), also provide displayAccountName(any name that represents your account) and regions(required). If you are running this extension inside an EC2 instance which has IAM profile configured then you don't have to configure accessKey and secretKey values, extension will use IAM profile to authenticate. You can provide multiple accounts and regions as below -
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"]
If you want to encrypt the awsAccessKey and awsSecretKey then follow the "Credentials Encryption" section and provide the encrypted values in awsAccessKey and awsSecretKey. Configure
true and provide the encryption key in
encryptionKey. For example,
#Encryption key for Encrypted password. credentialsDecryptionConfig: enableDecryption: "true" encryptionKey: "XXXXXXXX"
Provide all valid proxy information if you use it. If not, leave this section as is.
proxyConfig: host: port: username: password:
dimensionsection as below -
If these fields are left empty
dimensions: - name: "DomainName" displayName: "Domain" values: [""] - name: "ClientId" displayName: "Client Id" values: [""] - name: "NodeId" displayName: "Node Id" values: [""]
, the metrics which require that dimension will not be reported. In order to monitor everything under a dimension, you can simply use
.*to pull everything from your AWS Environment.
|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"||"ave", "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.|
- name: "ClusterStatus.green" alias: "Cluster Status|Green" statType: "max" delta: false multiplier: 1 aggregationType: "OBSERVATION" timeRollUpType: "AVERAGE" clusterRollUpType: "INDIVIDUAL"
All these metric properties are optional, and the default value shown in the table is applied to the metric(if a property has not been specified) by default.
metricsTimeRange: startTimeInMinsBeforeNow: 10 endTimeInMinsBeforeNow: 0
Please visit this page to get detailed instructions on password encryption. The steps in this document will guide you through the whole process.
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 follow the steps listed in this troubleshooting-document in order to troubleshoot your issue. These are a set of common issues that customers might have faced during the installation of the extension. If these don't solve your issue, please follow the last step on the troubleshooting-document to contact the support team.
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. Please provide the following in order for us to assist you better.
<MachineAgent>/conf/logging/log4j.xml. Change the level value of the following
<logger>elements to debug.
<logger name="com.singularity"> <logger name="com.appdynamics">
For any support related questions, you can also contact firstname.lastname@example.org.
Always feel free to fork and contribute any changes directly here on GitHub.
|Agent Compatibility||4.5.13 or Later|
|Controller Compatibility||4.4 or Later|
|Last Update||May 27, 2020|
|List of Changes||Change Log|