#AWS AutoScaling Monitoring Extension
##Use Case Captures AutoScaling statistics from Amazon CloudWatch and displays them in the AppDynamics Metric Browser.
Note : By default, the Machine agent can only send a fixed number of metrics to the controller. This extension potentially reports thousands of metrics, so to change this limit, please follow the instructions mentioned here.
##Installation
- Run 'mvn clean install' from aws-autoscaling-monitoring-extension
- Copy and unzip AWSAutoScalingMonitor-<version>.zip from 'target' directory into <machine_agent_dir>/monitors/
- Edit config.yaml file in AWSAutoScalingMonitor/conf and provide the required configuration (see Configuration section)
- Restart the Machine Agent.
##Configuration
###config.yaml
Note: Please avoid using tab (\t) when editing yaml files. You may want to validate the yaml file using a yaml validator.
Section | Fields | Description | Example |
---|---|---|---|
accounts | Fields under this section can be repeated for multiple accounts config | ||
awsAccessKey | AWS Access Key | ||
awsSecretKey | AWS Secret Key | ||
displayAccountName | Display name used in metric path | "MyAWSAutoScaling" | |
regions | Regions where AutoScaling is registered | Allowed values: "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "eu-central-1", "eu-west-1", "us-east-1", "us-west-1", "us-west-2", "sa-east-1" |
|
credentialsDecryptionConfig | ----- | ----- | ----- |
enableDecryption | If set to "true", then all aws credentials provided (access key and secret key) will be decrypted - see AWS Credentials Encryption section | ||
decryptionKey | The key used when encypting the credentials | ||
proxyConfig | ----- | ----- | ----- |
host | The proxy host (must also specify port) | ||
port | The proxy port (must also specify host) | ||
username | The proxy username (optional) | ||
password | The proxy password (optional) | ||
metricsConfig | ----- | ----- | ----- |
metricTypes | Fields under this section can be repeated for multiple metric types override | ||
metricName | The metric name | "CPUUtilization" | |
statType | The statistic type | Allowed values: "ave" "max" "min" "sum" "samplecount" |
|
----- | ----- | ----- | |
excludeMetrics | Metrics to exclude - supports regex | "CPUUtilization", "Swap.*" |
|
metricsTimeRange | |||
startTimeInMinsBeforeNow | The no of mins to deduct from current time for start time of query | 5 | |
endTimeInMinsBeforeNow | The no of mins to deduct from current time for end time of query. Note, this must be less than startTimeInMinsBeforeNow |
0 | |
----- | ----- | ----- | |
maxErrorRetrySize | The max number of retry attempts for failed retryable requests | 1 | |
concurrencyConfig | |||
noOfAccountThreads | The no of threads to process multiple accounts concurrently | 3 | |
noOfRegionThreadsPerAccount | The no of threads to process multiple regions per account concurrently | 3 | |
noOfMetricThreadsPerRegion | The no of threads to process multiple metrics per region concurrently | 3 | |
----- | ----- | ----- | |
metricPrefix | The path prefix for viewing metrics in the metric browser. | "Custom Metrics|Amazon AutoScaling|" |
Below is an example config for monitoring multiple accounts and regions:
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"]
credentialsDecryptionConfig:
enableDecryption: "false"
decryptionKey:
proxyConfig:
host:
port:
username:
password:
metricsConfig:
metricTypes:
- metricName: "GroupInServiceInstances"
statType: "max"
- metricName: "GroupMinSize"
statType: "sum"
excludeMetrics: ["GroupMaxSize", "GroupTotal.*"]
metricsTimeRange:
startTimeInMinsBeforeNow: 5
endTimeInMinsBeforeNow: 0
maxErrorRetrySize: 0
concurrencyConfig:
noOfAccountThreads: 3
noOfRegionThreadsPerAccount: 3
noOfMetricThreadsPerRegion: 3
metricPrefix: "Custom Metrics|Amazon AutoScaling|"
###AWS Credentials Encryption To set an encrypted awsAccessKey and awsSecretKey in config.yaml, follow the steps below:
-
Download the util jar to encrypt the AWS Credentials from here.
-
Run command:
java -cp appd-exts-commons-1.1.2.jar com.appdynamics.extensions.crypto.Encryptor EncryptionKey CredentialToEncrypt For example: java -cp "appd-exts-commons-1.1.2.jar" com.appdynamics.extensions.crypto.Encryptor test myAwsAccessKey java -cp "appd-exts-commons-1.1.2.jar" com.appdynamics.extensions.crypto.Encryptor test myAwsSecretKey
-
Set the decryptionKey field in config.yaml with the encryption key used, as well as the resulting encrypted awsAccessKey and awsSecretKey in their respective fields.
##Metrics Typical metric path: Application Infrastructure Performance|<Tier>|Custom Metrics|Amazon AutoScaling|<Account Name>|<Region>|Group|<group id> followed by the metrics defined in the link below:
##Contributing
Always feel free to fork and contribute any changes directly via GitHub.
##Community
Find out more in the AppSphere community.
##Support
For any questions or feature request, please contact AppDynamics Center of Excellence.