com.bazaarvoice.ostrich.dropwizard.healthcheck.ContainsValidEndPointCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ostrich-dropwizard Show documentation

Helpers for using Ostrich with Dropwizard

There is a newer version: 2.1.0

package com.bazaarvoice.ostrich.dropwizard.healthcheck;

import com.bazaarvoice.ostrich.ServicePool;
import com.bazaarvoice.ostrich.pool.ServicePoolProxies;
import com.google.common.base.Strings;
import com.yammer.metrics.core.HealthCheck;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

/**
 * A simple health check that verifies a pool has at least one valid endpoint. This class will not execute a
 * health check directly, rather it accesses a cached count in the ServicePool via {@link com.bazaarvoice.ostrich.ServicePool#getNumValidEndPoints()},
 * so you will not overload your dependencies with health checks if this is run excessively.
 */
public class ContainsValidEndPointCheck extends HealthCheck {
    private final ServicePool _pool;

    protected ContainsValidEndPointCheck(ServicePool pool, String name) {
        super(name);
        checkArgument(!Strings.isNullOrEmpty(name));
        _pool = checkNotNull(pool);
    }

    /**
     * Returns a newly constructed health check for the given pool that will show as healthy if it has at least one valid end point.
     *
     * @param pool The {@code ServicePool} to look for valid end points in.
     * @param name The name of the health check. May not be empty or null.
     */
    public static ContainsValidEndPointCheck forPool(ServicePool pool, String name) {
        return new ContainsValidEndPointCheck(pool, name);
    }

    /**
     * Returns a newly constructed health check for the pool of the given proxy that will show as healthy if it has at
     * least one valid end point.
     *
     * @param proxy The {@code ServicePoolProxy} containing the service pool to look for valid end points in.
     * @param name  The name of the health check. May not be empty or null.
     */
    public static ContainsValidEndPointCheck forProxy(Object proxy, String name) {
        return new ContainsValidEndPointCheck(ServicePoolProxies.getPool(proxy), name);
    }

    @Override
    protected Result check() throws Exception {
        int numValidEndPoints = _pool.getNumValidEndPoints();
        int numBadEndPoints = _pool.getNumBadEndPoints();

        if (numValidEndPoints == 0 && numBadEndPoints == 0) {
            return Result.unhealthy("No end points.");
        }

        String message = String.format("%d healthy instances; %d unhealthy instances", numValidEndPoints, numBadEndPoints);
        return numValidEndPoints == 0
                ? Result.unhealthy(message)
                : Result.healthy(message);
    }
}