service-utils/com.pambrose.common.service/GenericKtorService

GenericKtorService

abstract class GenericKtorService<T> : GenericExecutionThreadService, Closeable

Abstract base class for services that use an embedded Ktor CIO server for admin servlet hosting.

Provides integrated support for:

Admin endpoints: ping, version, health check, and thread dump servlets via KtorServletService
Prometheus metrics: JVM and application metrics exported via MetricsService
Zipkin tracing: distributed trace reporting via ZipkinReporterService
Health checks: Dropwizard health check registry with thread deadlock and service state monitoring
Service lifecycle: coordinated startup/shutdown of all sub-services via a Guava ServiceManager

Subclasses should call initKtorServletService during initialization to set up the service infrastructure.

Parameters

configVals

The application-specific configuration values.

adminConfig

Configuration for admin endpoints.

metricsConfig

Configuration for Prometheus metrics.

zipkinConfig

Configuration for Zipkin tracing.

versionBlock

A lambda returning the application version string for the version endpoint.

isTestMode

Whether the service is running in test mode.

Type Parameters

T

The type of the configuration values object.

Types

object Companion

Properties

val configVals: T

val isAdminEnabled: Boolean

Whether admin endpoints are enabled, based on AdminConfig.enabled.

isMetricsEnabled

val isMetricsEnabled: Boolean

Whether Prometheus metrics collection is enabled, based on MetricsConfig.enabled.

val isRunning: Boolean

val isTestMode: Boolean

isZipkinEnabled

val isZipkinEnabled: Boolean

Whether Zipkin distributed tracing is enabled, based on ZipkinConfig.enabled.

lateinit var jmxReporter: JmxReporter

The JMX reporter for Dropwizard metrics. Initialized when metrics are enabled.

lateinit var metricsService: MetricsService

The Prometheus metrics service. Initialized when metrics are enabled.

lateinit var servletService: KtorServletService

The Ktor-based servlet service hosting admin endpoints. Initialized when admin is enabled.

val upTime: Duration

The elapsed time since the service was created.

zipkinReporterService

lateinit var zipkinReporterService: ZipkinReporterService

The Zipkin span reporter service. Initialized when Zipkin tracing is enabled.

Functions

fun addListener(listener: Service.Listener?, executor: Executor?)

fun awaitRunning()

fun awaitRunning(timeout: Duration?)

fun awaitRunning(timeout: Long, unit: TimeUnit?)

awaitTerminated

fun awaitTerminated()

fun awaitTerminated(timeout: Duration?)

fun awaitTerminated(timeout: Long, unit: TimeUnit?)

open override fun close()

fun failureCause(): Throwable?

initKtorServletService

fun initKtorServletService(initKtor: Application.() -> Unit = {}, servletInit: HttpServletGroup.() -> Unit = {})

Initializes the Ktor servlet service, metrics, Zipkin tracing, and health checks.

@CanIgnoreReturnValue

fun startAsync(): Service?

fun startSync(timeout: Duration)

fun state(): Service.State?

@CanIgnoreReturnValue

fun stopAsync(): Service?

fun stopSync(timeout: Duration)