System Usage Monitor

The System Usage Monitor is a voluntary program to allow users to anonymously send basic information about their system to Lucidworks. We use this information to analyze the types of systems in use by our customers and how they are used so we can improve our product.

At no point does the system collect information that could identify you, your organization or the specific documents indexed. Only minimal data is sent about the type of content indexed. Our website has more information about our privacy policy.

Information Collected by the Usage Monitor

The System Usage Monitor collects the following information:

  • uuid - a randomly generated identifier per Fusion cluster.

  • System information: the operating system, version and java version will also be reported.

  • nodes - the number of Apollo nodes in use. This is calculated from Jetty processes on the same node or on a different node.

  • Solr statistics:

    • Number of Solr nodes, total number of collections and number of Fusion collections.

    • Number of documents and the number that are regular documents and the number that are signals.

    • Number of total search requests and the number that are document search requests and the number that are signal search requests.

    • Total time to execute all search requests, to execute only document search requests, and to execute signal search requests.

  • Aggregations:

    • Number of aggregation runs and how long they took (in ms).

    • Number of signals processed.

    • Number of aggregated signals.

  • Recommendations:

    • Number of recommendation requests for each type of recommentation.

    • Total time to execute each type of recommendation request.

You can see the data that will be sent to Fusion with the Usage API and also in the UI by going to the Systems tab, then 'Heartbeat data'. The UI and the REST API will only report the data currently scheduled to be sent so is not a complete picture of all data collected.

How Data is Sent

Data is sent to Fusion once per week, and also whenever the system is restarted.

When Fusion is started, the System Usage Monitor will transmit data about your system to a server hosted by Lucidworks with two HTTP requests. The first request contains system-level information and if that is successful, the second request will send system-specific information.

The information is sent via an encrypted POST request to https://heartbeat.lucidworks.io. Each request includes a unique identifier, which is anonymous and can’t be used to identify the sender. The IP that sent the request is not stored with the request.

How to Opt-Out

By default, the usage monitor is enabled in your system. If you would like to opt-out of sending this data to Lucidworks, you can disable the usage monitor. There are two ways to enable or disable the usage monitor:

  1. Go to the Heartbeat Data page in the Fusion UI (System → Heartbeat Data), and deselect the "Report Heartbeat" option.

  2. Use the Configurations API and send a PUT request as follows:

    curl -u user:pass -H 'Content-type: application/json' -X PUT -d '"false"' http://localhost:8764/api/apollo/configurations/usageMonitor