Skip to content

feat(cache): [Cache Tracing 18] Add cache.write boolean span attribute #5207

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-cache-operation-key
Choose a base branch
from
+85 −0
Draft

feat(cache): [Cache Tracing 18] Add cache.write boolean span attribute #5207

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
13 changes: 13 additions & 0 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 @@ -105,6 +105,7 @@ public void put(final K key, final V value) {
}
try {
delegate.put(key, value);
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand All @@ -123,6 +124,7 @@ public V getAndPut(final K key, final V value) {
}
try {
final V result = delegate.getAndPut(key, value);
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -143,6 +145,7 @@ public void putAll(final Map<? extends K, ? extends V> map) {
}
try {
delegate.putAll(map);
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand All @@ -161,6 +164,7 @@ public boolean putIfAbsent(final K key, final V value) {
}
try {
final boolean result = delegate.putIfAbsent(key, value);
span.setData(SpanDataConvention.CACHE_WRITE, result);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -180,6 +184,7 @@ public boolean replace(final K key, final V oldValue, final V newValue) {
}
try {
final boolean result = delegate.replace(key, oldValue, newValue);
span.setData(SpanDataConvention.CACHE_WRITE, result);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -199,6 +204,7 @@ public boolean replace(final K key, final V value) {
}
try {
final boolean result = delegate.replace(key, value);
span.setData(SpanDataConvention.CACHE_WRITE, result);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -218,6 +224,7 @@ public V getAndReplace(final K key, final V value) {
}
try {
final V result = delegate.getAndReplace(key, value);
span.setData(SpanDataConvention.CACHE_WRITE, result != null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -239,6 +246,7 @@ public boolean remove(final K key) {
}
try {
final boolean result = delegate.remove(key);
span.setData(SpanDataConvention.CACHE_WRITE, result);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -258,6 +266,7 @@ public boolean remove(final K key, final V oldValue) {
}
try {
final boolean result = delegate.remove(key, oldValue);
span.setData(SpanDataConvention.CACHE_WRITE, result);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -277,6 +286,7 @@ public V getAndRemove(final K key) {
}
try {
final V result = delegate.getAndRemove(key);
span.setData(SpanDataConvention.CACHE_WRITE, result != null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -297,6 +307,7 @@ public void removeAll(final Set<? extends K> keys) {
}
try {
delegate.removeAll(keys);
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand All @@ -316,6 +327,7 @@ public void removeAll() {
}
try {
delegate.removeAll();
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand All @@ -337,6 +349,7 @@ public void clear() {
}
try {
delegate.clear();
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand Down
14 changes: 14 additions & 0 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 @@ -62,6 +62,7 @@ class SentryJCacheWrapperTest {
assertEquals("myKey", span.description)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertNull(span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("auto.cache.jcache", span.spanContext.origin)
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
Expand Down Expand Up @@ -128,6 +129,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}
Expand All @@ -145,6 +147,7 @@ class SentryJCacheWrapperTest {
assertEquals("oldValue", result)
assertEquals(1, tx.spans.size)
assertEquals("cache.getAndPut", tx.spans.first().operation)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
assertEquals("getAndPut", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

Expand All @@ -163,6 +166,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.putAll", span.operation)
assertEquals("testCache", span.description)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY_KEY) as List<*>
assertTrue(cacheKeys.containsAll(listOf("k1", "k2")))
assertEquals("putAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
Expand All @@ -184,6 +188,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.putIfAbsent", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}
Expand All @@ -204,6 +209,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.replace", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

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

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

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

Expand All @@ -274,6 +283,7 @@ class SentryJCacheWrapperTest {
assertTrue(result)
assertEquals(1, tx.spans.size)
assertEquals("cache.remove", tx.spans.first().operation)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
assertEquals("remove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

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

Expand All @@ -308,6 +319,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.removeAll", span.operation)
assertEquals("testCache", span.description)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals("removeAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

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

Expand All @@ -340,6 +353,7 @@ class SentryJCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.clear", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertNull(span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}
Expand Down
8 changes: 8 additions & 0 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 @@ -96,6 +96,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
return valueLoader.call();
});
span.setData(SpanDataConvention.CACHE_HIT_KEY, !loaderInvoked.get());
span.setData(SpanDataConvention.CACHE_WRITE, loaderInvoked.get());
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand Down Expand Up @@ -171,6 +172,7 @@ public <T> CompletableFuture<T> retrieve(
span.setThrowable(throwable);
} else {
span.setData(SpanDataConvention.CACHE_HIT_KEY, !loaderInvoked.get());
span.setData(SpanDataConvention.CACHE_WRITE, loaderInvoked.get());
span.setStatus(SpanStatus.OK);
}
span.finish();
Expand All @@ -186,6 +188,7 @@ public void put(final @NotNull Object key, final @Nullable Object value) {
}
try {
delegate.put(key, value);
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand All @@ -205,6 +208,7 @@ public void put(final @NotNull Object key, final @Nullable Object value) {
}
try {
final ValueWrapper result = delegate.putIfAbsent(key, value);
span.setData(SpanDataConvention.CACHE_WRITE, result == null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -225,6 +229,7 @@ public void evict(final @NotNull Object key) {
}
try {
delegate.evict(key);
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand All @@ -243,6 +248,7 @@ public boolean evictIfPresent(final @NotNull Object key) {
}
try {
final boolean result = delegate.evictIfPresent(key);
span.setData(SpanDataConvention.CACHE_WRITE, result);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -263,6 +269,7 @@ public void clear() {
}
try {
delegate.clear();
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
Expand All @@ -281,6 +288,7 @@ public boolean invalidate() {
}
try {
final boolean result = delegate.invalidate();
span.setData(SpanDataConvention.CACHE_WRITE, true);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand Down
12 changes: 12 additions & 0 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 @@ -61,6 +61,7 @@ class SentryCacheWrapperTest {
assertEquals("myKey", span.description)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertNull(span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("auto.cache.spring", span.spanContext.origin)
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
Expand Down Expand Up @@ -155,6 +156,7 @@ class SentryCacheWrapperTest {
assertEquals("cached", result)
assertEquals(1, tx.spans.size)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
}

@Test
Expand All @@ -172,6 +174,7 @@ class SentryCacheWrapperTest {
assertEquals("loaded", result)
assertEquals(1, tx.spans.size)
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
}

// -- retrieve(Object key) --
Expand All @@ -191,6 +194,7 @@ class SentryCacheWrapperTest {
assertEquals("myKey", span.description)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertNull(span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals("retrieve", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
assertTrue(span.isFinished)
}
Expand Down Expand Up @@ -287,6 +291,7 @@ class SentryCacheWrapperTest {
assertEquals("cached", result.get())
assertEquals(1, tx.spans.size)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
assertTrue(tx.spans.first().isFinished)
}

Expand All @@ -306,6 +311,7 @@ class SentryCacheWrapperTest {
assertEquals("loaded", result.get())
assertEquals(1, tx.spans.size)
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
assertTrue(tx.spans.first().isFinished)
}

Expand Down Expand Up @@ -355,6 +361,7 @@ class SentryCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}
Expand All @@ -375,6 +382,7 @@ class SentryCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.putIfAbsent", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}
Expand All @@ -393,6 +401,7 @@ class SentryCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.evict", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals("evict", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

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

Expand All @@ -426,6 +436,7 @@ class SentryCacheWrapperTest {
val span = tx.spans.first()
assertEquals("cache.clear", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertNull(span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
}
Expand All @@ -443,6 +454,7 @@ class SentryCacheWrapperTest {
assertTrue(result)
assertEquals(1, tx.spans.size)
assertEquals("cache.invalidate", tx.spans.first().operation)
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
assertEquals("invalidate", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
}

Expand Down
Loading
Loading