Thanks to visit codestin.com
Credit goes to github.com

Skip to content

sdk-common: ComponentRegistry - use attributes as a part of identity #801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2024
+28 −41
Merged

sdk-common: ComponentRegistry - use attributes as a part of identity #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 10 additions & 36 deletions sdk/common/shared/src/main/scala/org/typelevel/otel4s/sdk/internal/ComponentRegistry.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import cats.effect.std.AtomicCell
import cats.syntax.functor._
import org.typelevel.otel4s.sdk.common.InstrumentationScope

/** A registry that caches components by `key`, `version`, and `schemaUrl`.
/** A registry that caches components by `key`, `version`, `schemaUrl`, and `attributes`.
*
* @tparam F
* the higher-kinded type of a polymorphic effect
Expand All @@ -34,12 +34,7 @@ import org.typelevel.otel4s.sdk.common.InstrumentationScope
*/
private[sdk] sealed trait ComponentRegistry[F[_], A] {

/** Returns the component associated with the `name`, `version`, and `schemaUrl`.
*
* '''Note''': `attributes` are not part of component identity.
*
* Behavior is undefined when different `attributes` are provided where `name`, `version`, and `schemaUrl` are
* identical.
/** Returns the component associated with the `name`, `version`, `schemaUrl`, and `attributes`.
*
* @param name
* the name to associate with a component
Expand All @@ -53,12 +48,7 @@ private[sdk] sealed trait ComponentRegistry[F[_], A] {
* @param attributes
* the attributes to associate with a component
*/
def get(
name: String,
version: Option[String],
schemaUrl: Option[String],
attributes: Attributes
): F[A]
def get(name: String, version: Option[String], schemaUrl: Option[String], attributes: Attributes): F[A]

/** Returns the collection of the registered components.
*/
Expand All @@ -80,44 +70,28 @@ private[sdk] object ComponentRegistry {
* @tparam A
* the type of the component
*/
def create[F[_]: Concurrent, A](
buildComponent: InstrumentationScope => F[A]
): F[ComponentRegistry[F, A]] =
def create[F[_]: Concurrent, A](buildComponent: InstrumentationScope => F[A]): F[ComponentRegistry[F, A]] =
for {
cache <- AtomicCell[F].of(Map.empty[Key, A])
cache <- AtomicCell[F].of(Map.empty[InstrumentationScope, A])
} yield new Impl(cache, buildComponent)

private final case class Key(
name: String,
version: Option[String],
schemaUrl: Option[String]
)

private final class Impl[F[_]: Applicative, A](
cache: AtomicCell[F, Map[Key, A]],
cache: AtomicCell[F, Map[InstrumentationScope, A]],
buildComponent: InstrumentationScope => F[A]
) extends ComponentRegistry[F, A] {

def get(
name: String,
version: Option[String],
schemaUrl: Option[String],
attributes: Attributes
): F[A] =
def get(name: String, version: Option[String], schemaUrl: Option[String], attributes: Attributes): F[A] =
cache.evalModify { cache =>
val key = Key(name, version, schemaUrl)
val scope = InstrumentationScope(name, version, schemaUrl, attributes)

cache.get(key) match {
cache.get(scope) match {
case Some(component) =>
Applicative[F].pure((cache, component))

case None =>
val scope =
InstrumentationScope(name, version, schemaUrl, attributes)

for {
component <- buildComponent(scope)
} yield (cache.updated(key, component), component)
} yield (cache.updated(scope, component), component)
}
}

Expand Down
23 changes: 18 additions & 5 deletions ...mmon/shared/src/test/scala/org/typelevel/otel4s/sdk/internal/ComponentRegistrySuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,14 @@ class ComponentRegistrySuite extends CatsEffectSuite {

registryTest("get cached values (by name only)") { registry =>
for {
v0 <- registry.get(name, None, None, Attributes.empty)
v1 <- registry.get(name, None, None, Attributes.empty)
v2 <- registry.get(name, None, None, attributes)
v3 <- registry.get(name, Some(version), None, attributes)
v4 <- registry.get(name, Some(version), Some(schemaUrl), attributes)
} yield {
assertEquals(v1, v2)
assertEquals(v0, v1)
assertNotEquals(v1, v2)
assertNotEquals(v1, v3)
assertNotEquals(v2, v3)
assertNotEquals(v1, v4)
Expand All @@ -45,26 +47,37 @@ class ComponentRegistrySuite extends CatsEffectSuite {

registryTest("get cached values (by name and version)") { registry =>
for {
v0 <- registry.get(name, Some(version), None, Attributes.empty)
v1 <- registry.get(name, Some(version), None, Attributes.empty)
v2 <- registry.get(name, Some(version), None, attributes)
v3 <- registry.get(name, Some(version), Some(schemaUrl), attributes)
} yield {
assertEquals(v1, v2)
assertEquals(v0, v1)
assertNotEquals(v1, v2)
assertNotEquals(v1, v3)
assertNotEquals(v2, v3)
}
}

registryTest("get cached values (by name, version, and schema)") { registry =>
for {
v0 <- registry.get(name, Some(version), Some(schemaUrl), Attributes.empty)
v1 <- registry.get(name, Some(version), Some(schemaUrl), Attributes.empty)
v2 <- registry.get(name, Some(version), Some(schemaUrl), attributes)
} yield {
assertEquals(v0, v1)
assertNotEquals(v1, v2)
}
}

registryTest("get cached values (by name, version, schema, and attributes)") { registry =>
for {
v1 <- registry.get(name, Some(version), Some(schemaUrl), attributes)
v2 <- registry.get(name, Some(version), Some(schemaUrl), attributes)
} yield assertEquals(v1, v2)
}

private def registryTest(
name: String
)(body: ComponentRegistry[IO, TestComponent] => IO[Unit]): Unit =
private def registryTest(name: String)(body: ComponentRegistry[IO, TestComponent] => IO[Unit]): Unit =
test(name) {
for {
registry <- ComponentRegistry.create(_ => IO.pure(new TestComponent()))
Expand Down