[incubator-skywalking] branch feature/trace-ui updated: Add comments for new trace query protocol.

[wu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch feature/trace-ui
in repository https://gitbox.apache.org/repos/asf/incubator-skywalking.git


The following commit(s) were added to refs/heads/feature/trace-ui by this push:
     new 82f294d  Add comments for new trace query protocol.
82f294d is described below

commit 82f294db80d90c9ee4378aafde8ad1213df22d1c
Author: wu-sheng <wu...@foxmail.com>
AuthorDate: Wed Apr 18 10:00:25 2018 +0800

    Add comments for new trace query protocol.
---
 .../apm-ui-protocol/src/main/resources/ui-graphql/trace.graphqls | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/apm-protocol/apm-ui-protocol/src/main/resources/ui-graphql/trace.graphqls b/apm-protocol/apm-ui-protocol/src/main/resources/ui-graphql/trace.graphqls
index c14b032..8b7bc03 100644
--- a/apm-protocol/apm-ui-protocol/src/main/resources/ui-graphql/trace.graphqls
+++ b/apm-protocol/apm-ui-protocol/src/main/resources/ui-graphql/trace.graphqls
@@ -61,10 +61,14 @@ type Trace {
 type Segment {
   segmentId: ID!
   applicationCode: ID!
+  # The segment name, which should be named by Entry span operation name, or the first span operation name when no Entry span
   name: String!
+  # Brief includes all outside service info, also could be understood as a brief of all Exit spans.
   brief: SegmentBrief!
   spans: [Span!]!
+  # True if exist an error in the all spans
   isError: Boolean
+  # The real duration of this segment, exclude all outside services' duration.
   # Unit: milliseconds
   duration: Long!
 }
@@ -77,14 +81,19 @@ type SegmentBrief {
   cache: BriefInfo!
 }
 
+# Brief info includes metrics of the certain layer type
 type BriefInfo {
+  # The number of this layer calls
   count: Int!
+  # The duration of all calls in this layer.
   duration: Long!
 }
 
 type SegmentRef {
   sourceSegment: ID!
   targetSegment: ID!
+  # Layer type of this across process segment call.
+  # Or `Cross Thread`.
   callType: String!
 }
 

-- 
To stop receiving notification emails like this one, please contact
wusheng@apache.org.