Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
README changes for the version 2.1
  • Loading branch information
akshayAppd19 authored Oct 25, 2017
1 parent 49b6818 commit a26ca9a
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <fileSystem> | wc -l`.
### Metric Category: nfsIOStats
The storage metrics for any external network file system (NFS) mounts is reported by executing the command `iostat -d <fileSystem>`. 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:
Expand All @@ -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)
Expand Down

0 comments on commit a26ca9a

Please sign in to comment.