com.github.qzagarese.dockerunit.discovery.consul.annotation

Annotation Type WebHealthCheck

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface WebHealthCheck

Allows the configuration of a health check endpoint so that Consul can verify the state of each of the service replicas.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	endpoint The path of the health check endpoint in your service.
int	exposedPort The port that is exposed by the container (not the one it is mapped to on the host network interface) Default is 80
int	pollingInterval The length of the interval (in seconds) Consul will wait before re-checking the service state.
WebHealthCheck.WebProtocol	protocol The web protocol.

Element Detail

endpoint

public abstract String endpoint

The path of the health check endpoint in your service. Default is /health-check

Returns:

the health check endpoint

Default:

"/health-check"

protocol

public abstract WebHealthCheck.WebProtocol protocol

The web protocol. Default is HTTP. HTTP and HTTPS are supported

Returns:

the web protocol

Default:

com.github.qzagarese.dockerunit.discovery.consul.annotation.WebHealthCheck.WebProtocol.HTTP

exposedPort

public abstract int exposedPort

The port that is exposed by the container (not the one it is mapped to on the host network interface) Default is 80

Returns:

the port number

Default:

80

pollingInterval

public abstract int pollingInterval

The length of the interval (in seconds) Consul will wait before re-checking the service state. Default is 1 second.

Returns:

the interval in seconds

Default:

1