Skip to content

feat(spring): [Cache Tracing 13] Instrument putIfAbsent, replace, and getAndReplace #5202

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: feat/cache-tracing-db-operation-name
Choose a base branch
from
+159 −43
Draft

feat(spring): [Cache Tracing 13] Instrument putIfAbsent, replace, and getAndReplace #5202

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
69 changes: 60 additions & 9 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 @@ -153,29 +153,80 @@ public void putAll(final Map<? extends K, ? extends V> map) {
}
}

// putIfAbsent is not instrumented — we cannot know ahead of time whether the put
// will actually happen, and emitting a cache.put span for a no-op would be misleading.
@Override
public boolean putIfAbsent(final K key, final V value) {
return delegate.putIfAbsent(key, value);
final ISpan span = startSpan("cache.put", key, "putIfAbsent");
if (span == null) {
return delegate.putIfAbsent(key, value);
}
try {
final boolean result = delegate.putIfAbsent(key, value);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(e);
throw e;
} finally {
span.finish();
}
}

// replace and getAndReplace are not instrumented — like putIfAbsent, they are conditional
// writes (only happen if the key exists / value matches). Emitting a cache.put span for a
// potential no-op would be misleading.
@Override
public boolean replace(final K key, final V oldValue, final V newValue) {
return delegate.replace(key, oldValue, newValue);
final ISpan span = startSpan("cache.put", key, "replace");
if (span == null) {
return delegate.replace(key, oldValue, newValue);
}
try {
final boolean result = delegate.replace(key, oldValue, newValue);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(e);
throw e;
} finally {
span.finish();
}
}

@Override
public boolean replace(final K key, final V value) {
return delegate.replace(key, value);
final ISpan span = startSpan("cache.put", key, "replace");
if (span == null) {
return delegate.replace(key, value);
}
try {
final boolean result = delegate.replace(key, value);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(e);
throw e;
} finally {
span.finish();
}
}

@Override
public V getAndReplace(final K key, final V value) {
return delegate.getAndReplace(key, value);
final ISpan span = startSpan("cache.put", key, "getAndReplace");
if (span == null) {
return delegate.getAndReplace(key, value);
}
try {
final V result = delegate.getAndReplace(key, value);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(e);
throw e;
} finally {
span.finish();
}
}

