Interface HealthCheck

interface HealthCheck {
    checkDelay?: string;
    checkMaxRetries: number;
    checkSendProxy: boolean;
    checkTimeout?: string;
    httpConfig?: HealthCheckHttpConfig;
    httpsConfig?: HealthCheckHttpsConfig;
    ldapConfig?: HealthCheckLdapConfig;
    mysqlConfig?: HealthCheckMysqlConfig;
    pgsqlConfig?: HealthCheckPgsqlConfig;
    port: number;
    redisConfig?: HealthCheckRedisConfig;
    tcpConfig?: HealthCheckTcpConfig;
    transientCheckDelay?: string;
}

Properties

checkDelay? checkMaxRetries checkSendProxy checkTimeout? httpConfig? httpsConfig? ldapConfig? mysqlConfig? pgsqlConfig? port redisConfig? tcpConfig? transientCheckDelay?

Properties

OptionalcheckDelay

checkDelay?: string

Time to wait between two consecutive health checks.

checkMaxRetries

checkMaxRetries: number

Number of consecutive unsuccessful health checks after which the server will be considered dead.

checkSendProxy

checkSendProxy: boolean

Defines whether proxy protocol should be activated for the health check.

OptionalcheckTimeout

checkTimeout?: string

Maximum time a backend server has to reply to the health check.

OptionalhttpConfig

httpConfig?: HealthCheckHttpConfig

Object to configure an HTTP health check.

One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.

OptionalhttpsConfig

httpsConfig?: HealthCheckHttpsConfig

Object to configure an HTTPS health check.

One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.

OptionalldapConfig

ldapConfig?: HealthCheckLdapConfig

Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.

One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.

OptionalmysqlConfig

mysqlConfig?: HealthCheckMysqlConfig

Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.

One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.

OptionalpgsqlConfig

pgsqlConfig?: HealthCheckPgsqlConfig

Object to configure a PostgreSQL health check.

One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.

port

port: number

Port to use for the backend server health check.

OptionalredisConfig

redisConfig?: HealthCheckRedisConfig

Object to configure a Redis health check. The response is analyzed to find the +PONG response message.

One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.

OptionaltcpConfig

tcpConfig?: HealthCheckTcpConfig

Object to configure a basic TCP health check.

One-of ('config'): at most one of 'tcpConfig', 'mysqlConfig', 'pgsqlConfig', 'ldapConfig', 'redisConfig', 'httpConfig', 'httpsConfig' could be set.

OptionaltransientCheckDelay

transientCheckDelay?: string

Time to wait between two consecutive health checks when a backend server is in a transient state (going UP or DOWN).

Settings

On This Page

Properties