Fix inconsistent virtual cache describe between code and scope definitions doc (#9663)
diff --git a/docs/en/concepts-and-designs/scope-definitions.md b/docs/en/concepts-and-designs/scope-definitions.md
index 7456146..b1358e9 100644
--- a/docs/en/concepts-and-designs/scope-definitions.md
+++ b/docs/en/concepts-and-designs/scope-definitions.md
@@ -315,7 +315,7 @@
| cacheTypeId | The ID of the component used in this call. | | int |
| latency | The time taken by each request. | | int(in ms)|
| status | Indicates the success or failure of the request.| | boolean |
-| op | Indicates this access is used for `write` or `read` | | string |
+| operation | Indicates this access is used for `write` or `read` | | string |
### SCOPE `CacheSlowAccess`
@@ -330,4 +330,4 @@
| latency | The time taken by each request. | | int(in ms)|
| traceId | The traceId of this slow access| | string|
| status | Indicates the success or failure of the request.| | boolean |
-| op | Indicates this access is used for `write` or `read` | | string |
\ No newline at end of file
+| operation | Indicates this access is used for `write` or `read` | | string |
\ No newline at end of file
diff --git a/oap-server/analyzer/agent-analyzer/src/main/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessor.java b/oap-server/analyzer/agent-analyzer/src/main/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessor.java
index c550ed3..de67db0 100644
--- a/oap-server/analyzer/agent-analyzer/src/main/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessor.java
+++ b/oap-server/analyzer/agent-analyzer/src/main/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessor.java
@@ -37,9 +37,9 @@
import org.apache.skywalking.oap.server.core.config.NamingControl;
import org.apache.skywalking.oap.server.core.source.ServiceMeta;
import org.apache.skywalking.oap.server.core.source.Source;
-import org.apache.skywalking.oap.server.core.source.VirtualCacheAccess;
+import org.apache.skywalking.oap.server.core.source.CacheAccess;
import org.apache.skywalking.oap.server.core.source.VirtualCacheOperation;
-import org.apache.skywalking.oap.server.core.source.VirtualCacheSlowAccess;
+import org.apache.skywalking.oap.server.core.source.CacheSlowAccess;
import org.apache.skywalking.oap.server.library.util.StringUtil;
@Slf4j
@@ -80,7 +80,7 @@
.getThreshold(cacheType))
|| (op == VirtualCacheOperation.Read && latency > config.getCacheReadLatencyThresholdsAndWatcher()
.getThreshold(cacheType))) {
- VirtualCacheSlowAccess slowAccess = new VirtualCacheSlowAccess();
+ CacheSlowAccess slowAccess = new CacheSlowAccess();
slowAccess.setCacheServiceId(IDManager.ServiceID.buildId(serviceName, false));
slowAccess.setLatency(latency);
slowAccess.setId(segmentObject.getTraceSegmentId() + "-" + span.getSpanId());
@@ -92,7 +92,7 @@
slowAccess.setOperation(op);
sourceList.add(slowAccess);
}
- VirtualCacheAccess access = new VirtualCacheAccess();
+ CacheAccess access = new CacheAccess();
access.setCacheTypeId(span.getComponentId());
access.setLatency(latency);
access.setName(serviceName);
diff --git a/oap-server/analyzer/agent-analyzer/src/test/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessorTest.java b/oap-server/analyzer/agent-analyzer/src/test/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessorTest.java
index d72754e..5527143 100644
--- a/oap-server/analyzer/agent-analyzer/src/test/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessorTest.java
+++ b/oap-server/analyzer/agent-analyzer/src/test/java/org/apache/skywalking/oap/server/analyzer/provider/trace/parser/listener/vservice/VirtualCacheProcessorTest.java
@@ -36,9 +36,9 @@
import org.apache.skywalking.oap.server.core.config.group.EndpointNameGrouping;
import org.apache.skywalking.oap.server.core.source.ServiceMeta;
import org.apache.skywalking.oap.server.core.source.Source;
-import org.apache.skywalking.oap.server.core.source.VirtualCacheAccess;
+import org.apache.skywalking.oap.server.core.source.CacheAccess;
import org.apache.skywalking.oap.server.core.source.VirtualCacheOperation;
-import org.apache.skywalking.oap.server.core.source.VirtualCacheSlowAccess;
+import org.apache.skywalking.oap.server.core.source.CacheSlowAccess;
import org.joda.time.DateTime;
import org.joda.time.format.DateTimeFormat;
import org.junit.Assert;
@@ -81,7 +81,7 @@
Assert.assertEquals(202209121413L, serviceMeta.getTimeBucket());
Assert.assertEquals(Layer.VIRTUAL_CACHE, serviceMeta.getLayer());
- VirtualCacheSlowAccess slowAccess = (VirtualCacheSlowAccess) sources.get(1);
+ CacheSlowAccess slowAccess = (CacheSlowAccess) sources.get(1);
Assert.assertEquals("MTI3LjAuMC4xOjYzNzk=.0", slowAccess.getCacheServiceId());
Assert.assertEquals(1000, slowAccess.getLatency());
Assert.assertEquals(20220912141312L, slowAccess.getTimeBucket());
@@ -90,7 +90,7 @@
Assert.assertNotNull(slowAccess.getCommand());
Assert.assertNotNull(slowAccess.getKey());
- VirtualCacheAccess cacheAccess = (VirtualCacheAccess) sources.get(2);
+ CacheAccess cacheAccess = (CacheAccess) sources.get(2);
Assert.assertEquals("127.0.0.1:6379", cacheAccess.getName());
Assert.assertEquals(1000, cacheAccess.getLatency());
Assert.assertEquals(202209121413L, cacheAccess.getTimeBucket());
@@ -121,7 +121,7 @@
Assert.assertEquals(202209121413L, serviceMeta.getTimeBucket());
Assert.assertEquals(Layer.VIRTUAL_CACHE, serviceMeta.getLayer());
- VirtualCacheAccess cacheAccess = (VirtualCacheAccess) sources.get(1);
+ CacheAccess cacheAccess = (CacheAccess) sources.get(1);
Assert.assertEquals("127.0.0.1:6379", cacheAccess.getName());
Assert.assertEquals(3, cacheAccess.getLatency());
Assert.assertEquals(202209121413L, cacheAccess.getTimeBucket());
@@ -150,7 +150,7 @@
Assert.assertEquals(202209121413L, serviceMeta.getTimeBucket());
Assert.assertEquals(Layer.VIRTUAL_CACHE, serviceMeta.getLayer());
- VirtualCacheSlowAccess slowAccess = (VirtualCacheSlowAccess) sources.get(1);
+ CacheSlowAccess slowAccess = (CacheSlowAccess) sources.get(1);
Assert.assertEquals("cmVkaXMtbG9jYWw=.0", slowAccess.getCacheServiceId());
Assert.assertEquals(1000, slowAccess.getLatency());
Assert.assertEquals(20220912141312L, slowAccess.getTimeBucket());
@@ -159,7 +159,7 @@
Assert.assertNotNull(slowAccess.getCommand());
Assert.assertNotNull(slowAccess.getKey());
- VirtualCacheAccess cacheAccess = (VirtualCacheAccess) sources.get(2);
+ CacheAccess cacheAccess = (CacheAccess) sources.get(2);
Assert.assertEquals("redis-local", cacheAccess.getName());
Assert.assertEquals(1000, cacheAccess.getLatency());
Assert.assertEquals(202209121413L, cacheAccess.getTimeBucket());
diff --git a/oap-server/oal-grammar/src/main/antlr4/org/apache/skywalking/oal/rt/grammar/OALLexer.g4 b/oap-server/oal-grammar/src/main/antlr4/org/apache/skywalking/oal/rt/grammar/OALLexer.g4
index 655439d..5d39a4b 100644
--- a/oap-server/oal-grammar/src/main/antlr4/org/apache/skywalking/oal/rt/grammar/OALLexer.g4
+++ b/oap-server/oal-grammar/src/main/antlr4/org/apache/skywalking/oal/rt/grammar/OALLexer.g4
@@ -45,7 +45,7 @@
SRC_SERVICE_INSTANCE_CLR_THREAD: 'ServiceInstanceCLRThread';
SRC_ENVOY_INSTANCE_METRIC: 'EnvoyInstanceMetric';
SRC_EVENT: 'Event';
-SRC_CACHE_ACCESS: 'VirtualCacheAccess';
+SRC_CACHE_ACCESS: 'CacheAccess';
// Browser keywords
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/cache/CacheSlowAccessDispatcher.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/cache/CacheSlowAccessDispatcher.java
index 5d5e412..8d95209 100644
--- a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/cache/CacheSlowAccessDispatcher.java
+++ b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/manual/cache/CacheSlowAccessDispatcher.java
@@ -21,12 +21,12 @@
import org.apache.skywalking.oap.server.core.analysis.SourceDispatcher;
import org.apache.skywalking.oap.server.core.analysis.worker.TopNStreamProcessor;
import org.apache.skywalking.oap.server.core.source.VirtualCacheOperation;
-import org.apache.skywalking.oap.server.core.source.VirtualCacheSlowAccess;
+import org.apache.skywalking.oap.server.core.source.CacheSlowAccess;
-public class CacheSlowAccessDispatcher implements SourceDispatcher<VirtualCacheSlowAccess> {
+public class CacheSlowAccessDispatcher implements SourceDispatcher<CacheSlowAccess> {
@Override
- public void dispatch(VirtualCacheSlowAccess source) {
+ public void dispatch(CacheSlowAccess source) {
// There are only two kinds of Operation : write or read .Refer VirtualCacheProcessor#prepareVSIfNecessary
if (source.getOperation() == VirtualCacheOperation.Read) {
TopNCacheReadCommand readCommand = new TopNCacheReadCommand();
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/VirtualCacheAccess.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/CacheAccess.java
similarity index 92%
rename from oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/VirtualCacheAccess.java
rename to oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/CacheAccess.java
index 73b14f7..0f292db 100644
--- a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/VirtualCacheAccess.java
+++ b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/CacheAccess.java
@@ -25,9 +25,9 @@
import static org.apache.skywalking.oap.server.core.source.DefaultScopeDefine.CACHE_ACCESS;
import static org.apache.skywalking.oap.server.core.source.DefaultScopeDefine.SERVICE_CATALOG_NAME;
-@ScopeDeclaration(id = CACHE_ACCESS, name = "VirtualCacheAccess", catalog = SERVICE_CATALOG_NAME)
+@ScopeDeclaration(id = CACHE_ACCESS, name = "CacheAccess", catalog = SERVICE_CATALOG_NAME)
@ScopeDefaultColumn.VirtualColumnDefinition(fieldName = "entityId", columnName = "entity_id", isID = true, type = String.class)
-public class VirtualCacheAccess extends Source {
+public class CacheAccess extends Source {
@Override
public int scope() {
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/VirtualCacheSlowAccess.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/CacheSlowAccess.java
similarity index 97%
rename from oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/VirtualCacheSlowAccess.java
rename to oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/CacheSlowAccess.java
index 863102e..420ad4b 100644
--- a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/VirtualCacheSlowAccess.java
+++ b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/source/CacheSlowAccess.java
@@ -26,7 +26,7 @@
import static org.apache.skywalking.oap.server.core.source.DefaultScopeDefine.SERVICE_CATALOG_NAME;
@ScopeDeclaration(id = CACHE_SLOW_ACCESS, name = "VirtualCacheSlowAccess", catalog = SERVICE_CATALOG_NAME)
-public class VirtualCacheSlowAccess extends Source {
+public class CacheSlowAccess extends Source {
@Getter
@Setter
private String id;
diff --git a/oap-server/server-starter/src/main/resources/oal/core.oal b/oap-server/server-starter/src/main/resources/oal/core.oal
index 3bf7757..10ed0a9 100755
--- a/oap-server/server-starter/src/main/resources/oal/core.oal
+++ b/oap-server/server-starter/src/main/resources/oal/core.oal
@@ -72,17 +72,17 @@
database_access_cpm = from(DatabaseAccess.*).cpm();
database_access_percentile = from(DatabaseAccess.latency).percentile(10);
-cache_read_resp_time = from(VirtualCacheAccess.latency).filter(operation == VirtualCacheOperation.Read).longAvg();
-cache_read_sla = from(VirtualCacheAccess.*).filter(operation == VirtualCacheOperation.Read).percent(status == true);
-cache_read_cpm = from(VirtualCacheAccess.*).filter(operation == VirtualCacheOperation.Read).cpm();
-cache_read_percentile = from(VirtualCacheAccess.latency).filter(operation == VirtualCacheOperation.Read).percentile(10);
+cache_read_resp_time = from(CacheAccess.latency).filter(operation == VirtualCacheOperation.Read).longAvg();
+cache_read_sla = from(CacheAccess.*).filter(operation == VirtualCacheOperation.Read).percent(status == true);
+cache_read_cpm = from(CacheAccess.*).filter(operation == VirtualCacheOperation.Read).cpm();
+cache_read_percentile = from(CacheAccess.latency).filter(operation == VirtualCacheOperation.Read).percentile(10);
-cache_write_resp_time = from(VirtualCacheAccess.latency).filter(operation == VirtualCacheOperation.Write).longAvg();
-cache_write_sla = from(VirtualCacheAccess.*).filter(operation == VirtualCacheOperation.Write).percent(status == true);
-cache_write_cpm = from(VirtualCacheAccess.*).filter(operation == VirtualCacheOperation.Write).cpm();
-cache_write_percentile = from(VirtualCacheAccess.latency).filter(operation == VirtualCacheOperation.Write).percentile(10);
+cache_write_resp_time = from(CacheAccess.latency).filter(operation == VirtualCacheOperation.Write).longAvg();
+cache_write_sla = from(CacheAccess.*).filter(operation == VirtualCacheOperation.Write).percent(status == true);
+cache_write_cpm = from(CacheAccess.*).filter(operation == VirtualCacheOperation.Write).cpm();
+cache_write_percentile = from(CacheAccess.latency).filter(operation == VirtualCacheOperation.Write).percentile(10);
-cache_access_resp_time = from(VirtualCacheAccess.latency).longAvg();
-cache_access_sla = from(VirtualCacheAccess.*).percent(status == true);
-cache_access_cpm = from(VirtualCacheAccess.*).cpm();
-cache_access_percentile = from(VirtualCacheAccess.latency).percentile(10);
\ No newline at end of file
+cache_access_resp_time = from(CacheAccess.latency).longAvg();
+cache_access_sla = from(CacheAccess.*).percent(status == true);
+cache_access_cpm = from(CacheAccess.*).cpm();
+cache_access_percentile = from(CacheAccess.latency).percentile(10);
\ No newline at end of file
