Merge pull request #532 from iRevive/sdk/resource-configurer-default

sdk: use `TelemetryResource.default` as an initial resource
typelevel · Mar 9, 2024 · 317f8ab · 317f8ab
2 parents fc67046 + d9ae870
commit 317f8ab
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 21 deletions.
diff --git a/sdk/all/src/main/scala/org/typelevel/otel4s/sdk/OpenTelemetrySdk.scala b/sdk/all/src/main/scala/org/typelevel/otel4s/sdk/OpenTelemetrySdk.scala
@@ -300,20 +300,22 @@ object OpenTelemetrySdk {
             cfg.withOverrides(c(cfg))
           )
 
-        def loadNoop: Resource[F, OpenTelemetrySdk[F]] =
+        def loadNoop(config: Config): Resource[F, AutoConfigured[F]] =
           Resource.eval(
             for {
               _ <- Console[F].println(
                 s"OpenTelemetrySdk: the '${CommonConfigKeys.SdkDisabled}' set to 'true'. Using no-op implementation"
               )
               local <- LocalProvider[F, Context].local
-            } yield OpenTelemetrySdk.noop[F](Async[F], local)
+              sdk = OpenTelemetrySdk.noop[F](Async[F], local)
+              resource = TelemetryResource.empty
+            } yield Impl(sdk, resource, config)
           )
 
         def loadSdk(
             config: Config,
             resource: TelemetryResource
-        ): Resource[F, OpenTelemetrySdk[F]] = {
+        ): Resource[F, AutoConfigured[F]] = {
           def makeLocalContext = LocalProvider[F, Context].local
 
           Resource.eval(makeLocalContext).flatMap { implicit local =>
@@ -333,11 +335,12 @@ object OpenTelemetrySdk {
 
                 for {
                   tracerProvider <- tracerProviderConfigure.configure(config)
-                } yield new OpenTelemetrySdk(
-                  MeterProvider.noop,
-                  tracerProvider,
-                  propagators
-                )
+                  sdk = new OpenTelemetrySdk(
+                    MeterProvider.noop,
+                    tracerProvider,
+                    propagators
+                  )
+                } yield Impl(sdk, resource, config)
               }
             }
           }
@@ -356,8 +359,8 @@ object OpenTelemetrySdk {
             )
           )
 
-          sdk <- if (isDisabled) loadNoop else loadSdk(config, resource)
-        } yield Impl[F](sdk, resource, config)
+          sdk <- if (isDisabled) loadNoop(config) else loadSdk(config, resource)
+        } yield sdk
       }
 
       private def merge[A](

diff --git a/sdk/all/src/test/scala/org/typelevel/otel4s/sdk/OpenTelemetrySdkSuite.scala b/sdk/all/src/test/scala/org/typelevel/otel4s/sdk/OpenTelemetrySdkSuite.scala
@@ -47,7 +47,7 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
 
   private val DefaultSdk =
     sdkToString(
-      TelemetryResource.empty,
+      TelemetryResource.default,
       Sampler.parentBased(Sampler.AlwaysOn)
     )
 
@@ -261,7 +261,7 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
   }
 
   private def sdkToString(
-      resource: TelemetryResource = TelemetryResource.empty,
+      resource: TelemetryResource = TelemetryResource.default,
       sampler: Sampler = Sampler.parentBased(Sampler.AlwaysOn),
       propagators: ContextPropagators[Context] = ContextPropagators.of(
         W3CTraceContextPropagator.default,

diff --git a/...rc/main/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigure.scala b/...rc/main/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigure.scala
@@ -64,6 +64,7 @@ private final class TelemetryResourceAutoConfigure[F[_]: MonadThrow]
               ConfigurationError("Unable to decode resource attributes", e)
             }
         }
+        .map(_.to(Attributes))
 
     val attempt = for {
       disabledKeys <-
@@ -80,9 +81,10 @@ private final class TelemetryResourceAutoConfigure[F[_]: MonadThrow]
         .flatten
         .map(value => ResourceAttributes.ServiceName(value))
 
-      TelemetryResource(
-        Attributes.fromSpecific(attributes ++ serviceName.toSeq)
-      )
+      val default = TelemetryResource.default
+      val fromEnv = TelemetryResource(attributes ++ serviceName)
+
+      default.mergeUnsafe(fromEnv)
     }
 
     Resource.eval(MonadThrow[F].fromEither(attempt))

diff --git a/...st/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigureSuite.scala b/...st/scala/org/typelevel/otel4s/sdk/autoconfigure/TelemetryResourceAutoConfigureSuite.scala
@@ -23,14 +23,14 @@ import munit.CatsEffectSuite
 
 class TelemetryResourceAutoConfigureSuite extends CatsEffectSuite {
 
-  test("load from an empty config") {
+  test("load from an empty config - use default as a fallback") {
     val config = Config(Map.empty, Map.empty, Map.empty)
     TelemetryResourceAutoConfigure[IO].configure(config).use { resource =>
-      IO(assertEquals(resource, TelemetryResource.empty))
+      IO(assertEquals(resource, TelemetryResource.default))
     }
   }
 
-  test("load from the config") {
+  test("load from the config - use default as an initial resource") {
     val props = Map(
       "otel.service.name" -> "some-service",
       "otel.resource.attributes" -> "key1=val1,key2=val2,key3=val3",
@@ -44,8 +44,12 @@ class TelemetryResourceAutoConfigureSuite extends CatsEffectSuite {
       Attribute("service.name", "some-service")
     )
 
+    val expected = TelemetryResource.default.mergeUnsafe(
+      TelemetryResource(expectedAttributes)
+    )
+
     TelemetryResourceAutoConfigure[IO].configure(config).use { resource =>
-      IO(assertEquals(resource, TelemetryResource(expectedAttributes)))
+      IO(assertEquals(resource, expected))
     }
   }
 }
diff --git a/sdk/trace/src/test/scala/org/typelevel/otel4s/sdk/trace/SdkTracesSuite.scala b/sdk/trace/src/test/scala/org/typelevel/otel4s/sdk/trace/SdkTracesSuite.scala
@@ -47,7 +47,7 @@ class SdkTracesSuite extends CatsEffectSuite {
 
   private val DefaultTraces =
     tracesToString(
-      TelemetryResource.empty,
+      TelemetryResource.default,
       Sampler.parentBased(Sampler.AlwaysOn)
     )
 
@@ -258,7 +258,7 @@ class SdkTracesSuite extends CatsEffectSuite {
   }
 
   private def tracesToString(
-      resource: TelemetryResource = TelemetryResource.empty,
+      resource: TelemetryResource = TelemetryResource.default,
       sampler: Sampler = Sampler.parentBased(Sampler.AlwaysOn),
       propagators: ContextPropagators[Context] = ContextPropagators.of(
         W3CTraceContextPropagator.default,