Skip to content

Commit 518e465

Browse files
adinauerclaude
andcommitted
ref(cache): Remove _KEY suffix from cache SpanDataConvention constants
Rename CACHE_HIT_KEY, CACHE_KEY_KEY, and CACHE_OPERATION_KEY to CACHE_HIT, CACHE_KEY, and CACHE_OPERATION to match the newer naming convention used by CACHE_WRITE, THREAD_ID, FRAMES_TOTAL, etc. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 867c67e commit 518e465

File tree

10 files changed

+124
-124
lines changed

10 files changed

+124
-124
lines changed

sentry-jcache/src/main/java/io/sentry/jcache/SentryJCacheWrapper.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public V get(final K key) {
5757
}
5858
try {
5959
final V result = delegate.get(key);
60-
span.setData(SpanDataConvention.CACHE_HIT_KEY, result != null);
60+
span.setData(SpanDataConvention.CACHE_HIT, result != null);
6161
span.setStatus(SpanStatus.OK);
6262
return result;
6363
} catch (Throwable e) {
@@ -77,7 +77,7 @@ public Map<K, V> getAll(final Set<? extends K> keys) {
7777
}
7878
try {
7979
final Map<K, V> result = delegate.getAll(keys);
80-
span.setData(SpanDataConvention.CACHE_HIT_KEY, !result.isEmpty());
80+
span.setData(SpanDataConvention.CACHE_HIT, !result.isEmpty());
8181
span.setStatus(SpanStatus.OK);
8282
return result;
8383
} catch (Throwable e) {
@@ -497,9 +497,9 @@ public Iterator<Entry<K, V>> iterator() {
497497
return null;
498498
}
499499
if (cacheKeys != null) {
500-
span.setData(SpanDataConvention.CACHE_KEY_KEY, cacheKeys);
500+
span.setData(SpanDataConvention.CACHE_KEY, cacheKeys);
501501
}
502-
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
502+
span.setData(SpanDataConvention.CACHE_OPERATION, operationName);
503503
return span;
504504
}
505505
}

sentry-jcache/src/test/kotlin/io/sentry/jcache/SentryJCacheWrapperTest.kt

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ class SentryJCacheWrapperTest {
6161
assertEquals("cache.get", span.operation)
6262
assertEquals("myKey", span.description)
6363
assertEquals(SpanStatus.OK, span.status)
64-
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
64+
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT))
6565
assertNull(span.getData(SpanDataConvention.CACHE_WRITE))
66-
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
66+
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY))
6767
assertEquals("auto.cache.jcache", span.spanContext.origin)
68-
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
68+
assertEquals("get", span.getData(SpanDataConvention.CACHE_OPERATION))
6969
}
7070

7171
@Test
@@ -78,7 +78,7 @@ class SentryJCacheWrapperTest {
7878

7979
assertNull(result)
8080
assertEquals(1, tx.spans.size)
81-
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
81+
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
8282
}
8383

8484
// -- getAll --
@@ -98,10 +98,10 @@ class SentryJCacheWrapperTest {
9898
assertEquals("cache.getAll", span.operation)
9999
assertTrue(span.description!!.contains("k1"))
100100
assertTrue(span.description!!.contains("k2"))
101-
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT_KEY))
102-
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY_KEY) as List<*>
101+
assertEquals(true, span.getData(SpanDataConvention.CACHE_HIT))
102+
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY) as List<*>
103103
assertTrue(cacheKeys.containsAll(listOf("k1", "k2")))
104-
assertEquals("getAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
104+
assertEquals("getAll", span.getData(SpanDataConvention.CACHE_OPERATION))
105105
}
106106

107107
@Test
@@ -113,7 +113,7 @@ class SentryJCacheWrapperTest {
113113

114114
wrapper.getAll(keys)
115115

116-
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT_KEY))
116+
assertEquals(false, tx.spans.first().getData(SpanDataConvention.CACHE_HIT))
117117
}
118118

119119
// -- put --
@@ -131,8 +131,8 @@ class SentryJCacheWrapperTest {
131131
assertEquals("cache.put", span.operation)
132132
assertEquals(SpanStatus.OK, span.status)
133133
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
134-
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
135-
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
134+
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY))
135+
assertEquals("put", span.getData(SpanDataConvention.CACHE_OPERATION))
136136
}
137137

