Introduction
Health Status Checks cover the following products:
- Database,
- JS7 JOC Cockpit,
- JS7 Controller,
- JS7 Agents.
For each product checks can be performed that verify the connection status and component status:
- The connection status indicates if a connection can be established to the given product.
- In case of a successful connection the component status reports if the product is operational.
Checks
Database Status
JOC Cockpit makes use of the JS7 - Database to store inventory information, the history of job executions and job logs.
If the database is not available, then JOC Cockpit will not work. Users who identify unstable database connections, should run the below check.
Unstable connections include short-term connection loss within the last 30 minutes. JOC Cockpit will reconnect when the database becomes available. More severe issues include database deadlocks and exhaustion of connections available from JOC Cockpit's connection pool.
- The connection status indicates if connections to the database are established.
- The component status indicates if the database is ready to executes transactions.
| Workflow | Severity |
|---|---|
Self-Test-Health-Status-Database | Error |
JOC Cockpit Status
The JOC Cockpit is the GUI and REST API server used to manage the inventory and to monitor Controllers and Agents.
If the database is not available then JOC Cockpit will not work. In case that JOC Cockpit is not operational, workflows and jobs will continue to run as scheduled with the Controller and Agents.
- The connection status indicates if JOC Cockpit is up & running and if users can connect. The status is reported for all JOC Cockpit instances in a cluster.
- The component status indicates if JOC Cockpit is operational and works as expected.
| Workflow | Severity |
|---|---|
Self-Test-Health-Status-JOC-Cockpit | Error |
Controller Status
The Controller is used to orchestrate Agents, to receive the execution history and log output of jobs from Agents. The Controller forwards such information to JOC Cockpit.
If the Controller is not available, then complex workflows will be affected. Running jobs will not be affected that are executed autonomously with Agents.
- The connection status to Controllers indicates if JOC Cockpit can successfully connect to a Controller. The status is reported for all Controllers registered with JOC Cockpit. If a JS7 - Controller Cluster is used, then the status is reported for each Controller instance.
- The component status of Controllers indicates if the Controller instance is functional. For a Controller Cluster this includes that all instances are coupled and that the cluster is established.
| Workflow | Severity |
|---|---|
Self-Test-Health-Status-Controller | Error |
Agent Status
JS7 Agents are used to execute jobs. The Controller forwards workflows and orders to Agents that will execute jobs autonomously at the scheduled time.
If an Agent becomes unavailable, then no jobs will be executed. In a JS7 - Agent Cluster fail-over capabilities allow to run jobs with remaining Agents.
The check reports about all Agents registered with Controllers.
- The connection status indicates if a Controller can connect to an Agent. This includes to report the status for Standalone Agents and for Agent Clusters registered with a Controller.
- The component status indicates if an Agent is operational. For an Agent Cluster this includes that all Director Agents are coupled and that the cluster is established.
| Workflow | Severity |
|---|---|
Self-Test-Health-Status-Agent | Error |
The workflow makes use of the following arguments:
| Argument Name | Default | Purpose |
|---|---|---|
hlth_only_visible_agents | true | Reports Agents only that are not hidden but are visible in JOC Cockpit. |