Skip to main contentIBM Video Streaming Developers

OperationsHealth

Health of ECDN server’s operational services (ones that doesn’t affect content delivery).

type OperationsHealth {
    # Aggregated health of operational services.
    # (ones that doesn't affect content delivery).
    # - GOOD if all services are in GOOD state.
    # - WARNING if at least one is in WARNING and none of them are in POOR state.
    # - POOR if at least one is in POOR state.
    aggregated(): Health!
    # Health of update service.
    # - GOOD if update repositories are reachable.
    # - POOR if update repositories are unreachable.
    # If parent proxy feature is enabled:
    # - GOOD same as before and all parents are reachable.
    # - WARNING update repositories are but not all parents are reachable.
    # - POOR same as before or no parents are reachable.
    updates(): Health!
    # Health of ECDN software update.
    # - GOOD if server has the latest ECDN version.
    # - WARNING if server version isn't the latest but still supported.
    # - POOR if server version isn't supported anymore.
    softwareVersion(): Health!
    # Health of API connection.
    # - GOOD if ECDN API is reachable.
    # - POOR if ECDN API is unreachable.
    # If parent proxy feature is enabled:
    # - GOOD same as before and all parents are reachable.
    # - WARNING ECDN API is but not all parents are reachable.
    # - POOR same as before or no parents are reachable.
    # On POOR status content delivery will continue to function properly, but ECDN
    # server won't be able to apply remote configurations or report status.
    apiConnection(): Health!
    # Health of metric collector service.
    # - GOOD if service is up and running.
    # - POOR if service isn't running.
    metrics(): Health!
    # Health of NTP service.
    # - GOOD if ECDN server is in sync with NTP servers.
    # - WARNING if ECDN server is in sync with at least one NTP server but not all of them.
    # - POOR if:
    # - ECDN server isn't in sync with any NTP servers.
    # - NTP service isn't running.
    # - Time skew is higher than 1 minute.
    ntp(): Health!
    # Health of log forwarding service. Null if log forwarding is disabled.
    # - GOOD if ECDN server can forward logs.
    # - POOR if ECDN server cannot forward logs.
    # On POOR status log forwarder service might not be running.
    logForward(): Health
    # Health of remote assistance service. Null if remote assistance is disabled.
    # - GOOD if remote assistance is working fine.
    # - POOR if remote assistance is working fine.
    # On POOR status remote assistance service might not be running or remote
    # assistance server is unreachable.
    remoteAssistance(): Health
    # Health of SNMP polling service. Null if SNMP polling is disabled.
    # - GOOD if SNMP service is up and running.
    # - POOR if SNMP service isn't running.
    snmp(): Health
}

Fields

aggregated: Health!

Aggregated health of operational services. (ones that doesn’t affect content delivery).

  • GOOD if all services are in GOOD state.
  • WARNING if at least one is in WARNING and none of them are in POOR state.
  • POOR if at least one is in POOR state.

updates: Health!

Health of update service.

  • GOOD if update repositories are reachable.
  • POOR if update repositories are unreachable. If parent proxy feature is enabled:
  • GOOD same as before and all parents are reachable.
  • WARNING update repositories are but not all parents are reachable.
  • POOR same as before or no parents are reachable.

softwareVersion: Health!

Health of ECDN software update.

  • GOOD if server has the latest ECDN version.
  • WARNING if server version isn’t the latest but still supported.
  • POOR if server version isn’t supported anymore.

apiConnection: Health!

Health of API connection.

  • GOOD if ECDN API is reachable.
  • POOR if ECDN API is unreachable. If parent proxy feature is enabled:
  • GOOD same as before and all parents are reachable.
  • WARNING ECDN API is but not all parents are reachable.
  • POOR same as before or no parents are reachable. On POOR status content delivery will continue to function properly, but ECDN server won’t be able to apply remote configurations or report status.

metrics: Health!

Health of metric collector service.

  • GOOD if service is up and running.
  • POOR if service isn’t running.

ntp: Health!

Health of NTP service.

  • GOOD if ECDN server is in sync with NTP servers.
  • WARNING if ECDN server is in sync with at least one NTP server but not all of them.
  • POOR if:
    • ECDN server isn’t in sync with any NTP servers.
    • NTP service isn’t running.
    • Time skew is higher than 1 minute.

logForward: Health

Health of log forwarding service. Null if log forwarding is disabled.

  • GOOD if ECDN server can forward logs.
  • POOR if ECDN server cannot forward logs. On POOR status log forwarder service might not be running.

remoteAssistance: Health

Health of remote assistance service. Null if remote assistance is disabled.

  • GOOD if remote assistance is working fine.
  • POOR if remote assistance is working fine. On POOR status remote assistance service might not be running or remote assistance server is unreachable.

snmp: Health

Health of SNMP polling service. Null if SNMP polling is disabled.

  • GOOD if SNMP service is up and running.
  • POOR if SNMP service isn’t running.