AWS Lambda Monitoring Extension captures Lambda 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.
Before the extension is installed, the prerequisites mentioned here need to be met. Please do not proceed with the extension installation if the specified prerequisites are not met.
Please give the following permissions to the account being used to with the extension.
<MachineAgent_Dir>/monitors/AWSLambdaMonitorThe 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.
Please place the extension in the "monitors" directory of your Machine Agent installation directory. Do not place the extension in the "extensions" directory of your Machine Agent installation directory. In the AppDynamics Metric Browser, look for Application Infrastructure Performance|<Tier>|Custom Metrics|AWS Lambda Monitor and you should be able to see all the metrics.
In order to use the extension, you need to update the config.yml file that is present in the extension folder. The following is an explanation of the configurable fields that are present in the config.yml file. All Lambda metrics are available under the namespace AWS/Lambda and provide metrics for a single dimension, the "FunctionName". When retrieving metrics, you must supply both the Value/s for the dimension.
If SIM is enabled, then use the following metricPrefix
metricPrefix: "Custom Metrics|AWS Lambda Monitor" else configure the "COMPONENT_ID" under which the metrics need to be reported. This can be done by changing the value of <COMPONENT_ID> in
metricPrefix: "Server|Component:<COMPONENT_ID>|Custom Metrics|AWS Lambda Monitor|". For example,
metricPrefix: "Server|Component:100|Custom Metrics|AWS Lambda Monitor|"
Provide accessKey(required) and secretKey(required) of AWS account(s), also provide displayAccountName(any name that represents your account) and regions(required).
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 "enableDecryption" of "credentialsDecryptionConfig" to true and provide the encryption key in "encryptionKey" For example,
#Encryption key for Encrypted password. credentialsDecryptionConfig: enableDecryption: "true" encryptionKey: "XXXXXXXX"
Provide the dimension for the Lambda function you would like to monitor in that dimension.
#Filters based on dimensions, values accepts comma separated values and regex patterns. If `.*` is used, all are monitored and if empty, none are monitored dimensions: - name: "FunctionName" displayName: "function-name" values: ["eretail-demo", "corpsite-blog"]
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.|
- name: "Invocations" alias: "Invocations" statType: "ave" delta: false multiplier: 1 aggregationType: "AVERAGE" 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. ###config.yml
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.
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: #Filters based on dimensions, values accepts comma separated values and regex patterns. If `.*` is used, all are monitored and if empty, none are monitored dimensions: - name: "FunctionName" displayName: "function-name" values: ["eretail-demo", "corpsite-blog"] #Allowed values are Basic and Detailed. Refer https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html for more information # Basic will fire CloudWatch API calls every 5 minutes # Detailed will fire CloudWatch API calls every 1 minutes cloudWatchMonitoring: "Basic" metricsConfig: metricTypes: - metricName: "CurrItems" statType: "max" - metricName: "DecrHits" statType: "sum" excludeMetrics: ["DeleteMisses", "Get.*"] metricsTimeRange: startTimeInMinsBeforeNow: 5 endTimeInMinsBeforeNow: 0 maxErrorRetrySize: 0 concurrencyConfig: noOfAccountThreads: 3 noOfRegionThreadsPerAccount: 3 noOfMetricThreadsPerRegion: 3 regionEndPoints: us-east-1 : monitoring.us-east-1.amazonaws.com us-east-2 : monitoring.us-east-2.amazonaws.com us-west-1 : monitoring.us-west-1.amazonaws.com us-west-2 : monitoring.us-west-2.amazonaws.com ap-northeast-1 : monitoring.ap-northeast-1.amazonaws.com ap-northeast-2: monitoring.ap-northeast-2.amazonaws.com ap-northeast-3 : monitoring.ap-northeast-3.amazonaws.com ap-south-1 : monitoring.ap-south-1.amazonaws.com ap-southeast-1 : monitoring.ap-southeast-1.amazonaws.com ap-southeast-2 : monitoring.ap-southeast-2.amazonaws.com ca-central-1 : monitoring.ca-central-1.amazonaws.com cn-north-1 : monitoring.cn-north-1.amazonaws.com.cn cn-northwest-1 : monitoring.cn-northwest-1.amazonaws.com.cn eu-central-1 : monitoring.eu-central-1.amazonaws.com eu-west-1 : monitoring.eu-west-1.amazonaws.com eu-west-2 : monitoring.eu-west-2.amazonaws.com eu-west-3 : monitoring.eu-west-3.amazonaws.com sa-east-1 : monitoring.sa-east-1.amazonaws.com us-gov-west-1 : monitoring.us-gov-west-1.amazonaws.com metricPrefix: "Server|Component:<TIER_ID>|Custom Metrics|AWS Lambda Monitor|" #metricPrefix: "Custom Metrics|AWS Lambda Monitor|"
Typical metric path: Application Infrastructure Performance|<Tier>|Custom Metrics|Amazon Lambda|<Account Name>|<Region>|Function Name|<Function Name> followed by the metrics defined in the link below:
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 look at the troubleshooting document and make sure that everything is followed correctly. 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.
Always feel free to fork and contribute any changes directly here on GitHub.
|Controller Compatibility||4.4 or Later|
|Last Update||22nd March, 2019|
List of changes to this extension can be found here