Server Status (server-stat)
The status tool is a command-line utility for checking the current status of one or more Terracotta server instances.
For Microsoft Windows:
[PROMPT] %BIGMEMORY_HOME%\server\bin\server-stat.bat <args>
For UNIX/Linux:
[PROMPT] ${BIGMEMORY_HOME}/server/bin/server-stat.sh <args>
where <args> are:
[-s] host1,host2,... – Check one or more servers using the given hostnames or IP addresses using the default JMX port (9520).
[-s] host1:9520,host2:9521,... – Check one or more servers using the given hostnames or IP addresses with JMX port specified.
[-f] <path>/tc-config.xml – Check the servers defined in the specified configuration file.
[-k] – This flag causes invalid TMS SSL certificates to be ignored. Use this option to accept self-signed certificates (ones not signed by a trusted CA).
The status tool returns the following data on each server it queries:
Health– OK (server responding normally) or FAILED (connection failed or server not responding correctly).
Role – The server's position in an active-mirror group. Single servers always show ACTIVE. Backups are shown as MIRROR or PASSIVE.
State – The work state that the server is in. When ready, active servers should show ACTIVE-COORDINATOR, while mirror servers should show MIRROR-STANDBY or PASSIVE-STANDBY.
InitialState - Denotes the server's state prior to shutdown.
JMX port – The TCP port the server is using to listen for JMX events.
Error – If the status tool fails, the type of error.
Example
The following example shows usage of and output from the status tool.
[PROMPT] server-stat.sh -s localhost:9540
localhost:9510.health: OK
localhost:9510.role: ACTIVE
localhost:9510.initialState: ACTIVE-COORDINATOR
localhost:9510.state: ACTIVE-COORDINATOR
localhost:9510.port: 9540
localhost:9510.group name: default-group
If no server is specified, by default the tool checks the status of localhost at management port 9540.