Merge pull request #721 from iRevive/sdk-common/resource-detector

sdk-common: add `TelemetryResourceDetector`

Author: iRevive

build.sbt

@@ -1,4 +1,4 @@
-ThisBuild / tlBaseVersion := "0.8"
+ThisBuild / tlBaseVersion := "0.9"
 
 ThisBuild / organization := "org.typelevel"
 ThisBuild / organizationName := "Typelevel"
@@ -221,6 +221,7 @@ lazy val `sdk-common` = crossProject(JVMPlatform, JSPlatform, NativePlatform)
   )
   .settings(munitDependencies)
   .settings(scalafixSettings)
+  .jsSettings(scalaJSLinkerSettings)
 
 lazy val `sdk-metrics` = crossProject(JVMPlatform, JSPlatform, NativePlatform)
   .crossType(CrossType.Pure)
@@ -243,6 +244,7 @@ lazy val `sdk-metrics` = crossProject(JVMPlatform, JSPlatform, NativePlatform)
   )
   .settings(munitDependencies)
   .settings(scalafixSettings)
+  .jsSettings(scalaJSLinkerSettings)
 
 lazy val `sdk-metrics-testkit` =
   crossProject(JVMPlatform, JSPlatform, NativePlatform)
@@ -275,6 +277,7 @@ lazy val `sdk-trace` = crossProject(JVMPlatform, JSPlatform, NativePlatform)
   )
   .settings(munitDependencies)
   .settings(scalafixSettings)
+  .jsSettings(scalaJSLinkerSettings)
 
 lazy val `sdk-trace-testkit` =
   crossProject(JVMPlatform, JSPlatform, NativePlatform)
@@ -313,6 +316,7 @@ lazy val sdk = crossProject(JVMPlatform, JSPlatform, NativePlatform)
   )
   .settings(munitDependencies)
   .settings(scalafixSettings)
+  .jsSettings(scalaJSLinkerSettings)
 
 //
 // SDK exporter

docs/sdk/configuration.md

@@ -50,6 +50,7 @@ If not specified, SDK defaults the service name to `unknown_service:scala`.
 | otel.resource.attributes                 | OTEL\\_RESOURCE\\_ATTRIBUTES                     | Specify resource attributes in the following format: `key1=val1,key2=val2,key3=val3`.                       |
 | otel.service.name                        | OTEL\\_SERVICE\\_NAME                            | Specify logical service name. Takes precedence over `service.name` defined with `otel.resource.attributes`. |
 | otel.experimental.resource.disabled-keys | OTEL\\_EXPERIMENTAL\\_RESOURCE\\_DISABLED\\_KEYS | Specify resource attribute keys that are filtered.                                                          |
+| otel.otel4s.resource.detectors           | OTEL\\_OTEL4S\\_RESOURCE\\_DETECTORS             | Specify resource detectors to use. Defaults to `host`.                                                      | 
 
 ## Metrics
 

sdk/all/src/main/scala/org/typelevel/otel4s/sdk/OpenTelemetrySdk.scala

@@ -43,6 +43,7 @@ import org.typelevel.otel4s.sdk.metrics.autoconfigure.MeterProviderAutoConfigure
 import org.typelevel.otel4s.sdk.metrics.data.ExemplarData
 import org.typelevel.otel4s.sdk.metrics.exemplar.TraceContextLookup
 import org.typelevel.otel4s.sdk.metrics.exporter.MetricExporter
+import org.typelevel.otel4s.sdk.resource.TelemetryResourceDetector
 import org.typelevel.otel4s.sdk.trace.SdkContextKeys
 import org.typelevel.otel4s.sdk.trace.SdkTracerProvider
 import org.typelevel.otel4s.sdk.trace.autoconfigure.ContextPropagatorsAutoConfigure
@@ -191,6 +192,19 @@ object OpenTelemetrySdk {
           customizer: Customizer[TelemetryResource]
       ): Builder[F]
 
