[incubator-skywalking] branch oap-languages updated: Define the fields of All, Service, ServiceInstance and Endpoint for others to preview. @peng-yongsheng @hanahmily

[wusheng]

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

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


The following commit(s) were added to refs/heads/oap-languages by this push:
     new 346aecf  Define the fields of All, Service, ServiceInstance and 
Endpoint for others to preview. @peng-yongsheng @hanahmily
346aecf is described below

commit 346aecf26fe55d58bdd66f4ff6d492bd45b3e6a3
Author: Wu Sheng <wu.sh...@foxmail.com>
AuthorDate: Thu Jul 5 11:51:18 2018 -0700

    Define the fields of All, Service, ServiceInstance and Endpoint for others 
to preview. @peng-yongsheng @hanahmily
---
 docs/en/OAP/README.md | 40 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 38 insertions(+), 2 deletions(-)

diff --git a/docs/en/OAP/README.md b/docs/en/OAP/README.md
index 9f3c1cc..ed0b57f 100644
--- a/docs/en/OAP/README.md
+++ b/docs/en/OAP/README.md
@@ -4,6 +4,7 @@ old SkyWalking collectors. The capabilities of the platform are 
following.
 
 ## OAP capabilities
 <img src="https://skywalkingtest.github.io/page-resources/6_overview.png"/>
+
 In SkyWalking 6 series, OAP accepts data from more sources, which belongs two 
groups: **Tracing** and **Metric**.
 
 - **Tracing**. Including, SkyWalking native data formats. Zipkin v1,v2 data 
formats and Jaeger data formats.
@@ -50,10 +51,45 @@ METRIC_NAME = from(SCOPE.(* | [FIELD][,FIELD ...]))
 ```
 
 #### Scope
-**SCOPE** in (`All`, `Service`, `ServiceInst`, `Endpoint`, `ServiceRelation`, 
`ServiceInstRelation`, `EndpointRelation`).
+**SCOPE** in (`All`, `Service`, `ServiceInstance`, `Endpoint`, 
`ServiceRelation`, `ServiceInstanceRelation`, `EndpointRelation`).
 
 #### Field
-TODO
+- SCOPE `All`, 
+1. endpoint. Represent the endpoint path of each request.
+1. latency. Represent how much time of each request.
+1. status. Represent whether success or fail of each request.
+1. responseCode. Represent the response code of HTTP response, if this request 
is the HTTP call.
+
+All details in `All` scope will group together.
+
+- SCOPE `Service`
+1. id. Represent the unique id of the service, usually a number. **Group by 
this in default**.
+1. name. Represent the name of the service.
+1. serviceInstanceName. Represent the name of the service instance id referred.
+1. endpointName. Represent the name of the endpoint, such a full path of HTTP 
URI.
+1. latency. Represent how much time of each request.
+1. status. Represent whether success or fail of each request.
+1. responseCode. Represent the response code of HTTP response, if this request 
is the HTTP call.
+
+- SCOPE `ServiceInstance`
+1. id. Represent the unique id of the service, usually a number. **Group by 
this in default**.
+1. name. Represent the name of the service instance. Such as `ip:port@Service 
Name`. 
+**Notice**: current native agent uses `processId@Service name` as instance 
name, which is useless 
+when you want to setup a filter in aggregation. 
+1. serviceName. Represent the name of the service.
+1. endpointName. Represent the name of the endpoint, such a full path of HTTP 
URI.
+1. latency. Represent how much time of each request.
+1. status. Represent whether success or fail of each request.
+1. responseCode. Represent the response code of HTTP response, if this request 
is the HTTP call.
+
+- SCOPE `Endpoint`
+1. id. Represent the unique id of the endpoint, usually a number. **Group by 
this in default**.
+1. name. Represent the name of the endpoint, such a full path of HTTP URI.
+1. serviceName. Represent the name of the service.
+1. serviceInstanceName. Represent the name of the service instance id referred.
+1. latency. Represent how much time of each request.
+1. status. Represent whether success or fail of each request.
+1. responseCode. Represent the response code of HTTP response, if this request 
is the HTTP call.
 
 #### Filter
 Use filter to build the conditions for the value of fields, by using field 
name and expression.