Use System Metrics

Enable metrics indexing in the Fusion UI

  1. Navigate to System > System > Metrics.

  2. Enable Record System Metrics Over Time.

Enable metrics indexing using the REST API

curl -u admin:password123 -H 'Content-type:application/json' -X PUT -d 'true' "http://localhost:8764/api/configurations/com.lucidworks.apollo.metrics.enabled"

There are around 600 different metrics available. In this topic we’ve highlighted a few that are likely to be the most useful or interesting to you.

The /system/metrics endpoint of the System API lists all the metrics that the system is currently collecting. Metrics are returned for the current instance only; Fusion instances do not aggregate metrics between nodes.

Adjust the system metrics retention period

  1. Navigate to Collections > Jobs.

  2. Select the delete-old-system-metrics job.

  3. In the job configuration pane, scroll down to REQUEST ENTITY (AS STRING).

    Editing the <code>delete-old-system-metrics</code> job

  4. Change 30DAYS to the desired period of time to retain system metrics.

Change Metric Collection Frequency

The default frequency to collect metrics is 60 seconds. Since the metrics are stored in a system collection (and a Solr instance), the data can grow to be quite large over time. If you do not need metrics collection to happen as frequently (perhaps during initial implementation), you can change the frequency by modifying the com.lucidworks.apollo.metrics.poll.seconds configuration parameter with the Configurations API.

For example:

curl -u user:pass -X PUT -H 'Content-type: application/json' -d '600' http://localhost:8764/api/configurations/com.lucidworks.apollo.metrics.poll.seconds

To disable metrics, you could set the com.lucidworks.apollo.metrics.poll.seconds parameter to '-1'.

curl -u user:pass -X PUT -H 'Content-type: application/json' -d '-1' http://localhost:8764/api/configurations/com.lucidworks.apollo.metrics.poll.seconds