com.sksamuel.cohort.lettuce.RedisHealthCheck.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cohort-lettuce Show documentation

Ktor Actuator

There is a newer version: 2.6.0

package com.sksamuel.cohort.lettuce

import com.sksamuel.cohort.HealthCheck
import com.sksamuel.cohort.HealthCheckResult
import io.lettuce.core.api.StatefulRedisConnection
import kotlinx.coroutines.future.await
import kotlin.random.Random

/**
 * A Cohort [HealthCheck] that checks that a connection can be made to a redis standalone
 * instance using the supplied lettuce connection.
 *
 * @param command a command to execute against the redis instance.
 *                Defaults to retrieving a random key, which may or may not exist.
 */
class RedisHealthCheck(
   private val conn: StatefulRedisConnection,
   override val name: String = "redis",
   private val command: suspend (StatefulRedisConnection) -> Unit,
) : HealthCheck {

   companion object {

      /**
       * Uses the supplied [conn] to retrieve a key from Redis, with the key generated by the [genkey] function.
       */
      operator fun  invoke(conn: StatefulRedisConnection, genkey: () -> K): RedisHealthCheck {
         return RedisHealthCheck(conn) { it.async().get(genkey()).await() }
      }

      /**
       * Uses the supplied [conn] to retrieve a key from Redis, with the key randomly generated.
       */
      operator fun invoke(conn: StatefulRedisConnection): RedisHealthCheck {
         return RedisHealthCheck(conn) { it.async().get(Random.nextInt().toString()).await() }
      }
   }

   override suspend fun check(): HealthCheckResult {
      return runCatching {
         command(conn)
         HealthCheckResult.healthy("Redis command successful")
      }.getOrElse { HealthCheckResult.unhealthy("Redis command failure", it) }
   }
}