io.micronaut.kubernetes.health.KubernetesHealthIndicator Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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 io.micronaut.kubernetes.health;

import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.models.V1ContainerStatus;
import io.kubernetes.client.openapi.models.V1ObjectMeta;
import io.kubernetes.client.openapi.models.V1Pod;
import io.kubernetes.client.openapi.models.V1PodStatus;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.env.Environment;
import io.micronaut.core.util.StringUtils;
import io.micronaut.health.HealthStatus;
import io.micronaut.kubernetes.KubernetesConfiguration;
import io.micronaut.kubernetes.client.reactor.CoreV1ApiReactorClient;
import io.micronaut.management.endpoint.health.HealthEndpoint;
import io.micronaut.management.health.indicator.AbstractHealthIndicator;
import jakarta.inject.Singleton;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;

import static io.micronaut.kubernetes.health.KubernetesHealthIndicator.HOSTNAME_ENV_VARIABLE_IN_PROPERTY_FORMAT;

/**
 * Health indicator to show the current Pod information.
 *
 * @author Álvaro Sánchez-Mariscal
 * @since 1.0.0
 */
@Singleton
@Requires(beans = HealthEndpoint.class)
@Requires(env = Environment.KUBERNETES)
@Requires(property = HOSTNAME_ENV_VARIABLE_IN_PROPERTY_FORMAT)
@Requires(property = HealthEndpoint.PREFIX + ".kubernetes.enabled", notEquals = StringUtils.FALSE)
public class KubernetesHealthIndicator extends AbstractHealthIndicator> {

    public static final String NAME = "kubernetes";
    public static final String HOSTNAME_ENV_VARIABLE = "HOSTNAME";
    public static final String HOSTNAME_ENV_VARIABLE_IN_PROPERTY_FORMAT = "hostname";

    private static final Logger LOG = LoggerFactory.getLogger(KubernetesHealthIndicator.class);

    private final CoreV1ApiReactorClient client;
    private final KubernetesConfiguration configuration;

    /**
     * Constructor.
     *
     * @param client        The Kubernetes client
     * @param configuration The Kubernetes configuration
     */
    public KubernetesHealthIndicator(CoreV1ApiReactorClient client,
                                     KubernetesConfiguration configuration) {
        this.client = client;
        this.configuration = configuration;
        this.healthStatus = HealthStatus.UP;
    }

    private Map processError(Throwable throwable) {
        LOG.warn("Error while getting Pod information", throwable);
        Map healthInformation = new LinkedHashMap<>();
        healthInformation.put("error", throwable.getMessage());
        this.healthStatus = HealthStatus.UNKNOWN;
        return healthInformation;
    }

    private Map processPod(V1Pod pod) {
        if (LOG.isTraceEnabled()) {
            LOG.trace("Processing pod: {}", pod);
        }

        this.healthStatus = HealthStatus.UP;

        Map healthInformation = new LinkedHashMap<>();

        Optional metaOptional = Optional.ofNullable(pod.getMetadata());
        if (metaOptional.isPresent()) {
            V1ObjectMeta objectMeta = metaOptional.get();
            healthInformation.put("namespace", objectMeta.getNamespace());
            healthInformation.put("podName", objectMeta.getName());
        }

        Optional podStatusOptional = Optional.ofNullable(pod.getStatus());
        if (podStatusOptional.isPresent()) {
            V1PodStatus podStatus = podStatusOptional.get();
            healthInformation.put("podPhase", podStatus.getPhase());
            healthInformation.put("podIP", podStatus.getPodIP());
            healthInformation.put("hostIP", podStatus.getHostIP());
            healthInformation.put("containerStatuses",
                    Objects.requireNonNull(podStatus.getContainerStatuses())
                            .stream()
                            .collect(ArrayList::new, KubernetesHealthIndicator::accumulateContainerStatus, ArrayList::addAll));
        }
        if (LOG.isTraceEnabled()) {
            LOG.trace("Pod health information: {}", healthInformation);
        }
        return healthInformation;
    }

    private static void accumulateContainerStatus(ArrayList