Captures statistics for APIs in the API Gateway from Amazon CloudWatch and displays them in the AppDynamics Metric Browser.
Configure the AWS API Gateway monitoring extension by editing the config.yml file in
<MachineAgent_Dir>/monitors/AWSAPIGatewayMonitoThe 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.
cloudWatchMonitoring: "Basic"If you want to run the extension with a further delay, comment the "cloudWatchMonitoring" and use the following field which takes in the number of minutes after which the extension should call the cloudwatch metrics.
Configure the AWS account by specifying the awsAccessKey, awsSecretKey of the AWS account. displayAccountName(required) and regions(required) also needs to be configured.
accounts: - awsAccessKey: "XXXXXXXX1" awsSecretKey: "XXXXXXXXXX1" displayAccountName: "TestAccount_1" regions: ["us-east-1","us-west-1","us-west-2"]
NOTE: If you have the machine agent with extension installed on an AWS EC2 instance which has an assigned role with appropriate permissions as specified in the prerequisites section, then the awsAccessKey and awsSecretKey fields should be left empty as follows:
accounts: - awsAccessKey: "" awsSecretKey: "" displayAccountName: "TestAccount_1" regions: ["us-east-1","us-west-1","us-west-2"]
If you know for which Apis you need the metrics for, the you can monitor only those Apis. This can be done by secifying the patterns of the Api names that needs to be minitored
For example, If you want only Apis who name is exactly "sample" as well as the Apis with the name starting with demo, then you can configure it as below
apiNames: ["^sample$", "^demo"]
Apart from the above metrics, the extension also gives a metric called "API calls" at the extension level, that gives out the number of cloudwatch API calls per minutes from the extension.
You need to have events service setup and working before you do the following.
To get configuration metrics related to AWS API Gateway on your analytics platform, please follow the below steps:
#eventsService: # enableTraditionalMetrics: false # enableApiMetrics: false # enableResourceMetrics: false # enableStageMetrics: false # credentials: # controllerEventsServiceHost: "" # controllerEventsServicePort: 9080 # enableSSL: false # controllerGlobalAccountName: "" # eventsAPIKey: ""
enableTraditionalMetrics: false enableApiMetrics: false enableResourceMetrics: false enableStageMetrics: false
credentials: controllerEventsServiceHost: "" controllerEventsServicePort: 9080 enableSSL: false controllerGlobalAccountName: "" eventsAPIKey: ""
AWSAPIGatewayMonitor_traditionalMetrics AWSAPIGatewayMonitor_APIMetrics AWSAPIGatewayMonitor_ResourceMetrics AWSAPIGatewayMonitor_StageMetrics
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 specified in the Troubleshooting document to debug problems faced while using the extension.
Always feel free to fork and contribute any changes directly via GitHub.
|4.4 or later|