From a26ca9a6c84b2d04caf1a5b0ca8b7d0d4325fa03 Mon Sep 17 00:00:00 2001 From: akshayAppd Date: Wed, 25 Oct 2017 18:07:08 +0530 Subject: [PATCH] Update README.md README changes for the version 2.1 --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e2c19f..0e9aa3f 100644 --- a/README.md +++ b/README.md @@ -146,8 +146,21 @@ Note : Please make sure not to use tab (\t) while editing yaml files. You can va |udp |UDP sockets |used |Used sockets -### Metric Category: nfsMountStatus +### Metric Category: mountedNFSStatus An availability status for any external network file system (NFS) mounts is reported by executing the command `df | grep | wc -l`. + + +### Metric Category: nfsIOStats +The storage metrics for any external network file system (NFS) mounts is reported by executing the command `iostat -d `. Following metrics are reported: + +|Metric Name |Description| +|------------------------------ |------------| +|tps |Number of transfers per second issued to the device +|kB_read/s |Amount of data, in number of blocks(in kilobytes) read from device per second +|kB_read |The total number of blocks (kilobytes) read +|kB_wrtn/s |Amount of data written to the device, in a number of blocks (kilobytes) per second +|kB_wrtn |The total number of blocks (kilobytes) written + The file systems to be monitored are to be configured in config.yml. ``` mountedNFS: @@ -163,6 +176,25 @@ For eg. java -Dappdynamics.agent.maxMetrics=2500 -jar machineagent.jar ``` +##Workbench + +Workbench is a feature by which you can preview the metrics before registering it with the controller. This is useful if you want to fine tune the configurations. Workbench is embedded into the extension jar. +To use the workbench +Follow all the installation steps +Start the workbench with the command + java -jar /monitors/LinuxMonitor/linux-monitoring-extension.jar + + +This starts an http server at http://host:9090/. This can be accessed from the browser. +If the server is not accessible from outside/browser, you can use the following end points to see the list of registered metrics and errors. +#Get the stats + curl http://localhost:9090/api/stats + #Get the registered metrics + curl http://localhost:9090/api/metric-paths +You can make the changes to config.yml and validate it from the browser or the API +Once the configuration is complete, you can kill the workbench and start the Machine Agent. + + ##Custom Dashboard ![](https://github.com/Appdynamics/linux-monitoring-extension/blob/master/Memory_Process.png?raw=true)