feature: v8 protocol support (#314)

* fix conflict and compatibility of hosting

* feature: v8 protocol support

* bugfix: UniqueId should support string part

* bugfix: StringOrNumValue gethashcode null exception fix.

* feature: Component add id value.

* optimize: Remove the jar binaries.

* optimize: Remove md5 for performance reason.

* bugfix: Fix the java bootstrap script error.

* bugfix: Component id not being passed to oap server properly.

* optimize: Prefer to use the integer value when do transport to reduce the payload.

* optimize: Set the HeaderVersions.SW6 as default.

* bugfix: Register the CLRStatsService and its dependency into IOC

* bugfix: Set HeaderVersions.SW8 as default

* Optimize: Remove old protocol related code && Change traceId to string && Support config instance name

Co-authored-by: ElderJames <shunjiey@hotmail.com>
Co-authored-by: 郭刚平 <gangping.guo@xiaobao100.com>

Author: 3 people

.gitignore

@@ -265,4 +265,6 @@ tools/
 *.proto
 
 generated/
+generated-v3/
 
+/sample/java-integration-demo/agent

.gitmodules

@@ -2,3 +2,6 @@
 [submodule "src/SkyApm.Transport.Grpc.Protocol/protocol"]
 	path = src/SkyApm.Transport.Grpc.Protocol/protocol
 	url = https://github.com/apache/incubator-skywalking-data-collect-protocol
+[submodule "src/SkyApm.Transport.Grpc.Protocol/protocol-v3"]
+	path = src/SkyApm.Transport.Grpc.Protocol/protocol-v3
+	url = https://github.com/apache/incubator-skywalking-data-collect-protocol

benchmark/SkyApm.Benchmark/SkyApm.Benchmark.csproj

@@ -9,6 +9,8 @@
     <PackageReference Include="BenchmarkDotNet" Version="0.*" />
 
     <ProjectReference Include="..\..\src\SkyApm.Core\SkyApm.Core.csproj" />
+
+    <ProjectReference Include="..\..\src\SkyApm.Utilities.Configuration\SkyApm.Utilities.Configuration.csproj" />
   </ItemGroup>
 
 </Project>

benchmark/SkyApm.Benchmark/UniqueIdGenerate.cs

@@ -1,11 +1,23 @@
 using BenchmarkDotNet.Attributes;
+using SkyApm.Config;
 using SkyApm.Tracing;
+using SkyApm.Utilities.Configuration;
+using System;
+using System.Collections;
+using System.Linq;
 
 namespace SkyApm.Benchmark
 {
     public class UniqueIdGenerate
     {
-        private static readonly IUniqueIdGenerator Generator = new UniqueIdGenerator(new RuntimeEnvironment());
+        private static readonly IUniqueIdGenerator Generator;
+
+        static UniqueIdGenerate()
+        {
+            var configFactory = new ConfigurationFactory(null, Enumerable.Empty<IAdditionalConfigurationSource>());
+            var configAccessor = new ConfigAccessor(configFactory);
+            Generator = new UniqueIdGenerator(configAccessor);
+        }
 
         [Benchmark]
         public void Generate() => Generator.Generate();

benchmark/SkyApm.Benchmark/UniqueIdParse.cs

@@ -3,7 +3,7 @@
     "ServiceName": "asp-net-core-backend",
     "Namespace": "",
     "HeaderVersions": [
-      "sw6"
+      "sw8"
     ],
     "Sampling": {
       "SamplePer3Secs": -1,
@@ -15,7 +15,7 @@
     },
     "Transport": {
       "Interval": 3000,
-      "ProtocolVersion": "v6",
+      "ProtocolVersion": "v8",
       "QueueSize": 30000,
       "BatchSize": 3000,
       "gRPC": {

sample/SkyApm.Sample.Backend/skyapm.json

@@ -66,6 +66,13 @@ public async Task<IActionResult> SayHelloWithExceptionAsync(string name)
             return Ok(message);
         }
 
+        [HttpGet("hellojava")]
+        public async Task<IActionResult> HelloJava()
+        {
+            var message = await new HttpClient().GetStringAsync("http://localhost:8086/sayhello");
+            return Ok(message);
+        }
+
 #if NETCOREAPP2_1
 #else
         [HttpGet("greeter/grpc-net")]

sample/SkyApm.Sample.Frontend/Controllers/ValuesController.cs

@@ -3,7 +3,7 @@
     "ServiceName": "asp-net-core-frontend",
     "Namespace": "",
     "HeaderVersions": [
-      "sw6"
+      "sw8"
     ],
     "Sampling": {
       "SamplePer3Secs": -1,
@@ -15,7 +15,7 @@
     },
     "Transport": {
       "Interval": 3000,
-      "ProtocolVersion": "v6",
+      "ProtocolVersion": "v8",
       "QueueSize": 30000,
       "BatchSize": 3000,
       "gRPC": {

sample/SkyApm.Sample.Frontend/skyapm.json

@@ -11,7 +11,6 @@
       <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
     </Content>
   </ItemGroup>
-
   <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp2.1'">
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="2.1.0" />
   </ItemGroup>

sample/SkyApm.Sample.GenericHost/SkyApm.Sample.GenericHost.csproj

@@ -20,26 +20,26 @@ namespace SkyApm.Common
 {
     public static class Components
     {
-        public static readonly StringOrIntValue ASPNETCORE= new StringOrIntValue("AspNetCore");
+        public static readonly StringOrIntValue ASPNETCORE= new StringOrIntValue(3001, "AspNetCore");
 
-        public static readonly StringOrIntValue HTTPCLIENT = new StringOrIntValue("HttpClient");
+        public static readonly StringOrIntValue HTTPCLIENT = new StringOrIntValue(2, "HttpClient");
 
-        public static readonly StringOrIntValue ENTITYFRAMEWORKCORE = new StringOrIntValue("EntityFrameworkCore");
+        public static readonly StringOrIntValue ENTITYFRAMEWORKCORE = new StringOrIntValue(3002, "EntityFrameworkCore");
 
-        public static readonly StringOrIntValue SQLCLIENT = new StringOrIntValue("SqlClient");
+        public static readonly StringOrIntValue SQLCLIENT = new StringOrIntValue(3003, "SqlClient");
 
-        public static readonly StringOrIntValue CAP = new StringOrIntValue("CAP");
+        public static readonly StringOrIntValue CAP = new StringOrIntValue(3004, "CAP");
 
-        public static readonly StringOrIntValue ENTITYFRAMEWORKCORE_SQLITE = new StringOrIntValue("EntityFrameworkCore.Sqlite");
+        public static readonly StringOrIntValue ENTITYFRAMEWORKCORE_SQLITE = new StringOrIntValue(3011, "EntityFrameworkCore.Sqlite");
 
-        public static readonly StringOrIntValue POMELO_ENTITYFRAMEWORKCORE_MYSQL = new StringOrIntValue("Pomelo.EntityFrameworkCore.MySql");
+        public static readonly StringOrIntValue POMELO_ENTITYFRAMEWORKCORE_MYSQL = new StringOrIntValue(3012, "Pomelo.EntityFrameworkCore.MySql");
 
-        public static readonly StringOrIntValue NPGSQL_ENTITYFRAMEWORKCORE_POSTGRESQL = new StringOrIntValue("Npgsql.EntityFrameworkCore.PostgreSQL");
+        public static readonly StringOrIntValue NPGSQL_ENTITYFRAMEWORKCORE_POSTGRESQL = new StringOrIntValue(3013, "Npgsql.EntityFrameworkCore.PostgreSQL");
 
-        public static readonly StringOrIntValue ASPNET = new StringOrIntValue("AspNet");
+        public static readonly StringOrIntValue ASPNET = new StringOrIntValue(3015, "AspNet");
 
-        public static readonly StringOrIntValue SMART_SQL = new StringOrIntValue("SmartSql");
+        public static readonly StringOrIntValue SMART_SQL = new StringOrIntValue(3016, "SmartSql");
 
-        public static readonly StringOrIntValue GRPC = new StringOrIntValue("GRPC");
+        public static readonly StringOrIntValue GRPC = new StringOrIntValue(23, "GRPC");
     }
 }

src/SkyApm.Abstractions/Common/Components.cs

@@ -0,0 +1,93 @@
+/*
+ * Licensed to the SkyAPM under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The SkyAPM licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+
+namespace SkyApm.Common
+{
+    public struct StringOrNumValue<T> : IEquatable<StringOrNumValue<T>> where T : struct
+    {
+        private readonly Nullable<T> _numValue;
+        private readonly string _stringValue;
+
+        public StringOrNumValue(T value)
+        {
+            _numValue = value;
+            _stringValue = null;
+        }
+
+        public bool HasValue => HasNumValue || HasStringValue;
+
+        public bool HasNumValue => _numValue != null;
+
+        public bool HasStringValue => _stringValue != null;
+
+        public StringOrNumValue(string value)
+        {
+            _numValue = null;
+            _stringValue = value;
+        }
+
+        public StringOrNumValue(T numValue, string stringValue)
+        {
+            _numValue = numValue;
+            _stringValue = stringValue;
+        }
+
+        public T GetNumValue() => _numValue ?? default(T);
+
+        public string GetStringValue() => _stringValue;
+
+        public (string, T) GetValue()
+        {
+            return (_stringValue, _numValue ?? default(T));
+        }
+
+        public override string ToString()
+        {
+            if (HasNumValue) return _numValue.ToString();
+            return _stringValue;
+        }
+
+        public bool Equals(StringOrNumValue<T> other)
+        {
+            return _numValue.Equals(other._numValue) && _stringValue == other._stringValue;
+        }
+
+        public override bool Equals(object obj)
+        {
+            return obj is StringOrNumValue<T> other && Equals(other);
+        }
+
+        public override int GetHashCode()
+        {
+            unchecked
+            {
+                var hashCode = _numValue.GetHashCode();
+                if(_stringValue != null)
+                    hashCode = (hashCode * 397) ^ _stringValue.GetHashCode();
+                return hashCode;
+            }
+        }
+
+        public static implicit operator StringOrNumValue<T>(string value) => new StringOrNumValue<T>(value);
+        public static implicit operator StringOrNumValue<T>(T value) => new StringOrNumValue<T>(value);
+        public static bool operator ==(StringOrNumValue<T> left, StringOrNumValue<T> right) => left.Equals(right);
+        public static bool operator !=(StringOrNumValue<T> left, StringOrNumValue<T> right) => !left.Equals(right);
+    }
+}

src/SkyApm.Abstractions/Common/StringOrNumValue.cs

@@ -29,14 +29,15 @@ public class InstrumentConfig
         public string ApplicationCode { get; set; }
 
         public string ServiceName { get; set; }
-        
+
+        public string ServiceInstanceName { get; set; }
+
+
         public string[] HeaderVersions { get; set; }
     }
 
     public static class HeaderVersions
     {
-        public static string SW3 { get; } = "sw3";
-        
-        public static string SW6 { get; } = "sw6";
+        public static string SW8 { get; } = "sw8";
     }
 }

src/SkyApm.Abstractions/Config/InstrumentConfig.cs

@@ -33,13 +33,11 @@ public class TransportConfig
         /// </summary>
         public int BatchSize { get; set; } = 3000;
 
-        public string ProtocolVersion { get; set; } = ProtocolVersions.V6;
+        public string ProtocolVersion { get; set; } = ProtocolVersions.V8;
     }
 
     public static class ProtocolVersions
     {
-        public static string V5 { get; } = "v5";
-        
-        public static string V6 { get; } = "v6";
+        public static string V8 { get; } = "v8";
     }
 }

src/SkyApm.Abstractions/Config/TransportConfig.cs

@@ -23,14 +23,8 @@ namespace SkyApm
 {
     public interface IRuntimeEnvironment
     {
-        NullableValue ServiceId { get; }
-
-        NullableValue ServiceInstanceId { get; }
-
         bool Initialized { get; }
 
-        Guid InstanceId { get; }
-
         IEnvironmentProvider Environment { get; }
     }
 }

src/SkyApm.Abstractions/IRuntimeEnvironment.cs

@@ -26,20 +26,22 @@ public interface ICarrier
 
         bool? Sampled { get; }
 
-        UniqueId TraceId { get; }
+        string TraceId { get; }
 
-        UniqueId ParentSegmentId { get; }
+        string ParentSegmentId { get; }
 
         int ParentSpanId { get; }
 
-        int ParentServiceInstanceId { get; }
-        
-        int EntryServiceInstanceId { get; }
-        
+        string ParentServiceId { get; }
+
+        string ParentServiceInstanceId { get; }
+
+        string EntryServiceInstanceId { get; }
+
         StringOrIntValue NetworkAddress { get; }
-        
+
         StringOrIntValue EntryEndpoint { get; }
-        
+
         StringOrIntValue ParentEndpoint { get; }
     }
 }

src/SkyApm.Abstractions/Tracing/ICarrier.cs

@@ -20,6 +20,6 @@ namespace SkyApm.Tracing
 {
     public interface IUniqueIdGenerator
     {
-        UniqueId Generate();
+        string Generate();
     }
 }