feat: provide abstract telemetry classes (#1078)

Author: ianbotsf

.changes/0523c42d-d3a6-4789-800b-b613e6589170.json

@@ -0,0 +1,5 @@
+{
+    "id": "0523c42d-d3a6-4789-800b-b613e6589170",
+    "type": "feature",
+    "description": "Provide new abstract versions of telemetry classes to simplify the creation of custom telemetry providers"
+}

runtime/observability/telemetry-api/api/telemetry-api.api

@@ -0,0 +1,30 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package aws.smithy.kotlin.runtime.telemetry
+
+import aws.smithy.kotlin.runtime.ExperimentalApi
+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
+
+/**
+ * An abstract implementation of a telemetry provider. By default, this class uses no-op implementations for all members
+ * unless overridden in a subclass.
+ */
+public abstract class AbstractTelemetryProvider : TelemetryProvider {
+    @ExperimentalApi
+    override val meterProvider: MeterProvider = MeterProvider.None
+
+    @ExperimentalApi
+    override val tracerProvider: TracerProvider = TracerProvider.None
+
+    @ExperimentalApi
+    override val loggerProvider: LoggerProvider = LoggerProvider.None
+
+    @ExperimentalApi
+    override val contextManager: ContextManager = ContextManager.None
+}

runtime/observability/telemetry-api/common/src/aws/smithy/kotlin/runtime/telemetry/AbstractTelemetryProvider.kt

@@ -20,7 +20,7 @@ public interface TelemetryProvider {
         /**
          * Default (no-op) telemetry provider
          */
-        public val None: TelemetryProvider = NoOpTelemetryProvider
+        public val None: TelemetryProvider = object : AbstractTelemetryProvider() { }
     }
 
     /**
@@ -47,11 +47,3 @@ public interface TelemetryProvider {
     @ExperimentalApi
     public val contextManager: ContextManager
 }
-
-@OptIn(ExperimentalApi::class)
-private object NoOpTelemetryProvider : TelemetryProvider {
-    override val meterProvider: MeterProvider = MeterProvider.None
-    override val tracerProvider: TracerProvider = TracerProvider.None
-    override val loggerProvider: LoggerProvider = LoggerProvider.None
-    override val contextManager: ContextManager = ContextManager.None
-}

runtime/observability/telemetry-api/common/src/aws/smithy/kotlin/runtime/telemetry/TelemetryProvider.kt

@@ -0,0 +1,13 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.smithy.kotlin.runtime.telemetry.context
+
+/**
+ * An abstract implementation of telemetry provider context. By default, this class uses no-op implementations for all
+ * members unless overridden in a subclass.
+ */
+public abstract class AbstractContext : Context {
+    override fun makeCurrent(): Scope = Scope.None
+}

runtime/observability/telemetry-api/common/src/aws/smithy/kotlin/runtime/telemetry/context/AbstractContext.kt

@@ -0,0 +1,13 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.smithy.kotlin.runtime.telemetry.context
+
+/**
+ * An abstract implementation of a context manager. By default, this class uses no-op implementations for all members
+ * unless overridden in a subclass.
+ */
+public abstract class AbstractContextManager : ContextManager {
+    override fun current(): Context = Context.None
+}

runtime/observability/telemetry-api/common/src/aws/smithy/kotlin/runtime/telemetry/context/AbstractContextManager.kt

@@ -0,0 +1,13 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package aws.smithy.kotlin.runtime.telemetry.context
+
+/**
+ * An abstract implementation of a scope. By default, this class uses no-op implementations for all members unless
+ * overridden in a subclass.
+ */
+public abstract class AbstractScope : Scope {
+    override fun close() { }
+}

runtime/observability/telemetry-api/common/src/aws/smithy/kotlin/runtime/telemetry/context/AbstractScope.kt

@@ -14,7 +14,7 @@ public interface Context {
         /**
          * A no-op [Context]
          */
-        public val None: Context = NoOpContext
+        public val None: Context = object : AbstractContext() { }
     }
 
     /**
@@ -25,11 +25,3 @@ public interface Context {
      */
     public fun makeCurrent(): Scope
 }
-
-private object NoOpContext : Context {
-    override fun makeCurrent(): Scope = NoOpScope
-}
-
-private object NoOpScope : Scope {
-    override fun close() {}
-}

runtime/observability/telemetry-api/common/src/aws/smithy/kotlin/runtime/telemetry/context/Context.kt

@@ -11,15 +11,14 @@ package aws.smithy.kotlin.runtime.telemetry.context
  */
 public interface ContextManager {
     public companion object {
-        public val None: ContextManager = NoOpContextManager
+        /**
+         * A [ContextManager] that does nothing
+         */
+        public val None: ContextManager = object : AbstractContextManager() { }
     }
 
     /**
      * Return the current [Context]
      */
     public fun current(): Context
 }
-
-private object NoOpContextManager : ContextManager {
-    override fun current(): Context = Context.None
-}

runtime/observability/telemetry-api/common/src/aws/smithy/kotlin/runtime/telemetry/context/ContextManager.kt

@@ -10,4 +10,11 @@ import aws.smithy.kotlin.runtime.io.Closeable
 /**
  * Delineates a logical scope that has a beginning and end (e.g. a function)
  */
-public interface Scope : Closeable
+public interface Scope : Closeable {
+    public companion object {
+        /**
+         * A [Scope] that does nothing
+         */
+        public val None: Scope = object : AbstractScope() { }
+    }
+}