micrometer-metrics/micrometer

Timer API does not support Kotlin suspend function (coroutines)

Open

#4 455 ouverte le 7 déc. 2023

Voir sur GitHub
 (4 commentaires) (6 réactions) (0 assignés)Java (4 220 stars) (935 forks)batch import
enhancementhelp wantedkotlin

Description

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.

Guide contributeur

Stack technique
kotlinjava
Domaine
observabilityperformance
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Kotlin suspend functionsMicrometer Timer API
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.