Skip to content

Commit 716e055

Browse files
Update README.md
1 parent 16ee910 commit 716e055

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,15 @@ Captures statistics for APIs in the API Gateway from Amazon CloudWatch and displ
88
1. **cloudwatch:ListMetrics**
99
2. **cloudwatch:GetMetricStatistics**
1010
2. Before the extension is installed, the prerequisites mentioned [here](https://community.appdynamics.com/t5/Knowledge-Base/Extensions-Prerequisites-Guide/ta-p/35213) need to be met. Please do not proceed with the extension installation if the specified prerequisites are not met.
11-
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.
12-
13-
<p>** Note: Running the extension with Machine Agent version 4.5.13 or later.</p>
14-
<ol>
15-
<li>
16-
<p>If you are seeing warning messages while starting the Machine Agent, update the http-client and http-core JARs in <code>{MACHINE_AGENT_HOME}/monitorsLibs</code> to <code>httpclient-4.5.9</code> and <code>httpcore-4.4.12</code> to make this warning go away.</p>
17-
</li>
18-
<li>
19-
<p>To make this extension work on Machine Agent &lt; 4.5.13, the http-client and http-core JARs in <code>{MACHINE_AGENT_HOME}/monitorsLibs</code> need to be updated to <code>httpclient-4.5.9</code> and <code>httpcore-4.4.12</code>.</p>
20-
</li>
21-
</ol>
11+
3. Download and install [Apache Maven](https://maven.apache.org/) which is configured with `Java 8` to build the extension artifact from source. You can check the java version used in maven using command `mvn -v` or `mvn --version`. If your maven is using some other java version then please download java 8 for your platform and set JAVA_HOME parameter before starting maven.
12+
4. 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.
2213

2314
## Installation
24-
1. Run 'mvn clean install' from aws-api-gateway-monitoring-extension
25-
2. Copy and unzip AWSAPIGatewayMonitor-\<version\>.zip from 'target' directory into \<machine_agent_dir\>/monitors/
26-
3. Edit config.yml file in AWSAPIGatewayMonitor and provide the required configuration (see Configuration section).
27-
4. Restart the Machine Agent.
15+
1. Clone the "aws-api-gateway-monitoring-extension" repo using `git clone <repoUrl>` command.
16+
2. Run 'mvn clean install' from aws-api-gateway-monitoring-extension
17+
3. Copy and unzip AWSAPIGatewayMonitor-\<version\>.zip from 'target' directory into \<machine_agent_dir\>/monitors/
18+
4. Edit config.yml file in AWSAPIGatewayMonitor and provide the required configuration (see Configuration section).
19+
5. Restart the Machine Agent.
2820

2921
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.
3022

0 commit comments

Comments
 (0)