// -- remove operations --
Expand Down
37 changes: 27 additions & 10 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 @@ -171,7 +171,7 @@ class SentryJCacheWrapperTest {
// -- putIfAbsent --

@Test
fun `putIfAbsent delegates without creating span`() {
fun `putIfAbsent creates cache put span`() {
val tx = createTransaction()
val wrapper = SentryJCacheWrapper(delegate, scopes)
whenever(delegate.putIfAbsent("myKey", "myValue")).thenReturn(true)
Expand All @@ -180,13 +180,18 @@ class SentryJCacheWrapperTest {

assertTrue(result)
verify(delegate).putIfAbsent("myKey", "myValue")
assertEquals(0, tx.spans.size)
assertEquals(1, tx.spans.size)
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData("db.operation.name"))
}

// -- replace (passthrough, no span — conditional write) --
// -- replace --

@Test
fun `replace with old value delegates without creating span`() {
fun `replace with old value creates cache put span`() {
val tx = createTransaction()
val wrapper = SentryJCacheWrapper(delegate, scopes)
whenever(delegate.replace("myKey", "old", "new")).thenReturn(true)
Expand All @@ -195,11 +200,15 @@ class SentryJCacheWrapperTest {

assertTrue(result)
verify(delegate).replace("myKey", "old", "new")
assertEquals(0, tx.spans.size)
assertEquals(1, tx.spans.size)
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("replace", span.getData("db.operation.name"))
}

@Test
fun `replace delegates without creating span`() {
fun `replace creates cache put span`() {
val tx = createTransaction()
val wrapper = SentryJCacheWrapper(delegate, scopes)
whenever(delegate.replace("myKey", "value")).thenReturn(true)
Expand All @@ -208,13 +217,17 @@ class SentryJCacheWrapperTest {

assertTrue(result)
verify(delegate).replace("myKey", "value")
assertEquals(0, tx.spans.size)
assertEquals(1, tx.spans.size)
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("replace", span.getData("db.operation.name"))
}

// -- getAndReplace (passthrough, no span — conditional write) --
// -- getAndReplace --

@Test
fun `getAndReplace delegates without creating span`() {
fun `getAndReplace creates cache put span`() {
val tx = createTransaction()
val wrapper = SentryJCacheWrapper(delegate, scopes)
whenever(delegate.getAndReplace("myKey", "newValue")).thenReturn("oldValue")
Expand All @@ -223,7 +236,11 @@ class SentryJCacheWrapperTest {

assertEquals("oldValue", result)
verify(delegate).getAndReplace("myKey", "newValue")
assertEquals(0, tx.spans.size)
assertEquals(1, tx.spans.size)
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals("getAndReplace", span.getData("db.operation.name"))
}

// -- remove(K) --
Expand Down
20 changes: 15 additions & 5 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 @@ -196,14 +196,24 @@ public void put(final @NotNull Object key, final @Nullable Object value) {
}
}

// putIfAbsent is not instrumented — we cannot know ahead of time whether the put
// will actually happen, and emitting a cache.put span for a no-op would be misleading.
// This matches sentry-python and sentry-javascript which also skip conditional puts.
// We must override to bypass the default implementation which calls this.get() + this.put().
@Override
public @Nullable ValueWrapper putIfAbsent(
final @NotNull Object key, final @Nullable Object value) {
return delegate.putIfAbsent(key, value);
final ISpan span = startSpan("cache.put", key, "putIfAbsent");
if (span == null) {
return delegate.putIfAbsent(key, value);
}
try {
final ValueWrapper result = delegate.putIfAbsent(key, value);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(e);
throw e;
} finally {
span.finish();
}
}

@Override
Expand Down
12 changes: 9 additions & 3 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 @@ -328,15 +328,21 @@ class SentryCacheWrapperTest {
// -- putIfAbsent --

@Test
fun `putIfAbsent delegates without creating span`() {
fun `putIfAbsent creates cache put span`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
whenever(delegate.putIfAbsent("myKey", "myValue")).thenReturn(null)

wrapper.putIfAbsent("myKey", "myValue")
val result = wrapper.putIfAbsent("myKey", "myValue")

assertNull(result)
verify(delegate).putIfAbsent("myKey", "myValue")
assertEquals(0, tx.spans.size)
assertEquals(1, tx.spans.size)
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData("db.operation.name"))
}

// -- evict --
Expand Down
20 changes: 15 additions & 5 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 @@ -196,14 +196,24 @@ public void put(final @NotNull Object key, final @Nullable Object value) {
}
}

// putIfAbsent is not instrumented — we cannot know ahead of time whether the put
// will actually happen, and emitting a cache.put span for a no-op would be misleading.
// This matches sentry-python and sentry-javascript which also skip conditional puts.
// We must override to bypass the default implementation which calls this.get() + this.put().
@Override
public @Nullable ValueWrapper putIfAbsent(
final @NotNull Object key, final @Nullable Object value) {
return delegate.putIfAbsent(key, value);
final ISpan span = startSpan("cache.put", key, "putIfAbsent");
if (span == null) {
return delegate.putIfAbsent(key, value);
}
try {
final ValueWrapper result = delegate.putIfAbsent(key, value);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(e);
throw e;
} finally {
span.finish();
}
}

@Override
Expand Down
12 changes: 9 additions & 3 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 @@ -328,15 +328,21 @@ class SentryCacheWrapperTest {
// -- putIfAbsent --

@Test
fun `putIfAbsent delegates without creating span`() {
fun `putIfAbsent creates cache put span`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
whenever(delegate.putIfAbsent("myKey", "myValue")).thenReturn(null)

wrapper.putIfAbsent("myKey", "myValue")
val result = wrapper.putIfAbsent("myKey", "myValue")

assertNull(result)
verify(delegate).putIfAbsent("myKey", "myValue")
assertEquals(0, tx.spans.size)
assertEquals(1, tx.spans.size)
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData("db.operation.name"))
}

// -- evict --
Expand Down
20 changes: 15 additions & 5 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 @@ -124,14 +124,24 @@ public void put(final @NotNull Object key, final @Nullable Object value) {
}
}

// putIfAbsent is not instrumented — we cannot know ahead of time whether the put
// will actually happen, and emitting a cache.put span for a no-op would be misleading.
// This matches sentry-python and sentry-javascript which also skip conditional puts.
// We must override to bypass the default implementation which calls this.get() + this.put().
@Override
public @Nullable ValueWrapper putIfAbsent(
final @NotNull Object key, final @Nullable Object value) {
return delegate.putIfAbsent(key, value);
final ISpan span = startSpan("cache.put", key, "putIfAbsent");
if (span == null) {
return delegate.putIfAbsent(key, value);
}
try {
final ValueWrapper result = delegate.putIfAbsent(key, value);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(e);
throw e;
} finally {
span.finish();
}
}

@Override
Expand Down
12 changes: 9 additions & 3 deletions sentry-spring/src/test/kotlin/io/sentry/spring/cache/SentryCacheWrapperTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,15 +159,21 @@ class SentryCacheWrapperTest {
// -- putIfAbsent --

@Test
fun `putIfAbsent delegates without creating span`() {
fun `putIfAbsent creates cache put span`() {
val tx = createTransaction()
val wrapper = SentryCacheWrapper(delegate, scopes)
whenever(delegate.putIfAbsent("myKey", "myValue")).thenReturn(null)

wrapper.putIfAbsent("myKey", "myValue")
val result = wrapper.putIfAbsent("myKey", "myValue")

assertNull(result)
verify(delegate).putIfAbsent("myKey", "myValue")
assertEquals(0, tx.spans.size)
assertEquals(1, tx.spans.size)
val span = tx.spans.first()
assertEquals("cache.put", span.operation)
assertEquals(SpanStatus.OK, span.status)
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals("putIfAbsent", span.getData("db.operation.name"))
}

// -- evict --
Expand Down
Loading