feat(observability): micrometer telemetry provider #1089
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| public final class aws/smithy/kotlin/runtime/telemetry/micrometer/MicrometerTelemetryProvider : aws/smithy/kotlin/runtime/telemetry/TelemetryProvider { | ||
| public fun <init> (Lio/micrometer/core/instrument/MeterRegistry;Laws/smithy/kotlin/runtime/telemetry/logging/LoggerProvider;)V | ||
| public synthetic fun <init> (Lio/micrometer/core/instrument/MeterRegistry;Laws/smithy/kotlin/runtime/telemetry/logging/LoggerProvider;ILkotlin/jvm/internal/DefaultConstructorMarker;)V | ||
| public fun getContextManager ()Laws/smithy/kotlin/runtime/telemetry/context/ContextManager; | ||
| public fun getLoggerProvider ()Laws/smithy/kotlin/runtime/telemetry/logging/LoggerProvider; | ||
| public fun getMeterProvider ()Laws/smithy/kotlin/runtime/telemetry/metrics/MeterProvider; | ||
| public fun getTracerProvider ()Laws/smithy/kotlin/runtime/telemetry/trace/TracerProvider; | ||
| } | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| description = "Telemetry provider based on MicroMeter" | ||
monosoul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| extra["displayName"] = "Smithy :: Kotlin :: Observability :: MicroMeter Provider" | ||
| extra["moduleName"] = "aws.smithy.kotlin.runtime.telemetry.micrometer" | ||
|
|
||
| kotlin { | ||
| sourceSets { | ||
| commonMain { | ||
| dependencies { | ||
| api(project(":runtime:observability:telemetry-api")) | ||
| implementation(project(":runtime:observability:telemetry-defaults")) | ||
| } | ||
| } | ||
|
|
||
| jvmMain { | ||
| dependencies { | ||
| api(libs.micrometer.core) | ||
| } | ||
| } | ||
| all { | ||
| languageSettings.optIn("aws.smithy.kotlin.runtime.InternalApi") | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| package aws.smithy.kotlin.runtime.telemetry.micrometer | ||
monosoul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import aws.smithy.kotlin.runtime.collections.AttributeKey | ||
| import aws.smithy.kotlin.runtime.collections.Attributes | ||
| import aws.smithy.kotlin.runtime.telemetry.context.Context | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.AsyncMeasurementHandle | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.DoubleAsyncMeasurement | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.DoubleGaugeCallback | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.DoubleHistogram | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.LongAsyncMeasurement | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.LongGaugeCallback | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.LongHistogram | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.LongUpDownCounterCallback | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.Meter | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.MeterProvider | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.MonotonicCounter | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.UpDownCounter | ||
| import io.micrometer.core.instrument.DistributionSummary | ||
| import io.micrometer.core.instrument.MeterRegistry | ||
| import io.micrometer.core.instrument.Tag | ||
| import io.micrometer.core.instrument.Tags | ||
| import io.micrometer.core.instrument.Counter as MicrometerCounter | ||
| import io.micrometer.core.instrument.Gauge as MicrometerGauge | ||
|
|
||
| internal class MicrometerMeterProvider(meterRegistry: MeterRegistry) : MeterProvider { | ||
| private val meter = MicrometerMeter(meterRegistry) | ||
|
|
||
| override fun getOrCreateMeter(scope: String): Meter = meter | ||
|
There was a problem hiding this comment. Question: The |
||
| } | ||
|
|
||
| private class MicrometerMeter( | ||
| private val meterRegistry: MeterRegistry, | ||
| ) : Meter { | ||
| override fun createUpDownCounter(name: String, units: String?, description: String?): UpDownCounter = | ||
| MicrometerUpDownCounter( | ||
| meterMetadata = MeterMetadata(name, units, description), | ||
| meterRegistry = meterRegistry, | ||
| ) | ||
|
|
||
| override fun createAsyncUpDownCounter( | ||
| name: String, | ||
| callback: LongUpDownCounterCallback, | ||
| units: String?, | ||
| description: String?, | ||
| ): AsyncMeasurementHandle = | ||
| MicrometerLongGauge( | ||
| callback = callback, | ||
| meterMetadata = MeterMetadata(name, units, description), | ||
| meterRegistry = meterRegistry, | ||
| ) | ||
|
|
||
| override fun createMonotonicCounter(name: String, units: String?, description: String?): MonotonicCounter = | ||
| MicrometerMonotonicCounter( | ||
| meterMetadata = MeterMetadata(name, units, description), | ||
| meterRegistry = meterRegistry, | ||
| ) | ||
|
|
||
| override fun createLongHistogram(name: String, units: String?, description: String?): LongHistogram = | ||
| MicrometerLongHistogram( | ||
| MicrometerDoubleHistogram( | ||
| meterMetadata = MeterMetadata(name, units, description), | ||
| meterRegistry = meterRegistry, | ||
| ) | ||
| ) | ||
|
|
||
| override fun createDoubleHistogram(name: String, units: String?, description: String?): DoubleHistogram = | ||
| MicrometerDoubleHistogram( | ||
| meterMetadata = MeterMetadata(name, units, description), | ||
| meterRegistry = meterRegistry, | ||
| ) | ||
|
|
||
| override fun createLongGauge( | ||
| name: String, | ||
| callback: LongGaugeCallback, | ||
| units: String?, | ||
| description: String?, | ||
| ): AsyncMeasurementHandle = MicrometerLongGauge( | ||
| callback = callback, | ||
| meterMetadata = MeterMetadata(name, units, description), | ||
| meterRegistry = meterRegistry, | ||
| ) | ||
|
|
||
| override fun createDoubleGauge( | ||
| name: String, | ||
| callback: DoubleGaugeCallback, | ||
| units: String?, | ||
| description: String?, | ||
| ): AsyncMeasurementHandle = MicrometerDoubleGauge( | ||
| callback = callback, | ||
| meterMetadata = MeterMetadata(name, units, description), | ||
| meterRegistry = meterRegistry, | ||
| ) | ||
|
|
||
| } | ||
|
|
||
| private data class MeterMetadata(val meterName: String, val units: String?, val description: String?) | ||
|
|
||
| private class MicrometerUpDownCounter( | ||
| private val meterMetadata: MeterMetadata, | ||
| private val meterRegistry: MeterRegistry, | ||
| ) : UpDownCounter { | ||
| override fun add(value: Long, attributes: Attributes, context: Context?) { | ||
| meterMetadata | ||
| .counter() | ||
| .tags(attributes.toTags()) | ||
| .register(meterRegistry) | ||
monosoul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .increment(value.toDouble()) | ||
| } | ||
| } | ||
|
Comment on lines
+106
to
+117
There was a problem hiding this comment. Correctness: The There was a problem hiding this comment. It would work fine, you can use this snippet to check it yourself with a Kotlin scratch file in IntelliJ: import io.micrometer.core.instrument.simple.SimpleMeterRegistry
val registry = SimpleMeterRegistry()
val counter = registry.counter("test.counter")
counter.increment(3.0)
println(counter.count())
counter.increment(-2.0)
println(counter.count())
Will produce: |
||
|
|
||
| private class MicrometerMonotonicCounter( | ||
| private val meterMetadata: MeterMetadata, | ||
| private val meterRegistry: MeterRegistry, | ||
| ) : MonotonicCounter { | ||
| override fun add(value: Long, attributes: Attributes, context: Context?) { | ||
| meterMetadata | ||
| .counter() | ||
| .tags(attributes.toTags()) | ||
| .register(meterRegistry) | ||
| .increment(value.toDouble()) | ||
| } | ||
| } | ||
|
|
||
| private class MicrometerDoubleHistogram( | ||
| private val meterMetadata: MeterMetadata, | ||
| private val meterRegistry: MeterRegistry, | ||
| ) : DoubleHistogram { | ||
| override fun record(value: Double, attributes: Attributes, context: Context?) { | ||
| DistributionSummary.builder(meterMetadata.meterName) | ||
| .baseUnit(meterMetadata.units) | ||
| .description(meterMetadata.description) | ||
| .tags(attributes.toTags()) | ||
| .publishPercentileHistogram() | ||
| .register(meterRegistry) | ||
| } | ||
| } | ||
|
|
||
| private class MicrometerLongHistogram( | ||
| private val doubleHistogram: MicrometerDoubleHistogram, | ||
| ) : LongHistogram { | ||
| override fun record(value: Long, attributes: Attributes, context: Context?) { | ||
| doubleHistogram.record(value.toDouble(), attributes, context) | ||
| } | ||
| } | ||
monosoul marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private class MicrometerGaugeDoubleAsyncMeasurement : DoubleAsyncMeasurement { | ||
| private var _value: Double? = null | ||
| private var _tags: Tags? = null | ||
| val value: Double get() = checkNotNull(_value) { "The value has not yet been measured" } | ||
| val tags: Tags get() = checkNotNull(_tags) { "The value has not yet been measured" } | ||
|
|
||
| override fun record(value: Double, attributes: Attributes, context: Context?) { | ||
| _value = value | ||
| _tags = attributes.toTags() | ||
| } | ||
| } | ||
|
|
||
| private class MicrometerDoubleGauge( | ||
| private val meterMetadata: MeterMetadata, | ||
| private val meterRegistry: MeterRegistry, | ||
| private val callback: DoubleGaugeCallback, | ||
| ) : AsyncMeasurementHandle { | ||
|
|
||
| private val gauge = MicrometerGaugeDoubleAsyncMeasurement() | ||
| .apply(callback) | ||
| .let { measurement -> | ||
| MicrometerGauge | ||
| .builder(meterMetadata.meterName) { measurement.apply(callback).value } | ||
| .baseUnit(meterMetadata.units) | ||
| .description(meterMetadata.description) | ||
| .tags(measurement.tags) | ||
| .strongReference(true) | ||
| .register(meterRegistry) | ||
| } | ||
|
|
||
| override fun stop() { | ||
| gauge.close() | ||
| meterRegistry.remove(gauge) | ||
| } | ||
| } | ||
|
|
||
| private class MicrometerGaugeLongAsyncMeasurement( | ||
| private val doubleAsyncMeasurement: DoubleAsyncMeasurement, | ||
| ) : LongAsyncMeasurement { | ||
| override fun record(value: Long, attributes: Attributes, context: Context?) { | ||
| doubleAsyncMeasurement.record(value.toDouble(), attributes, context) | ||
| } | ||
| } | ||
|
|
||
| private class MicrometerLongGauge( | ||
| private val callback: LongGaugeCallback, | ||
| meterMetadata: MeterMetadata, | ||
| meterRegistry: MeterRegistry, | ||
| ) : AsyncMeasurementHandle { | ||
|
|
||
| private val gauge = MicrometerDoubleGauge(meterMetadata, meterRegistry) { | ||
| callback.invoke(MicrometerGaugeLongAsyncMeasurement(it)) | ||
| } | ||
|
|
||
| override fun stop() = gauge.stop() | ||
| } | ||
|
|
||
| private fun MeterMetadata.counter() = MicrometerCounter.builder(meterName) | ||
| .baseUnit(units) | ||
| .description(description) | ||
|
|
||
| @Suppress("UNCHECKED_CAST") | ||
| private fun Attributes.toTags() = keys.mapNotNull { | ||
| val attributeKey = it as? AttributeKey<Any> ?: return@mapNotNull null | ||
| Tag.of(attributeKey.name, getOrNull(attributeKey).toString()) | ||
| }.let(Tags::of) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package aws.smithy.kotlin.runtime.telemetry.micrometer | ||
|
|
||
| import aws.smithy.kotlin.runtime.ExperimentalApi | ||
| import aws.smithy.kotlin.runtime.telemetry.GlobalTelemetryProvider | ||
| import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider | ||
| import aws.smithy.kotlin.runtime.telemetry.context.ContextManager | ||
| import aws.smithy.kotlin.runtime.telemetry.logging.LoggerProvider | ||
| import aws.smithy.kotlin.runtime.telemetry.metrics.MeterProvider | ||
| import aws.smithy.kotlin.runtime.telemetry.trace.TracerProvider | ||
| import io.micrometer.core.instrument.MeterRegistry | ||
|
|
||
| @ExperimentalApi | ||
| public class MicrometerTelemetryProvider( | ||
| meterRegistry: MeterRegistry, | ||
|
There was a problem hiding this comment. Question: Would it make sense for |
||
| override val loggerProvider: LoggerProvider = GlobalTelemetryProvider.instance.loggerProvider, | ||
| ) : TelemetryProvider { | ||
| override val meterProvider: MeterProvider = MicrometerMeterProvider(meterRegistry) | ||
| override val tracerProvider: TracerProvider = TracerProvider.None | ||
| override val contextManager: ContextManager = ContextManager.None | ||
| } | ||
|
There was a problem hiding this comment. Looks like Micrometer supports more than just metrics, it also supports tracing (either directly or via bridges to other providers like OTel and Brave) and context propagation—which seem like natural fits for new There was a problem hiding this comment. At my org we use another tool for tracing, so atm I'm only interested in metrics |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.