Spotfire Server: description of Spotfire Web Player health status codes

Summary:
Description of Web Player the status codes Available, Strained, and Exhausted in version 7.5 and higher

Details:
Three status codes for Web Player instances were introduced in Spotfire 7.5: Available, Strained and Exhausted. These are used to better route traffic among Web Player instances within the resource pools. The status codes are calculated from the CPU or memory usage on the server running the node manager service. The CPU and memory usage is per physical server, not per Web Player instance. This means that if you have N Web Player instances running on the same node manager, the Web Player instances will be sharing the system's CPU and memory resources. These N instances will all calculate their status from the CPU and memory usage of the physical server. For example, if one Web Player instance changes its status to Strained, then all of the other Web Player instances running on that server will also change status.

Behavior and error messages displayed to end users

Available
This means that the load is low and the Web Player instance is available. No error messages are shown to the end user.

Strained
If a service instance is Strained, new users will be routed to other instances that are not Strained or Exhausted. If all instances are Strained, new users will be routed to the Strained instance. No error messages will be shown to the end users.

Exhausted
If a service instance is Exhausted, no new users will be routed to that instance. If no other instances in the resource pool are in "Available" or "Strained" status, then this error message will be presented to the end user: 

 "The analysis could not be opened because all web player services have reached their maximum capacity. Try again later."

Default settings

Strained

- Average CPU load: 50%
- Memory load: 75%

To go back to Available status, the load needs to drop below:

- Average CPU load: 45%
- Memory load: 70%

Exhausted

- Average CPU load: 90%
- Memory load: 98%

To go back to Strained status, the load needs to drop below:

- Average CPU load: 85%
- Memory load: 93%

The time span for calculation of Average CPU load is set to 120 seconds by default. For a Web Player instance to become Strained, it needs to either have a CPU load of 50% for 120 seconds or more, or have a memory load of more than 75%. It does not need to have both loads hit the limit to become strained.
 

Where to change the settings

The settings can be changed in the service configuration files "Spotfire.Dxp.Worker.Host.exe.config" and "Spotfire.Dxp.Worker.Web.config"

Spotfire.Dxp.Worker.Host.exe.config

WebPlayer_AverageCpuLoadExhaustedLimit
WebPlayer_AverageCpuLoadNotExhaustedLimit
WebPlayer_AverageCpuLoadStrainedLimit
WebPlayer_AverageCpuLoadNotStrainedLimit

DataBlockStorage_MemoryLoadExhaustedLimit
DataBlockStorage_ MemoryLoadNotExhaustedLimit
DataBlockStorage_MemoryLoadStrainedLimit
DataBlockStorage_MemoryLoadNotStrainedLimit

If these are not present you need to add a section like this for the limits that you want to change:

<Spotfire.Dxp.Web.Properties.Settings>
WebPlayer_AverageCpuLoadStrainedLimit="70"
WebPlayer_AverageCpuLoadNotStrainedLimit="65"
WebPlayer_AverageCpuLoadExhaustedLimit="95"
WebPlayer_AverageCpuLoadNotExhaustedLimit="85"
</Spotfire.Dxp.Web.Properties.Settings>

Spotfire.Dxp.Worker.Web.config

cpuAverageTimeSpan

https://docs.tibco.com/pub/spotfire_server/14.0.6/doc/html/TIB_sfire_server_tsas_admin_help/server/topics/spotfire.dxp.worker.host.exe.config_file.html

https://docs.tibco.com/pub/spotfire_server/14.0.6/doc/html/TIB_sfire_server_tsas_admin_help/server/topics/spotfire.dxp.worker.web.config_file.html