Additions For Db Scheduler

This project aims to add support for additional databases and a Ktor UI plugin for the Db Scheduler project. If you find any bug please report it.

UI Ktor Plugin

This package uses db-scheduler-ui and provides a ktor plugin to interact with.

implementation("io.github.osoykan:db-scheduler-ui-ktor:$version")

install(DbSchedulerUI) {
  routePath = "/db-scheduler"
  scheduler = { get<Scheduler>() } // assuming Koin is in place, but you can provide your instance to the functions.
  enabled = true
  taskData = true
}

Execution History

The UI plugin supports tracking task execution history. To enable it, create the configuration first and share the listener with your scheduler:

// 1. Create UI config before scheduler initialization
val uiConfig = DbSchedulerUIConfiguration().apply {
  routePath = "/db-scheduler"
  enabled = true
  historyEnabled = true      // Enable history tracking
  historyMaxSize = 10_000    // Max entries to keep in memory (default: 10000)
}

// 2. Add the listener to your scheduler
Scheduler.create(dataSource, tasks)
  .addSchedulerListener(uiConfig.createListener())  // Creates ExecutionLogListener
  .build()

// Or if using the DSL:
scheduler {
  listeners(uiConfig.createListener())
  // ... other config
}

// 3. Install plugin with the same config
install(DbSchedulerUI) {
  from(uiConfig)  // Shares the same logRepository
  scheduler = { get<Scheduler>() }
}

With Koin DI:

val uiConfig = DbSchedulerUIConfiguration().apply {
  historyEnabled = true
}

install(Koin) {
  modules(
    module {
      // Register listener for scheduler to use
      single { uiConfig.createListener() }
    }
  )
}

install(DbSchedulerUI) {
  from(uiConfig)
  scheduler = { get() }
}

Mongo

implementation("io.github.osoykan:db-scheduler-mongo:$version")

scheduler {
  val mongo = Mongo(client, "database-name", "collection-name")
  mongo.ensureCollectionExists()

  database(mongo)
  knownTasks(*tasks.toTypedArray())
  startupTasks(*startupTasks.toTypedArray())
  name(name)
  clock(clock)
  shutdownMaxWait(1.seconds)
  fixedThreadPoolSize(5)
  corePoolSize(1)
  heartbeatInterval(2.seconds)
  executeDue(2.seconds)
  deleteUnresolvedAfter(1.seconds)
  logLevel(LogLevel.TRACE)
  logStackTrace(true)
  shutdownMaxWait(1.minutes)
  numberOfMissedHeartbeatsBeforeDead(3)
  listeners(emptyList())
  meterRegistry(PrometheusMeterRegistry(PrometheusConfig.DEFAULT))
}.also {
  it.start()
}

implementation("io.github.osoykan:db-scheduler-couchbase:$version")

scheduler {
  val couchbase = Couchbase(cluster, "bucket-name", "collection-name")
  couchbase.ensureCollectionExists()

  database(couchbase)
  knownTasks(*tasks.toTypedArray())
  startupTasks(*startupTasks.toTypedArray())
  name(name)
  clock(clock)
  shutdownMaxWait(1.seconds)
  fixedThreadPoolSize(5)
  corePoolSize(1)
  heartbeatInterval(2.seconds)
  executeDue(2.seconds)
  deleteUnresolvedAfter(1.seconds)
  logLevel(LogLevel.TRACE)
  logStackTrace(true)
  shutdownMaxWait(1.minutes)
  numberOfMissedHeartbeatsBeforeDead(3)
  listeners(emptyList())
  meterRegistry(PrometheusMeterRegistry(PrometheusConfig.DEFAULT))
}.also {
  it.start()
}