prometheus-kt

0.3.3indexed

Client library enables creating and exposing custom metrics with typed labels and a domain-specific language, offering coroutine-friendly and Ktor support for seamless integration.

JSJVMNative·anti-social/prometheus-kt

Stars

—

Used by

dependents

—

Health

/ 100

Prometheus-kt

Prometheus client for Kotlin

Motivation

Kotlin multiplatform support
Coroutines friendly (does not use synchronized at all)
Typed labels
Nice DSL
Ktor support out of the box

At the moment official prometheus java client has a bit more performance.

Versions

See Kotlin release details for kotlinx library versions compatibility.

How to use?

Add it into your build script:

build.gradle.kts:

repositories {
    mavenCentral()
}

dependencies {
    implementation("dev.evo.prometheus", "prometheus-kt-ktor", "0.2.3")
}

build.gradle:

repositories {
    mavenCentral()
}

dependencies {
    implementation "dev.evo.prometheus:prometheus-kt-ktor:0.2.3"
}

Create your own metrics:

import dev.evo.prometheus.LabelSet
import dev.evo.prometheus.PrometheusMetrics
import dev.evo.prometheus.jvm.DefaultJvmMetrics

class ProcessingLabels : LabelSet() {
    var source by label()
}

object AppMetrics : PrometheusMetrics() {
    val processedProducts by histogram("processed_products", logScale(0, )) {
        ProcessingLabels()
    }
     jvm  submetrics(DefaultJvmMetrics())
}

Use them in your application:

import kotlinx.coroutines.delay

suspend fun startProcessing() {
    while (true) {
        AppMetrics.processedProducts.measureTime({
            source = "manual"
        }) {
            // Processing
            delay(100)
        }
    }
}

Then expose them:

import dev.evo.prometheus.ktor.metricsModule

import io.ktor.server.engine.embeddedServer
import io.ktor.server.netty.Netty

suspend fun main(args: Array<String>) {
    val metricsApp = embeddedServer(
        Netty,
        port = 9090,
        module = {
            metricsModule(AppMetrics)
        }
    )
            .start(wait = false)
    
    
    startProcessing()
    
    metricsApp.stop(, )
}

And finally watch them:

curl -X GET 'localhost:9090/metrics'

More samples at: https://github.com/anti-social/prometheus-kt/tree/master/samples

Just run them:

./gradlew --project-dir samples/processing-app run

./gradlew --project-dir samples/http-app run

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

nats.kt★ 51

n-hassHigh-performance NATS client enables messaging support across platforms with features like TCP and WebSocket transport, coroutine-based reactive programming, and a clean API for versatile application deployment.Shared: ktor, kotlin-coroutines, client

klibnotion★ 58

BoDClient library for interacting with the Notion API, offering coroutine-based, blocking, and future-based flavors. Facilitates OAuth support, pagination, content creation with DSL, and configurable logging/proxy settings.Shared: kotlin-coroutines, dsl, client

openapi-kmp-gen★ 15

kroegeramaGenerates API clients and models from OpenAPI specs for multiple targets, offering coroutine-based HTTP calls, JSON/date serialization, security support, named primitives, decorators and tag filtering.Shared: ktor, kotlin-coroutines, client

kstatemachine★ 504

KStateMachineDSL library for creating state machines and statecharts. Supports event-based transitions, reactive listening, nested and parallel states, typesafe transitions, undo transitions, and exports to diagrams. Zero dependencies.Shared: kotlin-coroutines, dsl

KtorMonitor★ 220

CosminMihuMDCMonitors network requests and responses, enhancing debugging and analysis of client-server interactions. Features include header sanitization, log retention, and content length management with platform-specific integrations.Shared: ktor, client

GRPC-Kotlin-Multiplatform★ 133

TimOrtelImplements client-side gRPC with support for parsing proto3 files, generating corresponding code, and suspending RPC calls. Features a DSL for creating proto objects and supports various proto types.Shared: kotlin-coroutines, client

0.1.1	1.4.30
0.1.2	1.5.21
0.1.3	1.5.31
0.2.0	1.7.20
0.2.1	1.7.22
0.2.2	1.7.22
0.2.3	1.7.22