Skip to content

ref(cache): [Cache Tracing 20] Remove _KEY suffix from cache SpanDataConvention constants #5209

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: fix/cache-tracing-jcache-bulk-description
Choose a base branch
from
+124 −124
Draft

ref(cache): [Cache Tracing 20] Remove _KEY suffix from cache SpanDataConvention constants #5209

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
8 changes: 4 additions & 4 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 @@ -57,7 +57,7 @@ public V get(final K key) {
}
try {
final V result = delegate.get(key);
span.setData(SpanDataConvention.CACHE_HIT_KEY, result != null);
span.setData(SpanDataConvention.CACHE_HIT, result != null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -77,7 +77,7 @@ public Map<K, V> getAll(final Set<? extends K> keys) {
}
try {
final Map<K, V> result = delegate.getAll(keys);
span.setData(SpanDataConvention.CACHE_HIT_KEY, !result.isEmpty());
span.setData(SpanDataConvention.CACHE_HIT, !result.isEmpty());
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand Down Expand Up @@ -497,9 +497,9 @@ public Iterator<Entry<K, V>> iterator() {
return null;
}
if (cacheKeys != null) {
span.setData(SpanDataConvention.CACHE_KEY_KEY, cacheKeys);
span.setData(SpanDataConvention.CACHE_KEY, cacheKeys);
}
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
span.setData(SpanDataConvention.CACHE_OPERATION, operationName);
return span;
}
}
54 changes: 27 additions & 27 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 @@ -61,11 +61,11 @@ class SentryJCacheWrapperTest {
assertEquals("cache.get", span.operation)
assertEquals("myKey", span.description)
assertEquals(SpanStatus.OK, span.status)
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT))
assertNull(span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY))
assertEquals("auto.cache.jcache", span.spanContext.origin)
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION))
}

@Test
Expand All @@ -78,7 +78,7 @@ class SentryJCacheWrapperTest {

assertNull(result)
assertEquals(1, tx.spans.size)
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

// -- getAll --
Expand All @@ -98,10 +98,10 @@ class SentryJCacheWrapperTest {
assertEquals("cache.getAll", span.operation)
assertTrue(span.description!!.contains("k1"))
assertTrue(span.description!!.contains("k2"))
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY_KEY) as List<*>
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT))
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY) as List<*>
assertTrue(cacheKeys.containsAll(listOf("k1", "k2")))
assertEquals("getAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
assertEquals("getAll", span.getData(SpanDataConvention.CACHE_OPERATION))
}

@Test
Expand All @@ -113,7 +113,7 @@ class SentryJCacheWrapperTest {

wrapper.getAll(keys)

assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
}

// -- put --
Expand All @@ -131,8 +131,8 @@ class SentryJCacheWrapperTest {
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))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY))
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION))
}

// -- getAndPut --
Expand All @@ -149,7 +149,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("getAndPut", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
}

// -- putAll --
Expand All @@ -169,9 +169,9 @@ class SentryJCacheWrapperTest {
assertTrue(span.description!!.contains("k1"))
assertTrue(span.description!!.contains("k2"))
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY_KEY) as List<*>
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY) as List<*>
assertTrue(cacheKeys.containsAll(listOf("k1", "k2")))
assertEquals("putAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
assertEquals("putAll", span.getData(SpanDataConvention.CACHE_OPERATION))
}

// -- putIfAbsent --
Expand All @@ -191,8 +191,8 @@ class SentryJCacheWrapperTest {
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))
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY))
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION))
}

// -- replace --
Expand All @@ -212,7 +212,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION))
}

@Test
Expand All @@ -230,7 +230,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION))
}

// -- getAndReplace --
Expand All @@ -250,7 +250,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("getAndReplace", span.getData(SpanDataConvention.CACHE_OPERATION))
}

// -- remove(K) --
Expand All @@ -269,7 +269,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("remove", span.getData(SpanDataConvention.CACHE_OPERATION))
}

// -- remove(K, V) --
Expand All @@ -286,7 +286,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("remove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
}

// -- getAndRemove --
Expand All @@ -303,7 +303,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("getAndRemove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
}

// -- removeAll(Set) --
Expand All @@ -323,7 +323,7 @@ class SentryJCacheWrapperTest {
assertTrue(span.description!!.contains("k1"))
assertTrue(span.description!!.contains("k2"))
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
assertEquals("removeAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
assertEquals("removeAll", span.getData(SpanDataConvention.CACHE_OPERATION))
}

// -- removeAll() --
Expand All @@ -339,7 +339,7 @@ class SentryJCacheWrapperTest {
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))
assertEquals("removeAll", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
}

// -- clear --
Expand All @@ -357,8 +357,8 @@ class SentryJCacheWrapperTest {
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))
assertNull(span.getData(SpanDataConvention.CACHE_KEY))
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION))
}

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

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

// -- passthrough operations --
Expand Down
16 changes: 8 additions & 8 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 @@ -47,7 +47,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
}
try {
final ValueWrapper result = delegate.get(key);
span.setData(SpanDataConvention.CACHE_HIT_KEY, result != null);
span.setData(SpanDataConvention.CACHE_HIT, result != null);
span.setStatus(SpanStatus.OK);
return result;
} catch (Throwable e) {
Expand All @@ -67,7 +67,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
}
try {
final ValueWrapper wrapper = delegate.get(key);
span.setData(SpanDataConvention.CACHE_HIT_KEY, wrapper != null);
span.setData(SpanDataConvention.CACHE_HIT, wrapper != null);
final T result = delegate.get(key, type);
span.setStatus(SpanStatus.OK);
return result;
Expand Down Expand Up @@ -95,7 +95,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
loaderInvoked.set(true);
return valueLoader.call();
});
span.setData(SpanDataConvention.CACHE_HIT_KEY, !loaderInvoked.get());
span.setData(SpanDataConvention.CACHE_HIT, !loaderInvoked.get());
span.setData(SpanDataConvention.CACHE_WRITE, loaderInvoked.get());
span.setStatus(SpanStatus.OK);
return result;
Expand Down Expand Up @@ -124,7 +124,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
throw e;
}
if (result == null) {
span.setData(SpanDataConvention.CACHE_HIT_KEY, false);
span.setData(SpanDataConvention.CACHE_HIT, false);
span.setStatus(SpanStatus.OK);
span.finish();
return null;
Expand All @@ -135,7 +135,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(throwable);
} else {
span.setData(SpanDataConvention.CACHE_HIT_KEY, value != null);
span.setData(SpanDataConvention.CACHE_HIT, value != null);
span.setStatus(SpanStatus.OK);
}
span.finish();
Expand Down Expand Up @@ -171,7 +171,7 @@ public <T> CompletableFuture<T> retrieve(
span.setStatus(SpanStatus.INTERNAL_ERROR);
span.setThrowable(throwable);
} else {
span.setData(SpanDataConvention.CACHE_HIT_KEY, !loaderInvoked.get());
span.setData(SpanDataConvention.CACHE_HIT, !loaderInvoked.get());
span.setData(SpanDataConvention.CACHE_WRITE, loaderInvoked.get());
span.setStatus(SpanStatus.OK);
}
Expand Down Expand Up @@ -319,9 +319,9 @@ public boolean invalidate() {
return null;
}
if (keyString != null) {
span.setData(SpanDataConvention.CACHE_KEY_KEY, Arrays.asList(keyString));
span.setData(SpanDataConvention.CACHE_KEY, Arrays.asList(keyString));
}
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
span.setData(SpanDataConvention.CACHE_OPERATION, operationName);
return span;
}
}
Loading
Loading