138138
// -- getAndPut --
@@ -149,7 +149,7 @@ class SentryJCacheWrapperTest {
149149
assertEquals(1, tx.spans.size)
150150
assertEquals("cache.getAndPut", tx.spans.first().operation)
151151
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
152-
assertEquals("getAndPut", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
152+
assertEquals("getAndPut", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
153153
}
154154

155155
// -- putAll --
@@ -169,9 +169,9 @@ class SentryJCacheWrapperTest {
169169
assertTrue(span.description!!.contains("k1"))
170170
assertTrue(span.description!!.contains("k2"))
171171
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
172-
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY_KEY) as List<*>
172+
val cacheKeys = span.getData(SpanDataConvention.CACHE_KEY) as List<*>
173173
assertTrue(cacheKeys.containsAll(listOf("k1", "k2")))
174-
assertEquals("putAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
174+
assertEquals("putAll", span.getData(SpanDataConvention.CACHE_OPERATION))
175175
}
176176

177177
// -- putIfAbsent --
@@ -191,8 +191,8 @@ class SentryJCacheWrapperTest {
191191
assertEquals("cache.putIfAbsent", span.operation)
192192
assertEquals(SpanStatus.OK, span.status)
193193
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
194-
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY_KEY))
195-
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
194+
assertEquals(listOf("myKey"), span.getData(SpanDataConvention.CACHE_KEY))
195+
assertEquals("putIfAbsent", span.getData(SpanDataConvention.CACHE_OPERATION))
196196
}
197197

198198
// -- replace --
@@ -212,7 +212,7 @@ class SentryJCacheWrapperTest {
212212
assertEquals("cache.replace", span.operation)
213213
assertEquals(SpanStatus.OK, span.status)
214214
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
215-
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
215+
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION))
216216
}
217217

218218
@Test
@@ -230,7 +230,7 @@ class SentryJCacheWrapperTest {
230230
assertEquals("cache.replace", span.operation)
231231
assertEquals(SpanStatus.OK, span.status)
232232
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
233-
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
233+
assertEquals("replace", span.getData(SpanDataConvention.CACHE_OPERATION))
234234
}
235235

