Cluster validation on Kyvos restart

Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Kyvos comes with a built-in validation framework, that performs the sanity test of the system (on every restart) and ensures that the system is ready to serve queries.

The framework runs checks, such as:

Runs sanity build (validation and build both).
Executes sanity queries to validate if the queries (for both MDX and SQL) are successfully served from the query engine.
Execute sanity queries (for both MDX and SQL ) to validate the result cache.
Notify the complete status of all the checks, and so on.

You can specify the name and type of the cube to be built, the cube on which the queries should be executed, the number of queries to be executed, the type of queries to be executed, the type of cache to be validated, and so on.

To enable cluster validation on installation, perform the following steps.

Navigate to /data/kyvos/app/kyvos/olapengine/conf folder.
Open the clusterValidator.json file.
In the Globals section, modify the following parameters as needed.

Parameter	Description
status	Enable or disable cluster validation on restart
timeToWaitInMinutes	Provide the time interval for which the system should wait until Query Engines are successfully initialized after the BI Server bootup
emailId	Email ID of the user who will be notified.
notifyOn	Set the value as success or failure. A notification will be sent to the email ID mentioned above.
detailsToCapture	Specify the details of events that you want to capture.
requiredDetails	Specify the details of logs to be captured in the following: requiredDetails: Comma-separated list of items that you want to capture. In logs. For example, threadDump,buildLogs,outFile,processLogs path: Provide the path where logs will be captured. For example: ../logs/BootupValidation/ backupFileLimit: The number of backup files to be maintained. The default value is 5. Whenever the system will try to capture logs on a BI server/Query engine for a cluster, it will check if the total number of files of cluster validation logs is exceeding the count of the configured threshold. If it exceeds, then the system will delete extra files by sorting them on the basis of the last-modified timestamp of those files.
QueryExecution status	Enable or disable the execution of queries during sanity testing. By default, the system will not execute queries on the configured cube.
cubeName	Name of the cube on which the queries are to be executed.
cubeID	For query execution enabled, cubeID is a mandatory field.
Filters	Provide filters to specify which queries to execute on the cube. If no filters are provided then the system will execute all the saved queries of the specified cube.