JITL job template com.sos.jitl.jobs.monitoring.MonitoringJob for health status checks

Feature

• Purpose
  • The JITL MonitoringJob template can be used to perform health checks of JS7 JOC Cockpit, Controller and Agents. Health check reports are stored to disk in JSON format. Health check results can be forwarded, for example by mail with a later MailJob template.
  • Users can forward health check results for integration with their monitoring system.
  • SOS offers a 24/7 Monitoring Service to receive health check results of customers using a commercial license,
• Java Class
  • com.sos.jitl.jobs.monitoring.MonitoringJob
• Parameterization
  • Arguments
    • controller_id (optional, default: current Controller)
    • monitor_report_dir: directory with the Agent to which report files are stored.
    • monitor_report_max_files: max. number of report files before cleanup is performed.
    • max_failed_orders: If the number of failed orders is greater  an alert is send.
    • from: e-mail address from which notifications are sent
  • Return Values
    • monitor_report_date: date string holding the date/time when the report was created
    • monitor_report_file: path to the report file that was created
    • subject: e-mail subject
    • body: e-mail body
    • result: The number of failed checks

• Health Status Checks
  • Controller
    • Checks for valid JSON:
      • The element controllerStatus is present.
      • The element volatileStatus is present.
      • In volatileStatus the element connectionStates is present.
      • In volatileStatus the element componentState is present.
      • In volatileStatus the element role is present.
      • When role is present and volatileStatus does not carry the value STANDALONE then the element clusterNodeState is present.
    • Checks for health:
      • In volatileStatus the element connectionStates includes severity with value 0.
      • In volatileStatus the element componentState includes severity with value 0.
      • When role is present and volatileStatus does not carry the value STANDALONE then the element clusterNodeState includes severity with value 0.
      • When role is present and volatileStatus does not carry the value STANDALONE then the element isCoupled }}carries the value {{{}true.
  • Agents
    • Checks for valid JSON:
      • The element agentStatus is present and not empty.
      • Only disabled agents and subAgents are considered.
      • In agentStatus the elements state or healthState are present.
      • In agentStatus the element state is present or subAgents is present and includes at least one element.
      • In subAgentStatus the state is present.
    • Checks for health:
      • In agentStatus if the element healthState is present it includes severity with a value 0.
      • In agentStatus if the element state is present then the healthState includes severity with a value 0.
      • For each enabled subAgent the element state includes severity with a value 0.
  • JOC
    • Checks for valid JSON:
      • The element jocStatus is present.
      • In jocStatus the element connectionState is present.
      • In jocStatus the element componentState is present.
    • Checks for Health:
      • The element connectionState includes severity with a value 0.
      • The element componentState includes severity with a value 0.
      • If the element clusterNodeState is present then it includes severity with a value 0.
      • If controllerConnectionStates is present then each connectionState includes severity with a value 0.
  • Orders
    • Checks for valid JSON:
      • The element orderSnapshot is present.
    • Checks for Health:
      • The element orderSnapshot includes failed with a value <= max_failed_orders.