Add metrics value owner for metrics topN query result (#12737)

wankai123 · web-flow · commit 39b579f3aef2 · 2024-11-01T15:30:42.000+08:00
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
@@ -13,6 +13,7 @@
 * Support Kong monitoring.
 * Support adding additional attr[0-4] for service level metrics.
 * Support async-profiler feature for performance analysis.
+* Add metrics value owner for metrics topN query result.
 
 #### UI
 
diff --git a/oap-server/mqe-rt/src/main/java/org/apache/skywalking/mqe/rt/type/MQEValue.java b/oap-server/mqe-rt/src/main/java/org/apache/skywalking/mqe/rt/type/MQEValue.java
@@ -20,10 +20,12 @@
 package org.apache.skywalking.mqe.rt.type;
 
 import lombok.Data;
+import org.apache.skywalking.oap.server.core.query.type.Owner;
 
 @Data
 public class MQEValue {
     private String id;
+    private Owner owner;
     private String value;
     private String traceID;
 
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/query/AggregationQueryService.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/query/AggregationQueryService.java
@@ -22,6 +22,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import org.apache.skywalking.oap.server.core.query.type.Owner;
 import org.apache.skywalking.oap.server.core.query.type.debugging.DebuggingSpan;
 import org.apache.skywalking.oap.server.core.query.type.debugging.DebuggingTraceContext;
 import org.apache.skywalking.oap.server.library.util.StringUtil;
@@ -72,38 +73,56 @@ private List<SelectedRecord> invokeSortMetrics(TopNCondition condition, Duration
         final List<SelectedRecord> selectedRecords = getAggregationQueryDAO().sortMetricsDebuggable(
             condition, valueCName, duration, additionalConditions);
         selectedRecords.forEach(selectedRecord -> {
+            Owner owner = new Owner();
+            owner.setScope(condition.getScope());
+            selectedRecord.setOwner(owner);
             switch (condition.getScope()) {
                 case Service:
-                    selectedRecord.setName(IDManager.ServiceID.analysisId(selectedRecord.getId()).getName());
+                    final IDManager.ServiceID.ServiceIDDefinition serviceIDDefinition
+                        = IDManager.ServiceID.analysisId(selectedRecord.getId());
+                    selectedRecord.setName(serviceIDDefinition.getName());
+                    owner.setServiceID(selectedRecord.getId());
+                    owner.setServiceName(serviceIDDefinition.getName());
+                    owner.setNormal(serviceIDDefinition.isReal());
                     break;
                 case ServiceInstance:
                     final IDManager.ServiceInstanceID.InstanceIDDefinition instanceIDDefinition
                         = IDManager.ServiceInstanceID.analysisId(selectedRecord.getId());
+                    final IDManager.ServiceID.ServiceIDDefinition instanceServiceIDDefinition =
+                        IDManager.ServiceID.analysisId(instanceIDDefinition.getServiceId());
                     /*
                      * Add the service name into the name if this is global top N.
                      */
                     if (StringUtil.isEmpty(condition.getParentService())) {
-                        IDManager.ServiceID.ServiceIDDefinition serviceIDDefinition =
-                            IDManager.ServiceID.analysisId(instanceIDDefinition.getServiceId());
-                        selectedRecord.setName(serviceIDDefinition.getName() + " - " + instanceIDDefinition.getName());
+                        selectedRecord.setName(instanceServiceIDDefinition.getName() + " - " + instanceIDDefinition.getName());
                     } else {
                         selectedRecord.setName(instanceIDDefinition.getName());
                     }
+                    owner.setServiceID(instanceIDDefinition.getServiceId());
+                    owner.setServiceName(instanceServiceIDDefinition.getName());
+                    owner.setNormal(instanceServiceIDDefinition.isReal());
+                    owner.setServiceInstanceID(selectedRecord.getId());
+                    owner.setServiceInstanceName(instanceIDDefinition.getName());
                     break;
                 case Endpoint:
                     final IDManager.EndpointID.EndpointIDDefinition endpointIDDefinition
                         = IDManager.EndpointID.analysisId(selectedRecord.getId());
+                    final IDManager.ServiceID.ServiceIDDefinition endpointServiceIDDefinition =
+                        IDManager.ServiceID.analysisId(endpointIDDefinition.getServiceId());
                     /*
                      * Add the service name into the name if this is global top N.
                      */
                     if (StringUtil.isEmpty(condition.getParentService())) {
-                        IDManager.ServiceID.ServiceIDDefinition serviceIDDefinition =
-                            IDManager.ServiceID.analysisId(endpointIDDefinition.getServiceId());
-                        selectedRecord.setName(serviceIDDefinition.getName()
+                        selectedRecord.setName(endpointServiceIDDefinition.getName()
                                                    + " - " + endpointIDDefinition.getEndpointName());
                     } else {
                         selectedRecord.setName(endpointIDDefinition.getEndpointName());
                     }
+                    owner.setServiceID(endpointIDDefinition.getServiceId());
+                    owner.setServiceName(endpointServiceIDDefinition.getName());
+                    owner.setNormal(endpointServiceIDDefinition.isReal());
+                    owner.setEndpointID(selectedRecord.getId());
+                    owner.setEndpointName(endpointIDDefinition.getEndpointName());
                     break;
                 default:
                     selectedRecord.setName(Const.UNKNOWN);
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/query/type/Owner.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/query/type/Owner.java
@@ -0,0 +1,34 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.apache.skywalking.oap.server.core.query.type;
+
+import lombok.Data;
+import org.apache.skywalking.oap.server.core.query.enumeration.Scope;
+
+@Data
+public class Owner {
+    private Scope scope;
+    private String serviceID;
+    private String serviceName;
+    private Boolean normal;
+    private String serviceInstanceID;
+    private String serviceInstanceName;
+    private String endpointID;
+    private String endpointName;
+}
diff --git a/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/query/type/SelectedRecord.java b/oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/query/type/SelectedRecord.java
@@ -43,4 +43,8 @@ public class SelectedRecord {
      * Have value, Only if the record has related trace id. UI should show this as an attached value.
      */
     private String refId;
+    /**
+     * The owner entity of this record.
+     */
+    private Owner owner;
 }
diff --git a/oap-server/server-query-plugin/query-graphql-plugin/src/main/java/org/apache/skywalking/oap/query/graphql/mqe/rt/MQEVisitor.java b/oap-server/server-query-plugin/query-graphql-plugin/src/main/java/org/apache/skywalking/oap/query/graphql/mqe/rt/MQEVisitor.java
@@ -217,6 +217,7 @@ private void querySortMetrics(String metricName,
             mqeValue.setId(selectedRecord.getName());
             mqeValue.setEmptyValue(false);
             mqeValue.setDoubleValue(Double.parseDouble(selectedRecord.getValue()));
+            mqeValue.setOwner(selectedRecord.getOwner());
             mqeValueList.add(mqeValue);
         });
         MQEValues mqeValues = new MQEValues();
diff --git a/oap-server/server-query-plugin/query-graphql-plugin/src/main/resources/query-protocol b/oap-server/server-query-plugin/query-graphql-plugin/src/main/resources/query-protocol
@@ -1 +1 @@
-Subproject commit 0f44eff1ae1cbe4f26835e41502347f7b14541e9
+Subproject commit 3b838aea1efa17ce084c6724bd4fa9f9d2133edd

Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,8 @@ public class SelectedRecord {`
`43`	`43`	`* Have value, Only if the record has related trace id. UI should show this as an attached value.`
`44`	`44`	`*/`
`45`	`45`	`private String refId;`
	`46`	`+ /**`
	`47`	`+ * The owner entity of this record.`
	`48`	`+ */`
	`49`	`+ private Owner owner;`
`46`	`50`	`}`