com.linecorp.armeria.server.healthcheck

Class HttpHealthCheckService

java.lang.Object

com.linecorp.armeria.server.AbstractHttpService

com.linecorp.armeria.server.healthcheck.HttpHealthCheckService

All Implemented Interfaces:

HttpService, Service<HttpRequest,HttpResponse>

Direct Known Subclasses:

ManagedHttpHealthCheckService

public class HttpHealthCheckService
extends AbstractHttpService

An HttpService that responds with HTTP status "200 OK" if the server is healthy and can accept requests and HTTP status "503 Service Not Available" if the server is unhealthy and cannot accept requests. The default behavior is to respond healthy after the server is started and unhealthy after it started to stop.

Subclasses can override newHealthyResponse(ServiceRequestContext) or newUnhealthyResponse(ServiceRequestContext) if they need to customize the response.

Example:

 Server server = new ServerBuilder()
         .defaultVirtualHost(new VirtualHostBuilder()
                 .service("/rpc", new THttpService(myHandler))
                 .service("/health", new HttpHealthCheckService())
                 .build())
         .build();
 

You can also specify additional HealthCheckers at construction time. It will respond with a unhealthy response if the HealthChecker.isHealthy() method returns false for any of them. This can be useful when you want to stop receiving requests from a load balancer without stopping a Server. e.g. the backend got unhealthy.

 SettableHealthChecker healthChecker = new SettableHealthChecker();
 Server server = new ServerBuilder()
         .defaultVirtualHost(new VirtualHostBuilder()
                 .service("/rpc", new THttpService(myHandler))
                 .service("/health", new HttpHealthCheckService(healthChecker))
                 .build())
         .build();
 

Constructor Summary

Constructors

Constructor and Description
HttpHealthCheckService(HealthChecker... healthCheckers) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected HttpResponse	doGet(ServiceRequestContext ctx, HttpRequest req) Handles a GET request.
protected HttpResponse	doHead(ServiceRequestContext ctx, HttpRequest req) Handles a HEAD request.
protected AggregatedHttpMessage	newHealthyResponse(ServiceRequestContext ctx) Creates a new response which is sent when the Server is healthy.
protected AggregatedHttpMessage	newUnhealthyResponse(ServiceRequestContext ctx) Creates a new response which is sent when the Server is unhealthy.
void	serviceAdded(ServiceConfig cfg) Invoked when this Service has been added to a Server with the specified configuration.

Methods inherited from class com.linecorp.armeria.server.AbstractHttpService

doDelete, doDelete, doGet, doHead, doOptions, doOptions, doPatch, doPatch, doPost, doPost, doPut, doPut, doTrace, doTrace, serve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.armeria.server.Service

as, decorate, decorate, decorate, shouldCachePath

Constructor Detail

HttpHealthCheckService

public HttpHealthCheckService(HealthChecker... healthCheckers)

Creates a new instance.

Parameters:

healthCheckers - the additional HealthCheckers

Method Detail

newHealthyResponse

protected AggregatedHttpMessage newHealthyResponse(ServiceRequestContext ctx)

Creates a new response which is sent when the Server is healthy.

newUnhealthyResponse

protected AggregatedHttpMessage newUnhealthyResponse(ServiceRequestContext ctx)

Creates a new response which is sent when the Server is unhealthy.

serviceAdded

public void serviceAdded(ServiceConfig cfg)
                  throws Exception

Description copied from interface: Service

Invoked when this Service has been added to a Server with the specified configuration. Please note that this method can be invoked more than once if this Service has been added more than once.

Throws:

Exception

doHead

protected HttpResponse doHead(ServiceRequestContext ctx,
                              HttpRequest req)

Description copied from class: AbstractHttpService

Handles a HEAD request. This method sends a 405 Method Not Allowed response by default.

Overrides:

doHead in class AbstractHttpService

doGet

protected HttpResponse doGet(ServiceRequestContext ctx,
                             HttpRequest req)

Description copied from class: AbstractHttpService

Handles a GET request. This method sends a 405 Method Not Allowed response by default.

Overrides:

doGet in class AbstractHttpService