+      /** Adds the telemetry resource detector. Multiple detectors can be added,
+        * and the detected telemetry resources will be merged.
+        *
+        * By default, the following detectors are enabled:
+        *   - host: `host.arch`, `host.name`
+        *
+        * @param detector
+        *   the detector to add
+        */
+      def addResourceDetector(
+          detector: TelemetryResourceDetector[F]
+      ): Builder[F]
+
       /** Adds both metric and span exporter configurers. Can be used to
         * register exporters that aren't included in the SDK.
         *
@@ -297,6 +311,7 @@ object OpenTelemetrySdk {
         resourceCustomizer = (a, _) => a,
         meterProviderCustomizer = (a: SdkMeterProvider.Builder[F], _) => a,
         tracerProviderCustomizer = (a: SdkTracerProvider.Builder[F], _) => a,
+        resourceDetectors = Set.empty,
         metricExporterConfigurers = Set.empty,
         spanExporterConfigurers = Set.empty,
         samplerConfigurers = Set.empty,
@@ -312,6 +327,7 @@ object OpenTelemetrySdk {
         resourceCustomizer: Customizer[TelemetryResource],
         meterProviderCustomizer: Customizer[SdkMeterProvider.Builder[F]],
         tracerProviderCustomizer: Customizer[SdkTracerProvider.Builder[F]],
+        resourceDetectors: Set[TelemetryResourceDetector[F]],
         metricExporterConfigurers: Set[
           AutoConfigure.Named[F, MetricExporter[F]]
         ],
@@ -354,6 +370,11 @@ object OpenTelemetrySdk {
           merge(this.tracerProviderCustomizer, customizer)
         )
 
+      def addResourceDetector(
+          detector: TelemetryResourceDetector[F]
+      ): Builder[F] =
+        copy(resourceDetectors = this.resourceDetectors + detector)
+
       def addExportersConfigurer(
           configurer: ExportersAutoConfigure[F]
       ): Builder[F] =
@@ -466,7 +487,7 @@ object OpenTelemetrySdk {
         for {
           config <- Resource.eval(customConfig.fold(loadConfig)(Async[F].pure))
 
-          resource <- TelemetryResourceAutoConfigure[F]
+          resource <- TelemetryResourceAutoConfigure[F](resourceDetectors)
             .configure(config)
             .map(resourceCustomizer(_, config))
 

sdk/all/src/test/scala/org/typelevel/otel4s/sdk/OpenTelemetrySdkSuite.scala

@@ -67,7 +67,11 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
 
   test("withConfig - use the given config") {
     val config = Config.ofProps(
-      Map("otel.traces.exporter" -> "none", "otel.metrics.exporter" -> "none")
+      Map(
+        "otel.otel4s.resource.detectors" -> "none",
+        "otel.traces.exporter" -> "none",
+        "otel.metrics.exporter" -> "none"
+      )
     )
 
     OpenTelemetrySdk
@@ -119,7 +123,11 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
 
   test("addTracerProviderCustomizer - customize tracer provider") {
     val config = Config.ofProps(
-      Map("otel.traces.exporter" -> "none", "otel.metrics.exporter" -> "none")
+      Map(
+        "otel.otel4s.resource.detectors" -> "none",
+        "otel.traces.exporter" -> "none",
+        "otel.metrics.exporter" -> "none"
+      )
     )
 
     val sampler = Sampler.AlwaysOff
@@ -137,7 +145,11 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
 
   test("addResourceCustomizer - customize a resource") {
     val config = Config.ofProps(
-      Map("otel.traces.exporter" -> "none", "otel.metrics.exporter" -> "none")
+      Map(
+        "otel.otel4s.resource.detectors" -> "none",
+        "otel.traces.exporter" -> "none",
+        "otel.metrics.exporter" -> "none"
+      )
     )
 
     val default = TelemetryResource.default
@@ -163,6 +175,7 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
   test("addSpanExporterConfigurer - support external configurers") {
     val config = Config.ofProps(
       Map(
+        "otel.otel4s.resource.detectors" -> "none",
         "otel.traces.exporter" -> "custom-1,custom-2",
         "otel.metrics.exporter" -> "none"
       )
@@ -203,6 +216,7 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
   test("addSamplerConfigurer - support external configurers") {
     val config = Config.ofProps(
       Map(
+        "otel.otel4s.resource.detectors" -> "none",
         "otel.traces.exporter" -> "none",
         "otel.metrics.exporter" -> "none",
         "otel.traces.sampler" -> "custom-sampler",
@@ -237,6 +251,7 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
   test("addTextMapPropagatorConfigurer - support external configurers") {
     val config = Config.ofProps(
       Map(
+        "otel.otel4s.resource.detectors" -> "none",
         "otel.traces.exporter" -> "none",
         "otel.metrics.exporter" -> "none",
         "otel.propagators" -> "tracecontext,custom-1,custom-2,baggage",
@@ -281,6 +296,7 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
   test("addMeterProviderCustomizer - customize meter provider") {
     val config = Config.ofProps(
       Map(
+        "otel.otel4s.resource.detectors" -> "none",
         "otel.traces.exporter" -> "none",
         "otel.metrics.exporter" -> "console"
       )
@@ -314,6 +330,7 @@ class OpenTelemetrySdkSuite extends CatsEffectSuite {
   test("addMeterExporterConfigurer - support external configurers") {
     val config = Config.ofProps(
       Map(
+        "otel.otel4s.resource.detectors" -> "none",
         "otel.traces.exporter" -> "none",
         "otel.metrics.exporter" -> "custom-1,custom-2"
       )

sdk/common/js/src/main/scala/org/typelevel/otel4s/sdk/resource/HostDetectorPlatform.scala

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2023 Typelevel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.typelevel.otel4s.sdk.resource
+
+import cats.effect.Sync
+import org.typelevel.otel4s.Attributes
+import org.typelevel.otel4s.sdk.TelemetryResource
+import org.typelevel.otel4s.semconv.SchemaUrls
+
+private[resource] trait HostDetectorPlatform { self: HostDetector.type =>
+
+  def apply[F[_]: Sync]: TelemetryResourceDetector[F] =
+    new Detector[F]
+
+  private class Detector[F[_]: Sync] extends TelemetryResourceDetector[F] {
+    def name: String = Const.Name
+
+    def detect: F[Option[TelemetryResource]] = Sync[F].delay {
+      val host = Keys.Host(OS.hostname())
+      val arch = Keys.Arch(normalizeArch(OS.arch()))
+
+      Some(TelemetryResource(Attributes(host, arch), Some(SchemaUrls.Current)))
+    }
+  }
+
+  // transforms https://nodejs.org/api/os.html#osarch values to match the spec:
+  // https://opentelemetry.io/docs/specs/semconv/resource/host/
+  private def normalizeArch(arch: String): String =
+    arch match {
+      case "arm" => "arm32"
+      case "ppc" => "ppc32"
+      case "x64" => "amd64"
+      case other => other
+    }
+}

sdk/common/js/src/main/scala/org/typelevel/otel4s/sdk/resource/OS.scala

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2023 Typelevel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.typelevel.otel4s.sdk.resource
+
+import scala.scalajs.js
+import scala.scalajs.js.annotation.JSImport
+
+private object OS {
+
+  @js.native
+  @JSImport("os", "arch")
+  def arch(): String = js.native
+
+  @js.native
+  @JSImport("os", "hostname")
+  def hostname(): String = js.native
+
+}

sdk/common/jvm/src/main/scala/org/typelevel/otel4s/sdk/resource/HostDetectorPlatform.scala

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2023 Typelevel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.typelevel.otel4s.sdk.resource
+
+import cats.effect.Sync
+import cats.syntax.applicativeError._
+import cats.syntax.flatMap._
+import cats.syntax.functor._
+import org.typelevel.otel4s.Attributes
+import org.typelevel.otel4s.sdk.TelemetryResource
+import org.typelevel.otel4s.semconv.SchemaUrls
+
+import java.net.InetAddress
+
+private[resource] trait HostDetectorPlatform { self: HostDetector.type =>
+
+  def apply[F[_]: Sync]: TelemetryResourceDetector[F] =
+    new Detector[F]
+
+  private class Detector[F[_]: Sync] extends TelemetryResourceDetector[F] {
+    def name: String = Const.Name
+
+    def detect: F[Option[TelemetryResource]] =
+      for {
+        hostOpt <- Sync[F]
+          .blocking(InetAddress.getLocalHost.getHostName)
+          .redeem(_ => None, Some(_))
+
+        archOpt <- Sync[F].delay(sys.props.get("os.arch"))
+      } yield {
+        val host = hostOpt.map(Keys.Host(_))
+        val arch = archOpt.map(Keys.Arch(_))
+        val attributes = host.to(Attributes) ++ arch.to(Attributes)
+        Option.when(attributes.nonEmpty)(
+          TelemetryResource(attributes, Some(SchemaUrls.Current))
+        )
+      }
+  }
+
+}

sdk/common/native/src/main/scala/org/typelevel/otel4s/sdk/resource/HostDetectorPlatform.scala

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2023 Typelevel
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.typelevel.otel4s.sdk.resource
+
+import cats.effect.Sync
+import cats.syntax.applicativeError._
+import cats.syntax.flatMap._
+import cats.syntax.functor._
+import org.typelevel.otel4s.Attributes
+import org.typelevel.otel4s.sdk.TelemetryResource
+import org.typelevel.otel4s.semconv.SchemaUrls
+
+import scala.scalanative.posix.unistd._
+import scala.scalanative.unsafe._
+import scala.scalanative.unsigned._
+
+private[resource] trait HostDetectorPlatform { self: HostDetector.type =>
+
+  def apply[F[_]: Sync]: TelemetryResourceDetector[F] =
+    new Detector[F]
+
+  private class Detector[F[_]: Sync] extends TelemetryResourceDetector[F] {
+    def name: String = Const.Name
+
+    def detect: F[Option[TelemetryResource]] =
+      for {
+        hostOpt <- Sync[F].delay(detectHost).handleError(_ => None)
+        archOpt <- Sync[F].delay(sys.props.get("os.arch"))
+      } yield {
+        val host = hostOpt.map(Keys.Host(_))
+        val arch = archOpt.map(Keys.Arch(_))
+        val attributes = host.to(Attributes) ++ arch.to(Attributes)
+        Option.when(attributes.nonEmpty)(
+          TelemetryResource(attributes, Some(SchemaUrls.Current))
+        )
+      }
+
+    private def detectHost: Option[String] =
+      Zone { implicit z =>
+        val size = 256.toUInt
+        val hostnameBuffer = alloc[CChar](size)
+        if (gethostname(hostnameBuffer, size) == 0) {
+          val hostname = fromCString(hostnameBuffer)
+          Some(hostname)
+        } else {
+          None
+        }
+      }
+  }
+
+}