org.keycloak.quarkus.runtime.services.health.KeycloakReadyAsyncHealthCheck Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.keycloak.quarkus.runtime.services.health;

import io.agroal.api.AgroalDataSource;
import io.quarkus.agroal.runtime.health.DataSourceHealthCheck;
import io.quarkus.smallrye.health.runtime.QuarkusAsyncHealthCheckFactory;
import io.smallrye.health.api.AsyncHealthCheck;
import io.smallrye.mutiny.Uni;
import jakarta.annotation.PostConstruct;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
import org.eclipse.microprofile.health.HealthCheckResponse;
import org.eclipse.microprofile.health.HealthCheckResponseBuilder;
import org.eclipse.microprofile.health.Readiness;

import java.time.Instant;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.concurrent.atomic.AtomicReference;

/**
 * Keycloak Healthcheck Readiness Probe.
 * 
 * Performs a hybrid between the passive and the active mode. If there are no healthy connections in the pool,
 * it invokes the standard DataSourceHealthCheck that creates a new connection and checks if it's valid.
 * 

 * While the check for healthy connections is non-blocking, the standard check is blocking, so it needs to be wrapped.
 * 
 * When NON_BLOCKING_PROBES is no longer behind a feature flag but the only option, it will replace the
 * {@link KeycloakReadyHealthCheck}.
 *
 * @see Healthcheck API Design
 */
@Readiness
@ApplicationScoped
public class KeycloakReadyAsyncHealthCheck implements AsyncHealthCheck {

    /** As the DataSourceHealthCheck doesn't exist as an application scoped bean,
    * create our own instance here which exposes the init() call for the delegate. */
    MyDataSourceHealthCheck delegate;

    private static class MyDataSourceHealthCheck extends DataSourceHealthCheck {
        @Override
        public void init() {
            super.init();
        }
    }

    @PostConstruct
    protected void init() {
        delegate = new MyDataSourceHealthCheck();
        delegate.init();
    }

    /**
     * Date formatter, the same as used by Quarkus. This enables users to quickly compare the date printed
     * by the probe with the logs.
     */
    static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss,SSS").withZone(ZoneId.systemDefault());

    @Inject
    AgroalDataSource agroalDataSource;

    @Inject
    QuarkusAsyncHealthCheckFactory healthCheckFactory;

    AtomicReference failingSince = new AtomicReference<>();

    @Override
    public Uni call() {
        HealthCheckResponseBuilder builder = HealthCheckResponse.named("Keycloak database connections async health check").up();
        long activeCount = agroalDataSource.getMetrics().activeCount();
        long invalidCount = agroalDataSource.getMetrics().invalidCount();
        if (activeCount < 1 || invalidCount > 0) {
            return healthCheckFactory.callSync(() -> {
                HealthCheckResponse activeCheckResult = delegate.call();
                if (activeCheckResult.getStatus() == HealthCheckResponse.Status.DOWN) {
                    builder.down();
                    Instant failingTime = failingSince.updateAndGet(this::createInstanceIfNeeded);
                    builder.withData("Failing since", DATE_FORMATTER.format(failingTime));
                }
                return builder.build();
            });
        } else {
            failingSince.set(null);
            return healthCheckFactory.callAsync(() -> Uni.createFrom().item(builder.build()));
        }
    }

    Instant createInstanceIfNeeded(Instant instant) {
        if (instant == null) {
            return Instant.now();
        }
        return instant;
    }
}