Configuring Health Check settings (Automatic Business Continuity)

Review information about the Health Check service and how to configure it for Automatic Business Continuity.
The Health Check service is a local agent that lets your Validation server switch to Business Continuity mode automatically when the connection to the VIP Authentication Service is down. This service is required when any of your Validation servers are configured for Automatic Business Continuity. Configure your Health Check Settings from
Settings > Health Check Settings
. You can also configure email settings to receive notifications during network connectivity issues.
To allow Health Check to switch to Business Continuity mode automatically, your Validation server must be configured to use Business Continuity in Automatic mode.
To allow Health Check to send email notifications, you must configure an SMTP server.
  1. To configure Health Check settings:
  2. From the
    Settings
    tab, select the
    Health Check Settings
    link.
  3. When you configure Health Check settings for the first time, you are prompted to enable Health Check. Click
    Yes
    . Otherwise, click
    Edit
    .
  4. Complete the following fields, as required and click
    Save
    :
    Field
    Description
    Log Settings
    Logging Level
    Set the level of detail that is captured by logs. (The default is INFO.) The logging level set here is the level that is used by other VIP Enterprise Gateway components if they are set to the Default log level. Optionally, you can configure each component to a particular level of logging detail when you configure that component.
    Select the appropriate level from the drop-down list:
    • DEBUG: The log captures general details, and stack traces of all exception events.
    • INFO: The log captures general details that are needed to track how the server is functioning. The Logging component accepts and logs debug messages from any other components.
    • WARN: The log captures details of potentially harmful events—rejected transactions and exception events that affect the server.
    • ERROR: The log captures details of events that hinder the server or transaction, but which may still allow the server to function (except events that affect the server).
    Number of Files to Keep
      Select the number of old log files that the VIP Enterprise Gateway keeps.
    To determine how many days' logs the server keeps, multiply the
    Number of Files to Keep
    by the
    Log File Rotation Interval
    . For example, to keep logs for 28 days, select
    7
    for
    Log File Rotation Interval
    , and
    4
    for
    Number of Files to Keep
    , or
    1
    for
    Log File Rotation Interval
    and
    28
    for
    Number of Files to Keep
    . After 28 days, the server will write over the oldest archived log file.
    You should archive your log files on another server for auditing purposes, and so that you can set the Number of Files to Keep at a lower number.
    Log Rotation Interval
    Select how frequently you want to create a new log file. The default is 1 day. When you create a new log file, the Validation server archives the old log file, and pre-pends
    _cls_rolled
    to the filename.
    Enable Syslog
    Select
    Yes
    to allow Health Check to use syslog to write logs to a syslog server. You must configure Syslog Settings (
    Logs
    >
    Syslog Settings
    ) for this feature to work.
    General Settings
    Port
      The port number for the SMTP server.
    Retries
    Select the number of times Health Check service attempts to connect to the VIP Authentication Service before restoring the connectivity.
    Poll Interval
    Enter how long Health Check waits between checking network settings. This value must be from 1 through 60 minutes.
    Connection Timeout
    Set the amount of time (in milliseconds) you want to keep trying to connect to the VIP Authentication Service.
    Enable SSL
    Select
    Yes
    if Health Check is protected by an SSL certificate. The certificate must be a self-signed certificate using 127.0.0.1 as the IP.
    If you select the HTTPS protocol, you must select an SSL key from the list.
    Email Notification
    Select
    Enable
    to allow VIP Enterprise Gateway to use the SMTP server to send email notifications to administrators and users. To allow Health Check to send email notifications, you must configure an SMTP server.
    Configure the content of email notifications of connectivity issues on this page. Configure the content of registration emails on the Registration Email Settings tab.
    Notification - Network Connectivity
    Connectivity Lost
    Enter a Subject and Body for the email that VIP Enterprise Gateway sends to administrators if Health Check determines that the Validation server is unable to connect with the VIP Authentication Service and is switching to Business Continuity mode.
    Connectivity Restored
    Enter a Subject and Body for the email that VIP Enterprise Gateway sends to administrators if Health Check determines that the Validation server regains connectivity with the VIP Authentication Service and is exiting Business Continuity mode.
    Lost Connectivity (Notify Only)
    Enter a Subject and Body for the email that VIP Enterprise Gateway sends to administrators if Health Check determines that the Validation server is unable to connect with the VIP Authentication Service. VIP Enterprise Gateway takes no action.
    Connectivity Restored (Notify Only)
    Enter a Subject and Body for the email that VIP Enterprise Gateway sends to administrators if Health Check determines that the Validation server regains connectivity with the VIP Authentication Service. VIP Enterprise Gateway takes no action.