Skip to content

Commit 429ae95

Browse files
Update README.md
1 parent 2f317d5 commit 429ae95

1 file changed

Lines changed: 8 additions & 11 deletions

File tree

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ The metrics reported by the extension can be modified as per the user's requirem
1616
## Prerequisites
1717
This extension requires that the user provide their own Jar file in order to connect to the Database.
1818

19-
In order to use this extension, you do need a [Standalone JAVA Machine Agent](https://docs.appdynamics.com/display/PRO44/Java+Agent) or [SIM Agent](https://docs.appdynamics.com/display/PRO44/Server+Visibility).
20-
For more details on downloading these products, please visit [download.appdynamics.com](https://download.appdynamics.com/).
19+
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.
2120

2221
This is very essential in order to establish a connection with the Database to get the metrics.
2322
The extension needs to be able to connect to the database in order to collect and send metrics.
@@ -27,10 +26,9 @@ To do this, you will have to either establish a remote connection in between the
2726

2827
## Installation
2928

30-
1. To build from the source, run "mvn clean install" and find the SQLMonitor.zip file in the "target" folder.
31-
You can also download the SQLMonitor.zip from [AppDynamics Exchange][].
32-
2. Unzip as "SQLMonitor" and copy the **"SQLMonitor"** directory to `<MACHINE_AGENT_HOME>/monitors`.
33-
29+
1. To build from the source, run "mvn clean install" and find the SQLMonitor-VERSION.zip file in the "target" folder.
30+
2. Unzip the "SQLMonitor-VERSION.zip" from `target` directory into the `<MACHINE_AGENT_HOME>/monitors` folder.
31+
3. Restart the Machine Agent.
3432

3533
**Note:** Please place the extension in the **"monitors"** directory of your **Machine Agent** installation
3634
directory. Do not place the extension in the **"extensions"** directory of your **Machine Agent** installation directory.
@@ -67,7 +65,7 @@ monitor.xml file.!
6765

6866
### config.yml
6967

70-
**Note** : Please make sure to not use tab (\t) while editing yaml files. You may want to validate the yaml file using a yaml validator http://yamllint.com/
68+
**Note** : Please make sure to not use tab (\t) while editing yaml files. You may want to validate the yaml file using a [yaml validator](https://jsonformatter.org/yaml-validator)
7169

7270
You will have to Configure the SQL server instances by editing the config.yaml file in `<MACHINE_AGENT_HOME>/monitors/SQLMonitor/`.
7371
The information provided in this file will be used to connect and query the database.
@@ -77,7 +75,7 @@ You can find a sample config.yaml file below.
7775
# Make sure the metric prefix ends with a |
7876
#This will create this metric in all the tiers, under this path.
7977
#metricPrefix: "Custom Metrics|SQL|"
80-
#This will create it in specific Tier. Replace <ComponentID> with TierID
78+
#This will create it in specific Tier. Replace <ComponentID> with TierID. For more details refer https://community.appdynamics.com/t5/Knowledge-Base/How-do-I-troubleshoot-missing-custom-metrics-or-extensions/ta-p/28695
8179
metricPrefix: "Server|Component:<ComponentID>|Custom Metrics|SQL|"
8280
8381
@@ -290,12 +288,11 @@ Always feel free to fork and contribute any changes directly via [GitHub](https:
290288
| Name | Version |
291289
|--------------------------|------------|
292290
|Extension Version |2.0.2 |
293-
|Controller Compatibility |4.5 or Later|
294291
|Product Tested On |MySql, SQLServer 4.1,4.2, Vertica|
295292
|Last Update |08/06/2021 |
296-
|List of Changes |[Change log](https://github.com/Appdynamics/SQLMonitor/blob/master/CHANGELOG.md) |
297-
293+
|Changes list |[Change log](https://github.com/Appdynamics/SQLMonitor/blob/master/CHANGELOG.md) |
298294

295+
**Note**: While extensions are maintained and supported by customers under the open-source licensing model, they interact with agents and Controllers that are subject to [AppDynamics’ maintenance and support policy](https://docs.appdynamics.com/latest/en/product-and-release-announcements/maintenance-support-for-software-versions). Some extensions have been tested with AppDynamics 4.5.13+ artifacts, but you are strongly recommended against using versions that are no longer supported.
299296

300297
[GitHub]: https://github.com/Appdynamics/SQLMonitor
301298
[AppDynamics Exchange]: https://www.appdynamics.com/community/exchange/extension/sqlmonitor/

0 commit comments

Comments
 (0)