You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2020/01/30 08:41:44 UTC

[skywalking] 01/01: Move the comment of the duration into the doc.

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

wusheng pushed a commit to branch doc
in repository https://gitbox.apache.org/repos/asf/skywalking.git

commit 78311c3b02c989ae4207b90b4c630d9d31d20f9e
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Thu Jan 30 16:41:26 2020 +0800

    Move the comment of the duration into the doc.
---
 docs/en/protocols/query-protocol.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/docs/en/protocols/query-protocol.md b/docs/en/protocols/query-protocol.md
index 4beefb4..fdfe9a1 100644
--- a/docs/en/protocols/query-protocol.md
+++ b/docs/en/protocols/query-protocol.md
@@ -101,3 +101,40 @@ The following query(s) are for specific features, including trace, alarm or prof
 
 The actual query GraphQL scrips could be found inside `query-protocol` folder in [here](../../../oap-server/server-query-plugin/query-graphql-plugin/src/main/resources).
 
+## Condition
+### Duration
+Duration is a widely used parameter type as the APM data is time related. The explanations are as following. 
+Step is related the precision. 
+```graphql
+# The Duration defines the start and end time for each query operation.
+# Fields: `start` and `end`
+#   represents the time span. And each of them matches the step.
+#   ref https://www.ietf.org/rfc/rfc3339.txt
+#   The time formats are
+#       `SECOND` step: yyyy-MM-dd HHmmss
+#       `MINUTE` step: yyyy-MM-dd HHmm
+#       `HOUR` step: yyyy-MM-dd HH
+#       `DAY` step: yyyy-MM-dd
+#       `MONTH` step: yyyy-MM
+# Field: `step`
+#   represents the accurate time point.
+# e.g.
+#   if step==HOUR , start=2017-11-08 09, end=2017-11-08 19
+#   then
+#       metrics from the following time points expected
+#       2017-11-08 9:00 -> 2017-11-08 19:00
+#       there are 11 time points (hours) in the time span.
+input Duration {
+    start: String!
+    end: String!
+    step: Step!
+}
+
+enum Step {
+    MONTH
+    DAY
+    HOUR
+    MINUTE
+    SECOND
+}
+```