Adapt the new v3 protocol

.github/workflows/ci.yaml

@@ -31,9 +31,13 @@ jobs:
     strategy:
       fail-fast: true
     steps:
-      - uses: actions/checkout@v1
-        with:
-          submodules: true
+      - uses: actions/checkout@v2
+      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
+      - name: checkout submodules
+        shell: bash
+        run: |
+          git submodule sync --recursive
+          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
       - uses: leafo/gh-actions-lua@v5
         with:
           luaVersion: "5.3.5"
@@ -48,6 +52,7 @@ jobs:
         run: |
           sudo luarocks install luaunit
           sudo luarocks install lua-cjson 2.1.0-1
+          sudo luarocks install lua-resty-jit-uuid
       - name: "Install OpenResty"
         run: |
           wget -qO - https://openresty.org/package/pubkey.gpg | sudo apt-key add -

.github/workflows/e2e.yaml

@@ -31,9 +31,13 @@ jobs:
     strategy:
       fail-fast: true
     steps:
-      - uses: actions/checkout@v1
-        with:
-          submodules: true
+      - uses: actions/checkout@v2
+      # In the checkout@v2, it doesn't support git submodule. Execute the commands manually.
+      - name: checkout submodules
+        shell: bash
+        run: |
+          git submodule sync --recursive
+          git -c protocol.version=2 submodule update --init --force --recursive --depth=1
       - uses: actions/setup-java@v1
         with:
           java-version: 8

LICENSE

@@ -216,7 +216,7 @@ The following components are provided under a MIT license. See project link for
 The text of each license is also included at licenses/LICENSE-[project].txt.
 
     base64 dependencies/base64.lua https://github.com/iskolbin/lbase64 MIT
-
+    lua-resty-jit-uuid lib/resty/jit-uuid.lua https://github.com/thibaultcha/lua-resty-jit-uuid MIT
 
 ========================================================================
 BSD 2-Clause License

README.md

