wu-sheng closed pull request #893: Feature/readme
URL: https://github.com/apache/incubator-skywalking/pull/893
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/cn/Deploy-backend-in-cluster-mode-CN.md 
b/docs/cn/Deploy-backend-in-cluster-mode-CN.md
index deff7b7bb..b2d230021 100644
--- a/docs/cn/Deploy-backend-in-cluster-mode-CN.md
+++ b/docs/cn/Deploy-backend-in-cluster-mode-CN.md
@@ -1,7 +1,7 @@
 ## ????????
 - ???????JDK6+
-- sky-walking server?webui??JDK8+
-- Elasticsearch 5.3
+- SkyWalking collector?WebUI??JDK8+
+- Elasticsearch 5.x
 - Zookeeper 3.4.10
 
 ## ??????
@@ -55,7 +55,11 @@ agent_jetty:
     host: localhost
     port: 12800
     context_path: /
-agent_stream:
+analysis_register:
+  default:
+analysis_jvm:
+  default:
+analysis_segment_parser:
   default:
     buffer_file_path: ../buffer/
     buffer_offset_max_file_size: 10M
diff --git a/docs/cn/Trace-Data-Protocol-CN.md 
b/docs/cn/Trace-Data-Protocol-CN.md
index 51c9afec9..32b649afb 100644
--- a/docs/cn/Trace-Data-Protocol-CN.md
+++ b/docs/cn/Trace-Data-Protocol-CN.md
@@ -8,8 +8,8 @@ Trace Data Protocol?????????Collector?????
 v1.1
 
 ### ????
-* ??????http??
-* ?????????????gRPC?HTTP??
+* ??????HTTP??
+* ?????????????gRPC?HTTP JSON??
 
 #### gRPC??????
 [gRPC proto files](../../apm-protocol/apm-network/src/main/proto)
@@ -34,7 +34,7 @@ JSON?????????????????gRPC?????
 
 ## ??????
 ### ??
-?????????applicationCode???ip:port?????????????ID????
+?????????applicationCode??????ID????
 ?????????????????????????
 
 ### ????
@@ -76,6 +76,16 @@ gRPC??
 - ???????????????????????????????URI??????????????????????????????
 - 
ServiceNameElement??applicationId???applicationCode???id?serviceName?????span?operationName
 
+## ????????
+### ??
+????????????????RPC?MQ?DB...?????addresses????id????
+
+### ????
+[gRPC service 
define](../../apm-protocol/apm-network/src/main/proto/NetworkAddressRegisterService.proto)
+
+- ????????????????????
+- NetworkAddresses??addresses????????IP/HOST:PORT???????????
+
 ## JVM??????
 ### ??
 ???????JVM??????????
@@ -99,3 +109,149 @@ gRPC??
   - parentServiceName/parentServiceId
   - peerId/peer
 - 
