A bit of documentation.

This commit is contained in:
Rémi Cocula
2017-01-25 23:18:52 +01:00
parent 88e820d8d1
commit aec131a3d1
3 changed files with 19 additions and 0 deletions
@@ -0,0 +1,18 @@
The Libresonic framework contains a convenient class (called MetricsManager) to add inner metrics that constructs in real time some performance indicators.
The use of MetricsManager is illustrated in the org.libresonic.player.filter.MetricsFilter class.
The MetricsFilter adds a metric based on the time spent by each /main.view HTTP request. This is interesting as the main.view request is invoqued when something is displayed in the main Libresonic web frame.
By default, the MetricsManager is deactivated; it does nothing.
It can be activated only by adding the following line inside the livresonic.properties configuration file :
```
Metrics=
```
Once the MetricsManager as been activated this way, each metric can be inspected using a jmx console like VisualVM.
Each metric is registered as a MBean as shown below.
![](metrics-visualvm-screenshot.png)
Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB