io.micronaut.configuration.clickhouse.health.ClickHouseHealthIndicator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-clickhouse Show documentation
This is integration between Micronaut and ClickHouse.
There is a newer version: 6.0.0
package io.micronaut.configuration.clickhouse.health;

import io.micronaut.configuration.clickhouse.ClickHouseConfiguration;
import io.micronaut.configuration.clickhouse.ClickHouseSettings;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.exceptions.ConfigurationException;
import io.micronaut.http.client.HttpClient;
import io.micronaut.management.health.indicator.HealthIndicator;
import io.micronaut.management.health.indicator.HealthResult;
import jakarta.inject.Inject;
import jakarta.inject.Singleton;
import org.reactivestreams.Publisher;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import reactor.core.publisher.Flux;

import java.net.MalformedURLException;
import java.util.Map;

import static io.micronaut.health.HealthStatus.DOWN;
import static io.micronaut.health.HealthStatus.UP;

/**
 * A {@link HealthIndicator} for ClickHouse.
 *
 * @author Anton Kurako (GoodforGod)
 * @since 22.3.2020
 */
@Requires(property = ClickHouseSettings.PREFIX + ".health.enabled", value = "true", defaultValue = "true")
@Requires(beans = ClickHouseConfiguration.class)
@Singleton
public class ClickHouseHealthIndicator implements HealthIndicator {

    private final Logger logger = LoggerFactory.getLogger(getClass());

    /**
     * The name to expose details with.
     */
    private static final String NAME = "clickhouse";
    private final HttpClient client;
    private final String database;
    private final ClickHouseHealthConfiguration healthConfiguration;

    @Inject
    public ClickHouseHealthIndicator(ClickHouseConfiguration configuration,
                                     ClickHouseHealthConfiguration healthConfiguration) {
        try {
            this.client = HttpClient.create(configuration.getURI().toURL());
            this.database = configuration.getProperties().getDatabase();
            this.healthConfiguration = healthConfiguration;
        } catch (MalformedURLException e) {
            throw new ConfigurationException(e.getMessage());
        }
    }

    @Override
    public Publisher getResult() {
        return Flux.from(client.retrieve("/ping"))
                .map(this::buildUpReport)
                .timeout(healthConfiguration.getTimeout())
                .retry(healthConfiguration.getRetry())
                .onErrorResume(e -> Flux.just(buildDownReport(e)));
    }

    private HealthResult buildUpReport(String response) {
        final Map details = Map.of("database", database);
        logger.debug("Health '{}' reported UP with details: {}", NAME, details);
        return getBuilder()
                .details(details)
                .status(UP)
                .build();
    }

    private HealthResult buildDownReport(Throwable e) {
        logger.debug("Health '{}' reported DOWN with error: {}", NAME, e.getMessage());
        return getBuilder()
                .status(DOWN)
                .exception(e)
                .build();
    }

    private static HealthResult.Builder getBuilder() {
        return HealthResult.builder(NAME);
    }
}