Install and Configure KVInsight

KVInsight comes bundled with the Oracle NoSQL Database distribution.

Download the Oracle NoSQL Database distribution (.tar.gz or .zip) for your operating system. As a prerequisite, install Java 17 or later on your machine. Extract the archive.

The KVInsight libraries and monitoring tool plugin libraries are available in the lib folder. The plugin libraries enable KVInsight to export metrics in formats compatible with external monitoring solutions.

Enable and Configure KVInsight

1. Configure Oracle NoSQL Database according to your requirements. For more details, see Configuring Oracle NoSQL Database.
2. Start each storage node agent (SNA) in the data store with the following command-line options:

   java -Dkvinsight.enable=true -Dprometheus.http.port=<port> -jar lib/kvstore.jar start -root $KVROOT

   where,

   • -Dkvinsight.enable=true

     Enables KVInsight metrics collection.

   • -Dprometheus.http.port=<port>

     Specifies the port for Prometheus to scrape the metrics exported by KVInsight. Replace <port> with your desired port number (for example, 8000).

   For more details on starting an SNA, see Starting a Storage Node Agent.

   Note:

   As of release 26.1, KVInsight supports Prometheus. By default, KVInsight also stores metrics locally as CSV files in the $KVROOT/<storename>/metrics folder of each Storage Node.