Enabling health check URL for load balanced Spotfire Servers

Kisiel, Pawel

Problem:

How to configure a health check for the Spotfire Server when using a load balancer.

Solution:

When using a load balancer in front of a cluster of Spotfire Servers, a health check URL can be set up to show the status of the servers.

Procedure:

Open a command-line interface and export the active configuration by using the export-config command. (For details on using the Spotfire command line, see Executing commands on the command line.)
On the command line, enter the following command:
```
config set-config-prop --name=status-controller.enabled --value=true
```
For information about the command options, see set-config-prop.
Import the configuration file back to the Spotfire database by using the import-config command.
Restart the Spotfire Server computers in the cluster.

Results

You can now use the URL /spotfire/rest/status/getStatus to check the status of the servers in your cluster.

If the health check URL hasn't been enabled, the HTTP code 404 is returned.
If the server is up and running, the HTTP code 200 is returned along with the text RUNNING.
If the server is currently starting or stopping, the HTTP code 503 is returned along with the text STARTING or STOPPING.
If the server is currently in the draining phase of a graceful shutdown, the HTTP code 200 is returned along with the text DRAINING. When the draining phase completes, the server stops.
Note: You can configure this HTTP code 200 by setting status-controller.status-on-draining.