poapsis.ortserver.transport.kubernetes-jobmonitor.0.1.0-RC2.source-code.Reaper.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kubernetes-jobmonitor Show documentation

Part of the ORT Server, the reference implementation of Eclipse Apoapsis.

There is a newer version: 0.1.0-RC1

Show newest version

/*
 * Copyright (C) 2023 The ORT Server Authors (See )
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */

package org.eclipse.apoapsis.ortserver.transport.kubernetes.jobmonitor

import org.slf4j.LoggerFactory

/**
 * A class that periodically checks for completed and failed jobs.
 *
 * This class is used to clean up completed jobs and their pods periodically. It also acts as a safety net for
 * [JobMonitor] if this component is temporarily unavailable and thus events regarding failed jobs are missed. Those
 * jobs are eventually picked up by this class, and corresponding notifications are sent.
 */
internal class Reaper(
    /** The object to query and manipulate jobs. */
    private val jobHandler: JobHandler,

    /** The configuration. */
    private val config: MonitorConfig,

    /** The object for time calculations. */
    private val timeHelper: TimeHelper
) {
    companion object {
        private val logger = LoggerFactory.getLogger(Reaper::class.java)
    }

    /**
     * Run reaper jobs periodically according to the configuration using the provided [scheduler].
     */
    fun run(scheduler: Scheduler) {
        scheduler.schedule(config.reaperInterval) { reap() }
    }

    /**
     * Perform a reap run.
     */
    private suspend fun reap() {
        val time = timeHelper.before(config.reaperMaxAge)
        logger.info("Starting a Reaper run. Processing completed jobs before {}.", time)

        val completeJobs = jobHandler.findJobsCompletedBefore(time)

        logger.debug("Found {} completed jobs.", completeJobs.size)

        completeJobs.forEach { jobHandler.deleteAndNotifyIfFailed(it) }
    }
}