micrometer-metrics/micrometer

Timer API does not support Kotlin suspend function (coroutines)

Open

#4.455 geöffnet am 7. Dez. 2023

Auf GitHub ansehen
 (4 Kommentare) (6 Reaktionen) (0 zugewiesene Personen)Java (4.220 Stars) (935 Forks)batch import
enhancementhelp wantedkotlin

Beschreibung

Please describe the feature request.

For standard (non suspend functions) it is possible to use record function to measure method invocation time:

Timer.builder("method.timed")
            .register(meterRegistry)
            .record { fn() } // fn() is a standard, non suspend function

However, it is not possible to call a suspend function from within record block:

Timer.builder("method.timed")
            .register(meterRegistry)
            .record { suspendFn() } // Suspension functions can be called only within coroutine body

The support for suspend functions should be added to the library.

Rationale Suspend functions are popular for non-blocking API, and it is currently not possible to measure time needed to call suspend functions without having a custom function to record the time.

Additional context Maybe this could be added as a extension function to the Timer interface.

Contributor Guide

Tech Stack
kotlinjava
Domain
observabilityperformance
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Kotlin suspend functionsMicrometer Timer API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
Review the existing Timer.record function for non suspend functions to understand the pattern. Add a new suspend extension function for Timer that accepts a suspending lambda. Check the micrometer source for existing coroutine support patterns (e.g., in reactor or kotlinx coroutines). Consider adding the function in a Kotlin specific module if available. Consult comments on the issue for any maintainer guidance.