236236
// -- getAndReplace --
@@ -250,7 +250,7 @@ class SentryJCacheWrapperTest {
250250
assertEquals("cache.getAndReplace", span.operation)
251251
assertEquals(SpanStatus.OK, span.status)
252252
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
253-
assertEquals("getAndReplace", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
253+
assertEquals("getAndReplace", span.getData(SpanDataConvention.CACHE_OPERATION))
254254
}
255255

256256
// -- remove(K) --
@@ -269,7 +269,7 @@ class SentryJCacheWrapperTest {
269269
assertEquals("cache.remove", span.operation)
270270
assertEquals(SpanStatus.OK, span.status)
271271
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
272-
assertEquals("remove", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
272+
assertEquals("remove", span.getData(SpanDataConvention.CACHE_OPERATION))
273273
}
274274

275275
// -- remove(K, V) --
@@ -286,7 +286,7 @@ class SentryJCacheWrapperTest {
286286
assertEquals(1, tx.spans.size)
287287
assertEquals("cache.remove", tx.spans.first().operation)
288288
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
289-
assertEquals("remove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
289+
assertEquals("remove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
290290
}
291291

292292
// -- getAndRemove --
@@ -303,7 +303,7 @@ class SentryJCacheWrapperTest {
303303
assertEquals(1, tx.spans.size)
304304
assertEquals("cache.getAndRemove", tx.spans.first().operation)
305305
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
306-
assertEquals("getAndRemove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
306+
assertEquals("getAndRemove", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
307307
}
308308

309309
// -- removeAll(Set) --
@@ -323,7 +323,7 @@ class SentryJCacheWrapperTest {
323323
assertTrue(span.description!!.contains("k1"))
324324
assertTrue(span.description!!.contains("k2"))
325325
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
326-
assertEquals("removeAll", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
326+
assertEquals("removeAll", span.getData(SpanDataConvention.CACHE_OPERATION))
327327
}
328328

329329
// -- removeAll() --
@@ -339,7 +339,7 @@ class SentryJCacheWrapperTest {
339339
assertEquals(1, tx.spans.size)
340340
assertEquals("cache.removeAll", tx.spans.first().operation)
341341
assertEquals(true, tx.spans.first().getData(SpanDataConvention.CACHE_WRITE))
342-
assertEquals("removeAll", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
342+
assertEquals("removeAll", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
343343
}
344344

345345
// -- clear --
@@ -357,8 +357,8 @@ class SentryJCacheWrapperTest {
357357
assertEquals("cache.clear", span.operation)
358358
assertEquals(SpanStatus.OK, span.status)
359359
assertEquals(true, span.getData(SpanDataConvention.CACHE_WRITE))
360-
assertNull(span.getData(SpanDataConvention.CACHE_KEY_KEY))
361-
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION_KEY))
360+
assertNull(span.getData(SpanDataConvention.CACHE_KEY))
361+
assertEquals("clear", span.getData(SpanDataConvention.CACHE_OPERATION))
362362
}
363363

364364
// -- invoke --
@@ -375,7 +375,7 @@ class SentryJCacheWrapperTest {
375375
assertEquals("result", result)
376376
assertEquals(1, tx.spans.size)
377377
assertEquals("cache.invoke", tx.spans.first().operation)
378-
assertEquals("invoke", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
378+
assertEquals("invoke", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
379379
}
380380

381381
// -- invokeAll --
@@ -394,7 +394,7 @@ class SentryJCacheWrapperTest {
394394
assertEquals(resultMap, result)
395395
assertEquals(1, tx.spans.size)
396396
assertEquals("cache.invokeAll", tx.spans.first().operation)
397-
assertEquals("invokeAll", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION_KEY))
397+
assertEquals("invokeAll", tx.spans.first().getData(SpanDataConvention.CACHE_OPERATION))
398398
}
399399

400400
// -- passthrough operations --

sentry-spring-7/src/main/java/io/sentry/spring7/cache/SentryCacheWrapper.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
4747
}
4848
try {
4949
final ValueWrapper result = delegate.get(key);
50-
span.setData(SpanDataConvention.CACHE_HIT_KEY, result != null);
50+
span.setData(SpanDataConvention.CACHE_HIT, result != null);
5151
span.setStatus(SpanStatus.OK);
5252
return result;
5353
} catch (Throwable e) {
@@ -67,7 +67,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
6767
}
6868
try {
6969
final ValueWrapper wrapper = delegate.get(key);
70-
span.setData(SpanDataConvention.CACHE_HIT_KEY, wrapper != null);
70+
span.setData(SpanDataConvention.CACHE_HIT, wrapper != null);
7171
final T result = delegate.get(key, type);
7272
span.setStatus(SpanStatus.OK);
7373
return result;
@@ -95,7 +95,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
9595
loaderInvoked.set(true);
9696
return valueLoader.call();
9797
});
98-
span.setData(SpanDataConvention.CACHE_HIT_KEY, !loaderInvoked.get());
98+
span.setData(SpanDataConvention.CACHE_HIT, !loaderInvoked.get());
9999
span.setData(SpanDataConvention.CACHE_WRITE, loaderInvoked.get());
100100
span.setStatus(SpanStatus.OK);
101101
return result;
@@ -124,7 +124,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
124124
throw e;
125125
}
126126
if (result == null) {
127-
span.setData(SpanDataConvention.CACHE_HIT_KEY, false);
127+
span.setData(SpanDataConvention.CACHE_HIT, false);
128128
span.setStatus(SpanStatus.OK);
129129
span.finish();
130130
return null;
@@ -135,7 +135,7 @@ public SentryCacheWrapper(final @NotNull Cache delegate, final @NotNull IScopes
135135
span.setStatus(SpanStatus.INTERNAL_ERROR);
136136
span.setThrowable(throwable);
137137
} else {
138-
span.setData(SpanDataConvention.CACHE_HIT_KEY, value != null);
138+
span.setData(SpanDataConvention.CACHE_HIT, value != null);
139139
span.setStatus(SpanStatus.OK);
140140
}
141141
span.finish();
@@ -171,7 +171,7 @@ public <T> CompletableFuture<T> retrieve(
171171
span.setStatus(SpanStatus.INTERNAL_ERROR);
172172
span.setThrowable(throwable);
173173
} else {
174-
span.setData(SpanDataConvention.CACHE_HIT_KEY, !loaderInvoked.get());
174+
span.setData(SpanDataConvention.CACHE_HIT, !loaderInvoked.get());
175175
span.setData(SpanDataConvention.CACHE_WRITE, loaderInvoked.get());
176176
span.setStatus(SpanStatus.OK);
177177
}
@@ -319,9 +319,9 @@ public boolean invalidate() {
319319
return null;
320320
}
321321
if (keyString != null) {
322-
span.setData(SpanDataConvention.CACHE_KEY_KEY, Arrays.asList(keyString));
322+
span.setData(SpanDataConvention.CACHE_KEY, Arrays.asList(keyString));
323323
}
324-
span.setData(SpanDataConvention.CACHE_OPERATION_KEY, operationName);
324+
span.setData(SpanDataConvention.CACHE_OPERATION, operationName);
325325
return span;
326326
}
327327
}

0 commit comments

Comments
 (0)