[GitHub] [skywalking] kezhenxu94 commented on a change in pull request #8041: Enhance documents about the data report and query protocols.

[GitBox <gi...@apache.org>]

kezhenxu94 commented on a change in pull request #8041:
URL: https://github.com/apache/skywalking/pull/8041#discussion_r740022955



##########
File path: docs/en/protocols/query-protocol.md
##########
@@ -127,12 +127,51 @@ extend type Query {
 }
 ```
 
-### Others
-The following queries are for specific features, including trace, alarm, and profile.
-1. Trace. Query distributed traces by this.
-1. Alarm. Through alarm query, you can find alarm trends and their details.
+### Logs
+```graphql
+extend type Query {
+    # Return true if the current storage implementation supports fuzzy query for logs.
+    supportQueryLogsByKeywords: Boolean!
+    queryLogs(condition: LogQueryCondition): Logs
+
+    # Test the logs and get the results of the LAL output.
+    test(requests: LogTestRequest!): LogTestResponse!
+}
+```
+
+Log implementations have a little different with different database options. Search engine(s), e.g. ElasticSearch and OpenSearch, could support
+full log text fuzzy query. Others would not support considering performance impact and end user experience.
+
+`test` API is provides for the debugger tool of native LAL parsing. 

Review comment:
       ```suggestion
   `test` API is provided for the debugger tool of native LAL parsing. 
   ```
   

##########
File path: docs/en/protocols/query-protocol.md
##########
@@ -127,12 +127,51 @@ extend type Query {
 }
 ```
 
-### Others
-The following queries are for specific features, including trace, alarm, and profile.
-1. Trace. Query distributed traces by this.
-1. Alarm. Through alarm query, you can find alarm trends and their details.
+### Logs
+```graphql
+extend type Query {
+    # Return true if the current storage implementation supports fuzzy query for logs.
+    supportQueryLogsByKeywords: Boolean!
+    queryLogs(condition: LogQueryCondition): Logs
+
+    # Test the logs and get the results of the LAL output.
+    test(requests: LogTestRequest!): LogTestResponse!
+}
+```
+
+Log implementations have a little different with different database options. Search engine(s), e.g. ElasticSearch and OpenSearch, could support

Review comment:
       ```suggestion
   Log implementations have a little differences with different database options. Search engine(s), e.g. ElasticSearch and OpenSearch, could support
   ```
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org