add ListValue to TraceValue ADT

bpholt · bpholt · commit 4af5f93d4758 · 2025-11-26T14:52:08.000-05:00
diff --git a/modules/core/shared/src/main/scala/TraceValue.scala b/modules/core/shared/src/main/scala/TraceValue.scala
@@ -4,6 +4,9 @@
 
 package natchez
 
+import cats.*
+import cats.syntax.all.*
+
 sealed trait TraceValue extends Product with Serializable {
   def value: Any
 }
@@ -13,6 +16,7 @@ object TraceValue {
   case class StringValue(value: String) extends TraceValue
   case class BooleanValue(value: Boolean) extends TraceValue
   case class NumberValue(value: Number) extends TraceValue
+  case class ListValue(value: List[TraceValue]) extends TraceValue
 
   implicit def viaTraceableValue[A: TraceableValue](a: A): TraceValue =
     TraceableValue[A].toTraceValue(a)
@@ -57,4 +61,7 @@ object TraceableValue {
   implicit val longToTraceValue: TraceableValue[Long] = TraceValue.NumberValue(_)
   implicit val doubleToTraceValue: TraceableValue[Double] = TraceValue.NumberValue(_)
   implicit val floatToTraceValue: TraceableValue[Float] = TraceValue.NumberValue(_)
+
+  implicit def foldableToTraceValue[F[_]: Foldable, A: TraceableValue]: TraceableValue[F[A]] =
+    fa => TraceValue.ListValue(fa.toList.map(TraceableValue[A].toTraceValue))
 }
diff --git a/modules/datadog/src/main/scala/DDSpan.scala b/modules/datadog/src/main/scala/DDSpan.scala
@@ -13,7 +13,7 @@ import cats.syntax.all._
 import io.opentracing.log.Fields
 import io.opentracing.propagation.{Format, TextMapAdapter}
 import io.opentracing.tag.Tags
-import natchez.TraceValue.{BooleanValue, NumberValue, StringValue}
+import natchez.TraceValue._
 import _root_.datadog.trace.api.DDTags
 import natchez.Span.Options
 import natchez.datadog.DDTracer.{addLink, addSpanKind}
@@ -46,6 +46,7 @@ final case class DDSpan[F[_]: Sync](
       case (str, StringValue(value))  => Sync[F].delay(span.setTag(str, value))
       case (str, NumberValue(value))  => Sync[F].delay(span.setTag(str, value))
       case (str, BooleanValue(value)) => Sync[F].delay(span.setTag(str, value))
+      case (str, ListValue(v)) => Sync[F].delay(span.setTag(str, v.map(_.toString).mkString(", ")))
     }
 
   override def log(fields: (String, TraceValue)*): F[Unit] = {
diff --git a/modules/jaeger/src/main/scala/JaegerSpan.scala b/modules/jaeger/src/main/scala/JaegerSpan.scala
@@ -43,6 +43,7 @@ private[jaeger] final case class JaegerSpan[F[_]: Sync](
       case (k, StringValue(v))  => Sync[F].delay(span.setTag(k, v))
       case (k, NumberValue(v))  => Sync[F].delay(span.setTag(k, v))
       case (k, BooleanValue(v)) => Sync[F].delay(span.setTag(k, v))
+      case (k, ListValue(v))    => Sync[F].delay(span.setTag(k, v.map(_.toString).mkString(", ")))
     }
 
   override def attachError(err: Throwable, fields: (String, TraceValue)*): F[Unit] =
diff --git a/modules/lightstep/src/main/scala/LightstepSpan.scala b/modules/lightstep/src/main/scala/LightstepSpan.scala
@@ -39,6 +39,7 @@ private[lightstep] final case class LightstepSpan[F[_]: Sync](
       case (k, StringValue(v))  => Sync[F].delay(span.setTag(k, v))
       case (k, NumberValue(v))  => Sync[F].delay(span.setTag(k, v))
       case (k, BooleanValue(v)) => Sync[F].delay(span.setTag(k, v))
+      case (k, ListValue(v))    => Sync[F].delay(span.setTag(k, v.map(_.toString).mkString(", ")))
     }
 
   override def attachError(err: Throwable, fields: (String, TraceValue)*): F[Unit] =
diff --git a/modules/log-odin/src/main/scala/LogSpan.scala b/modules/log-odin/src/main/scala/LogSpan.scala
@@ -123,7 +123,7 @@ private[logodin] final case class LogSpan[F[_]: Sync: Logger](
 
 private[logodin] object LogSpan {
 
-  implicit val EncodeTraceValue: Encoder[TraceValue] =
+  implicit lazy val EncodeTraceValue: Encoder[TraceValue] =
     Encoder.instance {
       case StringValue(s)                       => s.asJson
       case BooleanValue(b)                      => b.asJson
@@ -138,6 +138,7 @@ private[logodin] object LogSpan {
       case NumberValue(n: BigDecimal)           => n.asJson
       case NumberValue(n: BigInt)               => n.asJson
       case NumberValue(n)                       => n.doubleValue.asJson
+      case ListValue(vs)                        => vs.map(EncodeTraceValue(_)).asJson
     }
 
   implicit val KeyEncodeCIString: KeyEncoder[CIString] = KeyEncoder[String].contramap(_.toString)
diff --git a/modules/log/shared/src/main/scala/LogSpan.scala b/modules/log/shared/src/main/scala/LogSpan.scala
@@ -111,7 +111,7 @@ private[log] final case class LogSpan[F[_]: Sync: Logger: UUIDGen](
 
 private[log] object LogSpan {
 
-  implicit val EncodeTraceValue: Encoder[TraceValue] =
+  implicit lazy val EncodeTraceValue: Encoder[TraceValue] =
     Encoder.instance {
       case StringValue(s)                       => s.asJson
       case BooleanValue(b)                      => b.asJson
@@ -126,6 +126,7 @@ private[log] object LogSpan {
       case NumberValue(n: BigDecimal)           => n.asJson
       case NumberValue(n: BigInt)               => n.asJson
       case NumberValue(n)                       => n.doubleValue.asJson
+      case ListValue(vs)                        => vs.map(EncodeTraceValue(_)).asJson
     }
 
   implicit val KeyEncodeCIString: KeyEncoder[CIString] = KeyEncoder[String].contramap(_.toString)
diff --git a/modules/mock/src/main/scala/MockSpan.scala b/modules/mock/src/main/scala/MockSpan.scala
@@ -13,7 +13,7 @@ import io.opentracing.log.Fields
 import io.{opentracing => ot}
 import io.opentracing.propagation.{Format, TextMapAdapter}
 import io.opentracing.tag.Tags
-import natchez.TraceValue.{BooleanValue, NumberValue, StringValue}
+import natchez.TraceValue._
 import java.net.URI
 
 final case class MockSpan[F[_]: Sync](tracer: ot.mock.MockTracer, span: ot.mock.MockSpan)
@@ -35,6 +35,7 @@ final case class MockSpan[F[_]: Sync](tracer: ot.mock.MockTracer, span: ot.mock.
       case (k, StringValue(v))  => Sync[F].delay(span.setTag(k, v))
       case (k, NumberValue(v))  => Sync[F].delay(span.setTag(k, v))
       case (k, BooleanValue(v)) => Sync[F].delay(span.setTag(k, v))
+      case (k, ListValue(v))    => Sync[F].delay(span.setTag(k, v.map(_.toString).mkString(", ")))
     }
 
   def attachError(err: Throwable, fields: (String, TraceValue)*): F[Unit] =
diff --git a/modules/newrelic/src/main/scala/natchez/newrelic/NewrelicSpan.scala b/modules/newrelic/src/main/scala/natchez/newrelic/NewrelicSpan.scala
@@ -11,7 +11,7 @@ import cats.effect.{Resource, Sync}
 import cats.syntax.all._
 import com.newrelic.telemetry.Attributes
 import com.newrelic.telemetry.spans.{Span, SpanBatch, SpanBatchSender}
-import natchez.TraceValue.{BooleanValue, NumberValue, StringValue}
+import natchez.TraceValue._
 import natchez.newrelic.NewrelicSpan.Headers
 import natchez.{Kernel, TraceValue}
 import org.typelevel.ci._
@@ -48,6 +48,7 @@ private[newrelic] final case class NewrelicSpan[F[_]: Sync](
       case (k, StringValue(v))  => attributes.update(att => att.put(k, v))
       case (k, NumberValue(v))  => attributes.update(att => att.put(k, v))
       case (k, BooleanValue(v)) => attributes.update(att => att.put(k, v))
+      case (k, ListValue(vs))   => attributes.update(att => att.put(k, vs.mkString(", ")))
     }
 
   override def attachError(err: Throwable, fields: (String, TraceValue)*): F[Unit] =
diff --git a/modules/opencensus/src/main/scala/OpenCensusSpan.scala b/modules/opencensus/src/main/scala/OpenCensusSpan.scala
@@ -14,7 +14,7 @@ import io.opencensus.trace.{AttributeValue, Sampler, SpanBuilder, Tracer, Tracin
 import io.opencensus.trace.propagation.SpanContextParseException
 import io.opencensus.trace.propagation.TextFormat.Getter
 import natchez.Span.{Options, SpanKind}
-import natchez.TraceValue.{BooleanValue, NumberValue, StringValue}
+import natchez.TraceValue._
 import org.typelevel.ci._
 
 import scala.collection.mutable
@@ -40,6 +40,8 @@ private[opencensus] final case class OpenCensusSpan[F[_]: Sync](
       AttributeValue.doubleAttributeValue(v.doubleValue())
     case BooleanValue(v) =>
       AttributeValue.booleanAttributeValue(v)
+    case ListValue(v) =>
+      AttributeValue.stringAttributeValue(v.map(_.toString).mkString(", "))
   }
 
   override def put(fields: (String, TraceValue)*): F[Unit] =
diff --git a/modules/opentelemetry/src/main/scala/natchez/opentelemetry/OpenTelemetrySpan.scala b/modules/opentelemetry/src/main/scala/natchez/opentelemetry/OpenTelemetrySpan.scala
@@ -24,7 +24,7 @@ import io.opentelemetry.context.Context
 
 import java.lang
 import io.opentelemetry.api.{OpenTelemetry => OTel}
-import TraceValue.{BooleanValue, NumberValue, StringValue}
+import TraceValue._
 
 import java.net.URI
 import scala.collection.mutable
@@ -66,6 +66,16 @@ private[opentelemetry] final case class OpenTelemetrySpan[F[_]: Sync](
       // and any other Number can fall back to a Double
       case (k, NumberValue(v))  => bldr.put(k, v.doubleValue())
       case (k, BooleanValue(v)) => bldr.put(k, v)
+      case (k, ListValue(vs))   =>
+        // TODO when support for HLists is merged, stop converting to string
+        // see https://opentelemetry.io/blog/2025/complex-attribute-types/#upcoming-support-for-complex-attribute-types-in-opentelemetry
+        val strings: List[String] = vs.collect {
+          case StringValue(v)  => v
+          case BooleanValue(v) => v.toString
+          case NumberValue(v)  => v.toString
+          case ListValue(v)    => v.mkString(", ")
+        }
+        bldr.put(k, strings: _*)
     }
     bldr.build()
   }
diff --git a/modules/xray/src/main/scala/natchez/xray/XRaySpan.scala b/modules/xray/src/main/scala/natchez/xray/XRaySpan.scala
@@ -154,7 +154,7 @@ private[xray] object XRaySpan {
 
   final case class XRayException(id: String, ex: Throwable)
 
-  implicit val EncodeTraceValue: Encoder[TraceValue] =
+  implicit lazy val EncodeTraceValue: Encoder[TraceValue] =
     Encoder.instance {
       case StringValue(s)                       => s.asJson
       case BooleanValue(b)                      => b.asJson
@@ -169,6 +169,7 @@ private[xray] object XRaySpan {
       case NumberValue(n: BigDecimal)           => n.asJson
       case NumberValue(n: BigInt)               => n.asJson
       case NumberValue(n)                       => n.doubleValue.asJson
+      case ListValue(vs)                        => vs.map(EncodeTraceValue(_)).asJson
     }
 
   val Header = ci"X-Amzn-Trace-Id"

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ private[jaeger] final case class JaegerSpan[F[_]: Sync](`
`43`	`43`	`case (k, StringValue(v)) => Sync[F].delay(span.setTag(k, v))`
`44`	`44`	`case (k, NumberValue(v)) => Sync[F].delay(span.setTag(k, v))`
`45`	`45`	`case (k, BooleanValue(v)) => Sync[F].delay(span.setTag(k, v))`
	`46`	`+ case (k, ListValue(v)) => Sync[F].delay(span.setTag(k, v.map(_.toString).mkString(", ")))`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`override def attachError(err: Throwable, fields: (String, TraceValue)*): F[Unit] =`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ private[lightstep] final case class LightstepSpan[F[_]: Sync](`
`39`	`39`	`case (k, StringValue(v)) => Sync[F].delay(span.setTag(k, v))`
`40`	`40`	`case (k, NumberValue(v)) => Sync[F].delay(span.setTag(k, v))`
`41`	`41`	`case (k, BooleanValue(v)) => Sync[F].delay(span.setTag(k, v))`
	`42`	`+ case (k, ListValue(v)) => Sync[F].delay(span.setTag(k, v.map(_.toString).mkString(", ")))`
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`override def attachError(err: Throwable, fields: (String, TraceValue)*): F[Unit] =`