[incubator-skywalking] branch oap-languages updated: Finish the basic fields for each scope. @peng-yongsheng @hanahmily

[wu...@apache.org]

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 39b5b29  Finish the basic fields for each scope. @peng-yongsheng @hanahmily
39b5b29 is described below

commit 39b5b290261b5ca7cc8d0a0d1639ce2a9fbd8e43
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Thu Jul 5 17:22:15 2018 -0700

    Finish the basic fields for each scope. @peng-yongsheng @hanahmily
---
 docs/en/OAP/README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 69 insertions(+), 4 deletions(-)

diff --git a/docs/en/OAP/README.md b/docs/en/OAP/README.md
index ed0b57f..59cc30c 100644
--- a/docs/en/OAP/README.md
+++ b/docs/en/OAP/README.md
@@ -57,21 +57,26 @@ METRIC_NAME = from(SCOPE.(* | [FIELD][,FIELD ...]))
 - 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. status. Represent whether success or fail of the 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`
+
+Calculate the metric data from each request of the 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. status. Represent whether success or fail of the request.
 1. responseCode. Represent the response code of HTTP response, if this request is the HTTP call.
+1. type. Represent the type of each request. Such as: Database, HTTP, RPC, gRPC.
 
 - SCOPE `ServiceInstance`
+
+Calculate the metric data from each request of the service instance. 
 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 
@@ -79,17 +84,77 @@ 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. status. Represent whether success or fail of the request.
 1. responseCode. Represent the response code of HTTP response, if this request is the HTTP call.
+1. type. Represent the type of each request. Such as: Database, HTTP, RPC, gRPC.
 
 - SCOPE `Endpoint`
+
+Calculate the metric data from each request of the endpoint in the service. 
 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. status. Represent whether success or fail of the request.
+1. responseCode. Represent the response code of HTTP response, if this request is the HTTP call.
+1. type. Represent the type of each request. Such as: Database, HTTP, RPC, gRPC.
+
+- SCOPE `ServiceRelation`
+
+Calculate the metric data from each request between one service and the other service
+1. sourceServiceId. Represent the id of the source service.
+1. sourceServiceName. Represent the name of the source service.
+1. sourceServiceInstanceName. Represent the name of the source service instance.
+1. destServiceId. Represent the id of the destination service.
+1. destServiceName. Represent the name of the destination service.
+1. destServiceInstanceName. Represent the name of the destination service instance.
+1. endpoint. Represent the endpoint used in this call.
+1. latency. Represent how much time of each request.
+1. status. Represent whether success or fail of the request.
 1. responseCode. Represent the response code of HTTP response, if this request is the HTTP call.
+1. type. Represent the type of the remote call. Such as: Database, HTTP, RPC, gRPC.
+1. detectPoint. Represent where is the relation detected. Values: client, server, proxy.
+
+Group by both `sourceServiceId`, `destServiceId` and `detectPoint`.
+
+- SCOPE `ServiceInstanceRelation`
+
+Calculate the metric data from each request between one service instance and the other service instance
+1. sourceServiceName. Represent the name of the source service.
+1. sourceServiceInstanceId. Represent the id of the source service instance.
+1. sourceServiceInstanceName. Represent the name of the source service instance.
+1. destServiceName. Represent the name of the destination service.
+1. destServiceInstanceId. Represent the id of the destination service instance.
+1. destServiceInstanceName. Represent the name of the destination service instance.
+1. endpoint. Represent the endpoint used in this call.
+1. latency. Represent how much time of each request.
+1. status. Represent whether success or fail of the request.
+1. responseCode. Represent the response code of HTTP response, if this request is the HTTP call.
+1. type. Represent the type of the remote call. Such as: Database, HTTP, RPC, gRPC.
+1. detectPoint. Represent where is the relation detected. Values: client, server, proxy.
+
+Group by both `sourceServiceInstanceId`, `destServiceInstanceId` and `detectPoint`. 
+
+- SCOPE `EndpointRelation`
+
+Calculate the metric data of the dependency between one endpoint and the other endpoint. 
+This relation is hard to detect, also depends on tracing lib to propagate the prev endpoint. 
+So `EndpointRelation` scope aggregation effects only in service under tracing by SkyWalking native agents, 
+including auto instrument agents(like Java, .NET), OpenCensus SkyWalking exporter implementation or others propagate tracing context in SkyWalking spec.
+
+1. endpointId. Represent the id of the endpoint as parent in the dependency.
+1. endpoint. Represent the endpoint as parent in the dependency.
+1. childEndpointId. Represent the id of the endpoint being used by the parent endpoint in (1)
+1. childEndpoint. Represent the endpoint being used by the parent endpoint in (2)
+1. rpcLatency. Represent the latency of the RPC from some codes in the endpoint to the childEndpoint. Exclude the latency caused by the endpoint(1) itself.
+1. status. Represent whether success or fail of the request.
+1. responseCode. Represent the response code of HTTP response, if this request is the HTTP call.
+1. type. Represent the type of the remote call. Such as: Database, HTTP, RPC, gRPC.
+1. detectPoint. Represent where is the relation detected. Values: client, server, proxy.
+
+Group by both `endpointId`, `childEndpointId` and `detectPoint`.
+
 
 #### Filter
 Use filter to build the conditions for the value of fields, by using field name and expression.