Skip to content

ref(cache): [Cache Tracing 17] Move operation attribute to centralized CACHE_OPERATION_KEY #5206

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

Draft
adinauer wants to merge 1 commit into
base: ref/cache-tracing-merge-startspan-helpers
Choose a base branch
from
Draft

ref(cache): [Cache Tracing 17] Move operation attribute to centralized CACHE_OPERATION_KEY #5206

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
3 changes: 1 addition & 2 deletions sentry-jcache/src/main/java/io/sentry/jcache/SentryJCacheWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
public final class SentryJCacheWrapper<K, V> implements Cache<K, V> {

private static final String TRACE_ORIGIN = "auto.cache.jcache";
private static final String OPERATION_ATTRIBUTE = "db.operation.name";

private final @NotNull Cache<K, V> delegate;
private final @NotNull IScopes scopes;
Expand Down Expand Up @@ -489,7 +488,7 @@ public Iterator<Entry<K, V>> iterator() {
if (cacheKeys != null) {
span.setData(SpanDataConvention.CACHE_KEY_KEY, cacheKeys);
}
span.setData(OPERATION_ATTRIBUTE, operationName);
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
return span;
}
}
34 changes: 17 additions & 17 deletions sentry-jcache/src/test/kotlin/io/sentry/jcache/SentryJCacheWrapperTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class SentryJCacheWrapperTest {
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("auto.cache.jcache", span.spanContext.origin)
assertEquals("get", span.getData("db.operation.name"))
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

@Test
Expand Down Expand Up @@ -99,7 +99,7 @@ class SentryJCacheWrapperTest {
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY_KEY) as List<*>
assertTrue(cacheKeys.containsAll(listOf("k1", "k2")))
assertEquals("getAll", span.getData("db.operation.name"))
assertEquals("getAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

@Test
Expand Down Expand Up @@ -129,7 +129,7 @@ class SentryJCacheWrapperTest {
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("put", span.getData("db.operation.name"))
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- getAndPut --
Expand All @@ -145,7 +145,7 @@ class SentryJCacheWrapperTest {
assertEquals("oldValue", result)
assertEquals(1, tx.spans.size)
assertEquals("cache.getAndPut", tx.spans.first().operation)
assertEquals("getAndPut", tx.spans.first().getData("db.operation.name"))
assertEquals("getAndPut", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- putAll --
Expand All @@ -165,7 +165,7 @@ class SentryJCacheWrapperTest {
assertEquals("testCache", span.description)
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY_KEY) as List<*>
assertTrue(cacheKeys.containsAll(listOf("k1", "k2")))
assertEquals("putAll", span.getData("db.operation.name"))
assertEquals("putAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- putIfAbsent --
Expand All @@ -185,7 +185,7 @@ class SentryJCacheWrapperTest {
assertEquals("cache.putIfAbsent", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData("db.operation.name"))
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- replace --
Expand All @@ -204,7 +204,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.replace", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("replace", span.getData("db.operation.name"))
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

@Test
Expand All @@ -221,7 +221,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.replace", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("replace", span.getData("db.operation.name"))
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- getAndReplace --
Expand All @@ -240,7 +240,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.getAndReplace", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("getAndReplace", span.getData("db.operation.name"))
assertEquals("getAndReplace", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- remove(K) --
Expand All @@ -258,7 +258,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.remove", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("remove", span.getData("db.operation.name"))
assertEquals("remove", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- remove(K, V) --
Expand All @@ -274,7 +274,7 @@ class SentryJCacheWrapperTest {
assertTrue(result)
assertEquals(1, tx.spans.size)
assertEquals("cache.remove", tx.spans.first().operation)
assertEquals("remove", tx.spans.first().getData("db.operation.name"))
assertEquals("remove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- getAndRemove --
Expand All @@ -290,7 +290,7 @@ class SentryJCacheWrapperTest {
assertEquals("value", result)
assertEquals(1, tx.spans.size)
assertEquals("cache.getAndRemove", tx.spans.first().operation)
assertEquals("getAndRemove", tx.spans.first().getData("db.operation.name"))
assertEquals("getAndRemove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- removeAll(Set) --
Expand All @@ -308,7 +308,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.removeAll", span.operation)
assertEquals("testCache", span.description)
assertEquals("removeAll", span.getData("db.operation.name"))
assertEquals("removeAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- removeAll() --
Expand All @@ -323,7 +323,7 @@ class SentryJCacheWrapperTest {
verify(delegate).removeAll()
assertEquals(1, tx.spans.size)
assertEquals("cache.removeAll", tx.spans.first().operation)
assertEquals("removeAll", tx.spans.first().getData("db.operation.name"))
assertEquals("removeAll", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- clear --
Expand All @@ -341,7 +341,7 @@ class SentryJCacheWrapperTest {
assertEquals("cache.clear", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertNull(span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("clear", span.getData("db.operation.name"))
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- invoke --
Expand All @@ -358,7 +358,7 @@ class SentryJCacheWrapperTest {
assertEquals("result", result)
assertEquals(1, tx.spans.size)
assertEquals("cache.invoke", tx.spans.first().operation)
assertEquals("invoke", tx.spans.first().getData("db.operation.name"))
assertEquals("invoke", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- invokeAll --
Expand All @@ -377,7 +377,7 @@ class SentryJCacheWrapperTest {
assertEquals(resultMap, result)
assertEquals(1, tx.spans.size)
assertEquals("cache.invokeAll", tx.spans.first().operation)
assertEquals("invokeAll", tx.spans.first().getData("db.operation.name"))
assertEquals("invokeAll", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- passthrough operations --
Expand Down
3 changes: 1 addition & 2 deletions sentry-spring-7/src/main/java/io/sentry/spring7/cache/SentryCacheWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
public final class SentryCacheWrapper implements Cache {

private static final String TRACE_ORIGIN = "auto.cache.spring";
private static final String OPERATION_ATTRIBUTE = "db.operation.name";

private final @NotNull Cache delegate;
private final @NotNull IScopes scopes;
Expand Down Expand Up @@ -314,7 +313,7 @@ public boolean invalidate() {
if (keyString != null) {
span.setData(SpanDataConvention.CACHE_KEY_KEY, Arrays.asList(keyString));
}
span.setData(OPERATION_ATTRIBUTE, operationName);
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
return span;
}
}
16 changes: 8 additions & 8 deletions sentry-spring-7/src/test/kotlin/io/sentry/spring7/cache/SentryCacheWrapperTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class SentryCacheWrapperTest {
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("auto.cache.spring", span.spanContext.origin)
assertEquals("get", span.getData("db.operation.name"))
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

@Test
Expand Down Expand Up @@ -191,7 +191,7 @@ class SentryCacheWrapperTest {
assertEquals("myKey", span.description)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals("retrieve", span.getData("db.operation.name"))
assertEquals("retrieve", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
assertTrue(span.isFinished)
}

Expand Down Expand Up @@ -356,7 +356,7 @@ class SentryCacheWrapperTest {
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("put", span.getData("db.operation.name"))
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- putIfAbsent --
Expand All @@ -376,7 +376,7 @@ class SentryCacheWrapperTest {
assertEquals("cache.putIfAbsent", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData("db.operation.name"))
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- evict --
Expand All @@ -393,7 +393,7 @@ class SentryCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.evict", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("evict", span.getData("db.operation.name"))
assertEquals("evict", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- evictIfPresent --
Expand All @@ -409,7 +409,7 @@ class SentryCacheWrapperTest {
assertTrue(result)
assertEquals(1, tx.spans.size)
assertEquals("cache.evictIfPresent", tx.spans.first().operation)
assertEquals("evictIfPresent", tx.spans.first().getData("db.operation.name"))
assertEquals("evictIfPresent", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- clear --
Expand All @@ -427,7 +427,7 @@ class SentryCacheWrapperTest {
assertEquals("cache.clear", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertNull(span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("clear", span.getData("db.operation.name"))
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- invalidate --
Expand All @@ -443,7 +443,7 @@ class SentryCacheWrapperTest {
assertTrue(result)
assertEquals(1, tx.spans.size)
assertEquals("cache.invalidate", tx.spans.first().operation)
assertEquals("invalidate", tx.spans.first().getData("db.operation.name"))
assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- no span when no active transaction --
Expand Down
3 changes: 1 addition & 2 deletions sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/cache/SentryCacheWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
public final class SentryCacheWrapper implements Cache {

private static final String TRACE_ORIGIN = "auto.cache.spring";
private static final String OPERATION_ATTRIBUTE = "db.operation.name";

private final @NotNull Cache delegate;
private final @NotNull IScopes scopes;
Expand Down Expand Up @@ -314,7 +313,7 @@ public boolean invalidate() {
if (keyString != null) {
span.setData(SpanDataConvention.CACHE_KEY_KEY, Arrays.asList(keyString));
}
span.setData(OPERATION_ATTRIBUTE, operationName);
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
return span;
}
}
16 changes: 8 additions & 8 deletions ...y-spring-jakarta/src/test/kotlin/io/sentry/spring/jakarta/cache/SentryCacheWrapperTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class SentryCacheWrapperTest {
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("auto.cache.spring", span.spanContext.origin)
assertEquals("get", span.getData("db.operation.name"))
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

@Test
Expand Down Expand Up @@ -191,7 +191,7 @@ class SentryCacheWrapperTest {
assertEquals("myKey", span.description)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals("retrieve", span.getData("db.operation.name"))
assertEquals("retrieve", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
assertTrue(span.isFinished)
}

Expand Down Expand Up @@ -356,7 +356,7 @@ class SentryCacheWrapperTest {
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("put", span.getData("db.operation.name"))
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- putIfAbsent --
Expand All @@ -376,7 +376,7 @@ class SentryCacheWrapperTest {
assertEquals("cache.putIfAbsent", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData("db.operation.name"))
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- evict --
Expand All @@ -393,7 +393,7 @@ class SentryCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.evict", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("evict", span.getData("db.operation.name"))
assertEquals("evict", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- evictIfPresent --
Expand All @@ -409,7 +409,7 @@ class SentryCacheWrapperTest {
assertTrue(result)
assertEquals(1, tx.spans.size)
assertEquals("cache.evictIfPresent", tx.spans.first().operation)
assertEquals("evictIfPresent", tx.spans.first().getData("db.operation.name"))
assertEquals("evictIfPresent", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- clear --
Expand All @@ -427,7 +427,7 @@ class SentryCacheWrapperTest {
assertEquals("cache.clear", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertNull(span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("clear", span.getData("db.operation.name"))
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- invalidate --
Expand All @@ -443,7 +443,7 @@ class SentryCacheWrapperTest {
assertTrue(result)
assertEquals(1, tx.spans.size)
assertEquals("cache.invalidate", tx.spans.first().operation)
assertEquals("invalidate", tx.spans.first().getData("db.operation.name"))
assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

// -- no span when no active transaction --
Expand Down
3 changes: 1 addition & 2 deletions sentry-spring/src/main/java/io/sentry/spring/cache/SentryCacheWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
public final class SentryCacheWrapper implements Cache {

private static final String TRACE_ORIGIN = "auto.cache.spring";
private static final String OPERATION_ATTRIBUTE = "db.operation.name";

private final @NotNull Cache delegate;
private final @NotNull IScopes scopes;
Expand Down Expand Up @@ -242,7 +241,7 @@ public boolean invalidate() {
if (keyString != null) {
span.setData(SpanDataConvention.CACHE_KEY_KEY, Arrays.asList(keyString));
}
span.setData(OPERATION_ATTRIBUTE, operationName);
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
return span;
}
}
Loading
Loading