@@ -71,6 +71,9 @@ http {
 # Download
 Please head to the [releases page](http://skywalking.apache.org/downloads/) to download a release of Apache SkyWalking.
 
+* 0.1.0 release requires SkyWalking 7
+* 0.2.0+ releases require SkyWalking 8
+
 # Compatible backend
 SkyWalking OAP begins to support LUA agent in 7.0.0 release. 
 
@@ -80,22 +83,22 @@ You could choose master branch before the official 7.0.0 release.
 ### Debug Startup
 By using the `/examples/nginx.conf`, you could start the Nginx with LUA module or OpenResty. Such as `nginx -c /path/to/skywalking-nginx-lua/examples/nginx.conf`
 Then you could
-1. See the `register logs` happens on the console log.
+1. See the `instance properties update logs` happens on the console log.
+```
+2020/04/04 15:15:37 [debug] 12089#1446111: *4 [lua] content_by_lua(nginx.conf:175):4: Instance report request = {"service":"User Service Name","serviceInstance":"User Service Instance Name","properties":[{"language":"Lua"}]}
+2020/04/04 15:15:37 [debug] 12089#1446111: *2 [lua] client.lua:89: reportServiceInstance(): Instance report response = {}
 ```
-2020/02/27 09:22:06 [debug] 20676#11799235: *4 [lua] content_by_lua(nginx.conf:118):4: Service register request = {"services":[{"type":"normal","serviceName":"User Service Name"}]}
-2020/02/27 09:22:06 [debug] 20676#11799235: *2 [lua] client.lua:99: registerService(): Service register response = [{"key":"User Service Name","value":1}]
 
-2020/02/27 09:22:06 [debug] 20676#11799235: *2 [lua] client.lua:106: registerService(): Service registered, service id = 1
-2020/02/27 09:22:06 [debug] 20676#11799235: *4 [lua] content_by_lua(nginx.conf:134):3: Service instance register request = {"instances":[{"time":1582766526928,"instanceUUID":"name:User Service Instance Name","properties":[{"key":"language","value":"Lua"}],"serviceId":1}]}
-2020/02/27 09:22:06 [debug] 20676#11799235: *2 [lua] client.lua:143: registerServiceInstance(): Service Instance register response = [{"key":"name:User Service Instance Name","value":1}]
-2020/02/27 09:22:06 [debug] 20676#11799235: *2 [lua] client.lua:150: registerServiceInstance(): Service Instance registered, service instance id = 1
+2. See the `heartbeat logs` happens after the `register logs`
+```
+2020/04/04 15:15:40 [debug] 12089#1446111: *4 [lua] content_by_lua(nginx.conf:188):3: KeepAlive request = {"service":"User Service Name","serviceInstance":"User Service Instance Name"}
 ```
 
-2. Access the `http://127.0.0.1:8080/ingress` then you could see the tracing happens and reported spans in the logs.
+3. Access the `http://127.0.0.1:8080/ingress` then you could see the tracing happens and reported spans in the logs.
 ```
-2020/02/27 09:22:10 [debug] 20676#11799235: *9 [lua] tracer.lua:91: prepareForReport(): segment = {"spans":[{"operationName":"\/tier2\/lb","startTime":1582766530125,"endTime":1582766530139,"spanType":"Exit","spanId":1,"isError":false,"parentSpanId":0,"componentId":6000,"peer":"User Service Name-nginx:upstream_ip:port","spanLayer":"HTTP"},{"operationName":"\/tier2\/lb","startTime":1582766530125,"tags":[{"key":"http.method","value":"GET"},{"key":"http.params","value":"http:\/\/127.0.0.1\/tier2\/lb"}],"endTime":1582766530139,"spanType":"Entry","spanId":0,"isError":false,"parentSpanId":-1,"componentId":6000,"refs":[{"parentTraceSegmentId":{"idParts":[1582766530044,794206293,69887]},"parentEndpointId":0,"entryEndpointId":0,"parentServiceInstanceId":1,"parentEndpoint":"\/ingress","networkAddress":"#User Service Name-nginx:upstream_ip:port","parentSpanId":1,"entryServiceInstanceId":1,"networkAddressId":0,"entryEndpoint":"\/ingress"}],"spanLayer":"HTTP"}],"serviceInstanceId":1,"serviceId":1,"traceSegmentId":{"idParts":[1582766530052,794206293,69887]},"globalTraceIds":[{"idParts":[1582766530044,794206293,69887]}]}
-2020/02/27 09:22:10 [debug] 20676#11799235: *9 [lua] tracer.lua:95: prepareForReport(): segment buffer size = 1
-2020/02/27 09:22:10 [debug] 20676#11799235: *6 [lua] tracer.lua:91: prepareForReport(): segment = {"spans":[{"operationName":"\/ingress","startTime":1582766530114,"endTime":1582766530140,"spanType":"Exit","spanId":1,"isError":false,"parentSpanId":0,"componentId":6000,"peer":"User Service Name-nginx:upstream_ip:port","spanLayer":"HTTP"},{"operationName":"\/ingress","startTime":1582766530114,"tags":[{"key":"http.method","value":"GET"},{"key":"http.params","value":"http:\/\/127.0.0.1\/ingress"}],"endTime":1582766530140,"spanType":"Entry","spanId":0,"parentSpanId":-1,"isError":false,"spanLayer":"HTTP","componentId":6000}],"serviceInstanceId":1,"serviceId":1,"traceSegmentId":{"idParts":[1582766530044,794206293,69887]},"globalTraceIds":[{"idParts":[1582766530044,794206293,69887]}]}
+2020/04/04 15:15:46 [debug] 12089#1446111: *11 [lua] tracer.lua:83: prepareForReport(): segment = {"traceId":"1585984546953.410917649.45972","serviceInstance":"User Service Instance Name","spans":[{"operationName":"\/tier2\/lb","startTime":1585984546967,"endTime":1585984546968,"spanType":"Exit","spanId":1,"isError":false,"parentSpanId":0,"componentId":6000,"peer":"backend service","spanLayer":"Http"},{"operationName":"\/tier2\/lb","startTime":1585984546967,"tags":[{"key":"http.method","value":"GET"},{"key":"http.params","value":"http:\/\/127.0.0.1\/tier2\/lb"}],"endTime":1585984546968,"spanType":"Entry","spanId":0,"isError":false,"parentSpanId":-1,"componentId":6000,"refs":[{"traceId":"1585984546953.410917649.45972","networkAddressUsedAtPeer":"upstream service","parentEndpoint":"\/ingress","parentServiceInstance":"User Service Instance Name","parentSpanId":1,"parentService":"User Service Name","parentTraceSegmentId":"1585984546953.410917649.45972","refType":"CrossProcess"}],"spanLayer":"Http"}],"service":"User Service Name","traceSegmentId":"1585984546967.449397702.9959"}
+2020/04/04 15:15:46 [debug] 12089#1446111: *11 [lua] tracer.lua:87: prepareForReport(): segment buffer size = 1
+2020/04/04 15:15:46 [debug] 12089#1446111: *8 [lua] tracer.lua:83: prepareForReport(): segment = {"traceId":"1585984546953.410917649.45972","serviceInstance":"User Service Instance Name","spans":[{"operationName":"\/ingress","startTime":1585984546953,"endTime":1585984546968,"spanType":"Exit","spanId":1,"isError":false,"parentSpanId":0,"componentId":6000,"peer":"upstream service","spanLayer":"Http"},{"operationName":"\/ingress","startTime":1585984546953,"tags":[{"key":"http.method","value":"GET"},{"key":"http.params","value":"http:\/\/localhost\/ingress"}],"endTime":1585984546968,"spanType":"Entry","spanId":0,"parentSpanId":-1,"isError":false,"spanLayer":"Http","componentId":6000}],"service":"User Service Name","traceSegmentId":"1585984546953.410917649.45972"}
 ```
 
 ### Local Development and Unit Tests
@@ -106,6 +109,7 @@ All codes in the `lib/skywalking` require the `*_test.lua` to do the UnitTest. T
 The following libs are required in runtime or test cases, please use `LuaRocks` to install them.
 - lua-cjson. NOTICE, some platforms such as MacOS 10.15 may have issue with the latest release of this lib, consider to install an old release.(`luarocks install lua-cjson 2.1.0-1`)
 - luaunit
+- lua-resty-jit-uuid
 
 # APIs
 This LUA tracing lib is originally designed for Nginx+LUA/OpenResty ecosystems. But we write it to support more complex cases.

examples/nginx.conf

@@ -101,57 +101,42 @@ http {
             default_type text/html;
             content_by_lua_block {
                 ngx.say("<p>Backend service for testing only.</p>")
-                ngx.say("<p>Backend sw6 received headers: " .. ngx.req.get_headers()["sw6"] .. "</p>")
+                ngx.say("<p>Backend sw8 received headers: " .. ngx.req.get_headers()["sw8"] .. "</p>")
             }
         }
 
 
         # ------------------------------------------------------
         # -- Mock OAP server to provide register and trace collection
         # ------------------------------------------------------
-        location /v2/service/register {
+        location /v3/management/reportProperties {
             default_type text/html;
             lua_need_request_body on;
 
             content_by_lua_block {
                 local cjson = require('cjson')
-
-                ngx.log(ngx.DEBUG, 'Service register request = ', ngx.req.get_body_data())
-                local param = cjson.decode(ngx.req.get_body_data())
 
-                local registeredInfo = {}
-                registeredInfo[1] = {key=param.services[1].serviceName, value=1}
-                ngx.say(cjson.encode(registeredInfo))
-            }
-        }
-
-        location /v2/instance/register {
-            default_type text/html;
-            lua_need_request_body on;
+                ngx.log(ngx.DEBUG, 'Instance report request = ', ngx.req.get_body_data())
 
-            content_by_lua_block {
-                local cjson = require('cjson')
-                ngx.log(ngx.DEBUG, 'Service instance register request = ', ngx.req.get_body_data())
-                local param = cjson.decode(ngx.req.get_body_data())
-
-                local registeredInfo = {}
-
-                registeredInfo[1] = {key=param.instances[1].instanceUUID, value=1}
-                ngx.say(cjson.encode(registeredInfo))
+                local reportInfo = {}
+                ngx.say(cjson.encode(reportInfo))
             }
         }
 
-        location /v2/instance/heartbeat {
+        location /v3/management/keepAlive {
             default_type text/html;
             lua_need_request_body on;
 
             content_by_lua_block {
                 local cjson = require('cjson')
-                --ngx.log(ngx.DEBUG, 'Service instance ping request = ', ngx.req.get_body_data())
+                ngx.log(ngx.DEBUG, 'KeepAlive request = ', ngx.req.get_body_data())
+
+                local keepAliveInfo = {}
+                ngx.say(cjson.encode(keepAliveInfo))
             }
         }
 
-        location /v2/segments {
+        location /v3/segments {
             default_type text/html;
             lua_need_request_body on;