componentId????????id??????????????????????[??????](../../apm-protocol/apm-network/src/main/java/org/apache/skywalking/apm/network/trace/component/ComponentsDefine.java)
+
+### ????
+HTTP JSON??, ????gRPC?????????gRPC?????????HTTP POST??
+
+### ??????
+??: http://ip:port/instance/register(default: localhost:12800) 
+
+???
+```
+{
+    ai: x, #applicationId
+    au: "", #agentUUID
+    rt: x, #registerTime
+    oi: "", #osinfo
+}
+```
+
+???
+```
+{
+    ai: x, #applicationId
+    ii: x, #applicationInstanceId
+}
+```
+
+### ??????
+??: http://ip:port/instance/heartbeat(default: localhost:12800) 
+
+???
+```
+{
+    "ii": x, #applicationInstanceId
+    "ht": x #heartbeatTime, java timestamp format
+}
+```
+
+????
+
+## ?????????
+??: http://ip:port/servicename/discovery(default: localhost:12800) 
+
+???
+```
+{
+    ai: x, #applicationId
+    sn: "", #serviceName
+    st: x, #srcSpanType
+}
+```
+
+???
+```
+{
+    si: x, #osinfo
+    el: { #element
+        ai: x, #applicationId
+        sn: "", #serviceName
+        st: x, #srcSpanType
+    }
+}
+```
+
+## JVM??????
+### ???????java?c#??????gRPC?????
+
+## TraceSegment????
+### ????????Segment???JSON?????
+???
+```
+[
+  {
+    "gt": [[230150, 185809, 24040000]], //globalTraceIds ???????????
+    "sg": { //TraceSegmentObject 
+      "ts": [137150, 185809, 48780000], //traceSegmentId????
+      "ai": 2, //applicationId
+      "ii": 3, //applicationInstanceId
+      "ss": [ //SpanObject
+        {
+          "si": 0, //spanId
+          "tv": 0, //SpanType
+          "lv": 2, //SpanLayer
+          "ps": -1, //parentSpanId
+          "st": 1501858094726, //startTime
+          "et": 1501858096804, //endTime
+          "ci": 3, //componentId
+          "cn": "", //component
+          "oi": 0, //operationNameId
+          "on": 
"org.skywaking.apm.testcase.dubbo.services.GreetService.doBusiness()", 
//operationName
+          "pi": 0, //peerId
+          "pn": "", //peer
+          "ie": false, //isError
+          "rs": [ //TraceSegmentReference
+            {
+              "pts": [230150, 185809, 24040000], //parentTraceSegmentId, 
???segment_id ???????????????????
+              "pii": 2, //parentApplicationInstanceId, ???????
+              "psp": 1, //parentSpanId, ???????span_id
+              "psi": 0, //parentServiceId, 
???????(org.skywaking.apm.testcase.dubbo.services.GreetService.doBusiness()????ID)
+              "psn": "/dubbox-case/case/dubbox-rest", //parentServiceName, 
??????
+              "ni": 0,  //networkAddressId, ??????????????ID
+              "nn": "172.25.0.4:20880", //networkAddress, ?????
+              "eii": 2, //entryApplicationInstanceId, ???????
+              "esi": 0, //entryServiceId, ???????
+              "esn": "/dubbox-case/case/dubbox-rest", //entryServiceName, 
???????
+              "rn": 0 //RefType, ?????CrossProcess?CrossThread?
+            }
+          ],
+          "to": [ //KeyWithStringValue
+            {
+              "k": "url", //key
+              "v": 
"rest://172.25.0.4:20880/org.skywaking.apm.testcase.dubbo.services.GreetService.doBusiness()"
 //value
+            },
+            {
+              "k": "http.method",
+              "v": "GET"
+            }
+          ],
+          "lo": { //LogMessage
+            "t": 1501858094726,
+            "d": [
+                "k": "NullPointException",
+                "v": "Error Stack"
+            }
+          }
+        },
+        {
+          "si": 1,
+          "tv": 1,
+          "lv": 1,
+          "ps": 0,
+          "st": 1501858094726,
+          "et": 1501858095804,
+          "ci": 9,
+          "cn": "",
+          "oi": 0,
+          "on": 
"mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]",
+          "pi": 0,
+          "pn": "localhost:27017",
+          "ie": false,
+          "to": [],
+          "lo": []
+        }
+      ]
+    }
+  }
+]
+```
diff --git a/docs/en/Deploy-backend-in-cluster-mode.md 
b/docs/en/Deploy-backend-in-cluster-mode.md
index 80a79486e..d71970400 100644
--- a/docs/en/Deploy-backend-in-cluster-mode.md
+++ b/docs/en/Deploy-backend-in-cluster-mode.md
@@ -1,7 +1,7 @@
 ## Required of third party softwares
 - JDK 6+?instruments application can run in jdk6?
-- JDK8  ( skywalking collector and skywalking ui )
-- Elasticsearch 5.2.2 or 5.3, cluster mode or not
+- JDK8  ( SkyWalking collector and SkyWalking WebUI )
+- Elasticsearch 5.x, cluster mode or not
 - Zookeeper 3.4.10
 
 ## Download released version
@@ -37,10 +37,10 @@ cluster:
     sessionTimeout: 100000
 naming:
 # Host and port used for agent config
-  jetty:
-    host: localhost
-    port: 10800
-    context_path: /
+    jetty:
+        host: localhost
+        port: 10800
+        context_path: /
 remote:
   gRPC:
     host: localhost
@@ -54,7 +54,11 @@ agent_jetty:
     host: localhost
     port: 12800
     context_path: /
-agent_stream:
+analysis_register:
+  default:
+analysis_jvm:
+  default:
+analysis_segment_parser:
   default:
     buffer_file_path: ../buffer/
     buffer_offset_max_file_size: 10M
diff --git a/docs/en/Deploy-backend-in-standalone-mode.md 
b/docs/en/Deploy-backend-in-standalone-mode.md
index 543f487c5..f44c1588f 100644
--- a/docs/en/Deploy-backend-in-standalone-mode.md
+++ b/docs/en/Deploy-backend-in-standalone-mode.md
@@ -1,7 +1,7 @@
-# Usage scenario
+# Usage scenario?no provide in alpha version?planning provide in beta version?
 Default standalong mode collector means don't support cluster. It uses H2 as 
storage layer implementation, suggest that use only for preview, test, 
demonstration, low throughputs and small scale system.
 
-If you are using skywalking in a low throughputs monitoring scenario, and 
don't want to deploy cluster, at least, switch the storage implementation from 
H2 to  Elasticsearch.
+If you are using SkyWalking in a low throughputs monitoring scenario, and 
don't want to deploy cluster, at least, switch the storage implementation from 
H2 to Elasticsearch.
 
 **H2 storage implementation is not provided in 5.0.0-alpha, so you must deploy 
ElasticSearch before try to start backend**
 


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to