Captures statistics for APIs in the API Gateway from Amazon CloudWatch and displays them in the AppDynamics Metric Browser.

1. Please give the following permissions to the account being used to with the extension. cloudwatch:ListMetrics cloudwatch:GetMetricStatistics
2. In order to use this extension, you do need a Standalone JAVA Machine Agent or SIM Agent. For more details on downloading these products, please visit here.
3. The extension needs to be able to connect to AWS Cloudwatch in order to collect and send metrics. To do this, you will have to either establish a remote connection in between the extension and the product, or have an agent on the same machine running the product in order for the extension to collect and send the metrics.

Note: This extension is compatible with Machine Agent version 4.5.13 or later.

1. If you are seeing warning messages while starting the Machine Agent, update the http-client and http-core JARs in {MACHINE_AGENT_HOME}/monitorsLibs to httpclient-4.5.9 and httpcore-4.4.12 to make this warning go away.

2. To make this extension work on Machine Agent < 4.5.13, the http-client and http-core JARs in {MACHINE_AGENT_HOME}/monitorsLibs need to be updated to httpclient-4.5.9 and httpcore-4.4.12.

1. Run 'mvn clean install' from aws-api-gateway-monitoring-extension
2. Copy and unzip AWSAPIGatewayMonitor-<version>.zip from 'target' directory into <machine_agent_dir>/monitors/
3. Edit config.yml file in AWSAPIGatewayMonitor and provide the required configuration (see Configuration section).
4. Restart the Machine Agent. 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 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.

1. If SIM is enabled, then use the following metricPrefix metricPrefix: "Custom Metrics|AWS APIGateway" 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 APIGateway|".

    For example,
    ```
    metricPrefix: "Server|Component:100|Custom Metrics|AWS APIGateway|"
    ```
   

2. Provide accessKey(required) and secretKey(required) of our 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 these values, extension will use IAM profile to authenticate.

   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"]
   

3. Provide the list of Api names that needs to be monitored. This list accepts regular expressions.

   apiNames: ["api1", "api2"]
   

1. 4XXError - The number of client-side errors captured in a specified period.
2. 5XXError - The number of server-side errors captured in a given period.
3. CacheHitCount - The number of requests served from the API cache in a given period.
4. CacheMissCount - The number of requests served from the back end in a given period, when API caching is enabled.
5. Count - The total number API requests in a given period.
6. IntegrationLatency - The time between when API Gateway relays a request to the back end and when it receives a response from the back end.
7. Latency - The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead.

Apart from the above metric, we also have a metric called "API calls", that gives out the number of cloudwatch API calls from the extension.

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.

1. Stop the running machine agent.
2. Delete all existing logs under /logs.
3. Please enable debug logging by editing the file /conf/logging/log4j.xml. Change the level value of the following elements to debug.
4. Start the machine agent and please let it run for 10 mins. Then zip and upload all the logs in the directory /logs/*.
5. Attach the zipped /conf/* directory here.
6. Attach the zipped /monitors/ExtensionFolderYouAreHavingIssuesWith directory here. For any support related questions, you can also contact [email protected].

Always feel free to fork and contribute any changes directly here on GitHub.