Knowledge Base

cancel
Showing results for 
Search instead for 
Did you mean: 

How to use the Extensions WorkBench

 

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. Currently the AppDynamics Platform does not allow a user to delete a metric once it has been registered. As soon as you deploy an extension directly after downloading, it will have several default settings and you’d like to make a minor change, say in the “metricPrefix” of the extension after you deployed it with the default configuration, the platform would not allow you to delete the metrics with the default metricPrefix and you will have to keep the old metrics as well.

 

This is a very useful feature that comes in handy and should be used during the process of deploying each extension as it would give you a better idea of what metrics are going to be recorded and incase you see that you are missing some metrics, this tool will give you an opportunity to add those metrics as well. Workbench functionality is inbuilt with each extension JAR file. In order to use this feature, please follow these steps.

 

  1. Download the extension ZIP file and place it in the “monitors” folder.
  2. Extract the zip file into its folder and then delete the zip file.
    wb1.png

  3. Now, open your terminal and navigate to the extension folder.
    wb2.png
  4. Check that you have the main extension jar file.wb3.png
  5. Once you have made sure of all the requirements, go to the extension folder which contains the "jar" file and execute the following command to start Workbench mode.
    java -jar cassandra-monitoring-extension.jar
  6. If you see output similar to the following, this means that it worked correctly and you have officially started Workbench Mode.
    wb4.png
  7. Now, open your browser and go to the following link : http://localhost:9090/
    This starts the http server that allows you to access the Workbench Mode.wb5.png
  8. This shows that your extension is working in Workbench mode. Now is the time to make sure that all the metrics that you want are present. This is also a good time to remove unwanted metrics from the config.yml file so as to reduce the noise and focus on the important metrics.
  9. As you go down and explore the map of metrics, you can see if you are getting a valid output on the graph on right. The metrics that are listed in the config.yml are the ones that are shown on the Workbench.
    wb6.png

  10. This feature gives you the ability to test out the complete functionality of the extension without actually needing to register the metrics on the Machine Agent. This is an added opportunity to verify if your connection is correct and if you are getting valid values, if not, it is time to verify that all the necessary steps have been followed and the extension reports valid metrics as per expectations.
  11. Once you are completely satisfied by the metrics and their values that are received, you can go ahead and stop the current process and start the Machine Agent. Once you do that, you can view the metrics being reported on the metric browser.

 

Version history
Revision #:
2 of 2
Last update:
4 weeks ago
Updated by:
 
Labels (4)
Contributors
0 Kudos