mirror of https://github.com/grpc/grpc.git
Merge pull request #4025 from jtattermusch/csharp_perf_instrumentation
Add simple profiling instrumentation for C#pull/4031/head
commit
e146e0c7dc
17 changed files with 587 additions and 86 deletions
@ -0,0 +1,99 @@ |
|||||||
|
#region Copyright notice and license |
||||||
|
|
||||||
|
// Copyright 2015, Google Inc. |
||||||
|
// All rights reserved. |
||||||
|
// |
||||||
|
// Redistribution and use in source and binary forms, with or without |
||||||
|
// modification, are permitted provided that the following conditions are |
||||||
|
// met: |
||||||
|
// |
||||||
|
// * Redistributions of source code must retain the above copyright |
||||||
|
// notice, this list of conditions and the following disclaimer. |
||||||
|
// * Redistributions in binary form must reproduce the above |
||||||
|
// copyright notice, this list of conditions and the following disclaimer |
||||||
|
// in the documentation and/or other materials provided with the |
||||||
|
// distribution. |
||||||
|
// * Neither the name of Google Inc. nor the names of its |
||||||
|
// contributors may be used to endorse or promote products derived from |
||||||
|
// this software without specific prior written permission. |
||||||
|
// |
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
|
||||||
|
#endregion |
||||||
|
|
||||||
|
using System; |
||||||
|
using System.Diagnostics; |
||||||
|
using System.Linq; |
||||||
|
using System.Threading; |
||||||
|
using System.Threading.Tasks; |
||||||
|
using Grpc.Core; |
||||||
|
using Grpc.Core.Internal; |
||||||
|
using Grpc.Core.Profiling; |
||||||
|
using Grpc.Core.Utils; |
||||||
|
using NUnit.Framework; |
||||||
|
|
||||||
|
namespace Grpc.Core.Tests |
||||||
|
{ |
||||||
|
public class PerformanceTest |
||||||
|
{ |
||||||
|
const string Host = "127.0.0.1"; |
||||||
|
|
||||||
|
MockServiceHelper helper; |
||||||
|
Server server; |
||||||
|
Channel channel; |
||||||
|
|
||||||
|
[SetUp] |
||||||
|
public void Init() |
||||||
|
{ |
||||||
|
helper = new MockServiceHelper(Host); |
||||||
|
server = helper.GetServer(); |
||||||
|
server.Start(); |
||||||
|
channel = helper.GetChannel(); |
||||||
|
} |
||||||
|
|
||||||
|
[TearDown] |
||||||
|
public void Cleanup() |
||||||
|
{ |
||||||
|
channel.ShutdownAsync().Wait(); |
||||||
|
server.ShutdownAsync().Wait(); |
||||||
|
} |
||||||
|
|
||||||
|
// Test attribute commented out to prevent running as part of the default test suite. |
||||||
|
//[Test] |
||||||
|
//[Category("Performance")] |
||||||
|
public void UnaryCallPerformance() |
||||||
|
{ |
||||||
|
var profiler = new BasicProfiler(); |
||||||
|
Profilers.SetForCurrentThread(profiler); |
||||||
|
|
||||||
|
helper.UnaryHandler = new UnaryServerMethod<string, string>(async (request, context) => |
||||||
|
{ |
||||||
|
return request; |
||||||
|
}); |
||||||
|
|
||||||
|
var callDetails = helper.CreateUnaryCall(); |
||||||
|
for(int i = 0; i < 3000; i++) |
||||||
|
{ |
||||||
|
Calls.BlockingUnaryCall(callDetails, "ABC"); |
||||||
|
} |
||||||
|
|
||||||
|
profiler.Reset(); |
||||||
|
|
||||||
|
for(int i = 0; i < 3000; i++) |
||||||
|
{ |
||||||
|
Calls.BlockingUnaryCall(callDetails, "ABC"); |
||||||
|
} |
||||||
|
profiler.Dump("latency_trace_csharp.txt"); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
@ -0,0 +1,47 @@ |
|||||||
|
#region Copyright notice and license |
||||||
|
|
||||||
|
// Copyright 2015, Google Inc. |
||||||
|
// All rights reserved. |
||||||
|
// |
||||||
|
// Redistribution and use in source and binary forms, with or without |
||||||
|
// modification, are permitted provided that the following conditions are |
||||||
|
// met: |
||||||
|
// |
||||||
|
// * Redistributions of source code must retain the above copyright |
||||||
|
// notice, this list of conditions and the following disclaimer. |
||||||
|
// * Redistributions in binary form must reproduce the above |
||||||
|
// copyright notice, this list of conditions and the following disclaimer |
||||||
|
// in the documentation and/or other materials provided with the |
||||||
|
// distribution. |
||||||
|
// * Neither the name of Google Inc. nor the names of its |
||||||
|
// contributors may be used to endorse or promote products derived from |
||||||
|
// this software without specific prior written permission. |
||||||
|
// |
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
|
||||||
|
#endregion |
||||||
|
|
||||||
|
using System; |
||||||
|
using System.IO; |
||||||
|
using System.Threading; |
||||||
|
using Grpc.Core.Internal; |
||||||
|
|
||||||
|
namespace Grpc.Core.Profiling |
||||||
|
{ |
||||||
|
internal interface IProfiler |
||||||
|
{ |
||||||
|
void Begin(string tag); |
||||||
|
void End(string tag); |
||||||
|
void Mark(string tag); |
||||||
|
} |
||||||
|
} |
@ -0,0 +1,87 @@ |
|||||||
|
#region Copyright notice and license |
||||||
|
|
||||||
|
// Copyright 2015, Google Inc. |
||||||
|
// All rights reserved. |
||||||
|
// |
||||||
|
// Redistribution and use in source and binary forms, with or without |
||||||
|
// modification, are permitted provided that the following conditions are |
||||||
|
// met: |
||||||
|
// |
||||||
|
// * Redistributions of source code must retain the above copyright |
||||||
|
// notice, this list of conditions and the following disclaimer. |
||||||
|
// * Redistributions in binary form must reproduce the above |
||||||
|
// copyright notice, this list of conditions and the following disclaimer |
||||||
|
// in the documentation and/or other materials provided with the |
||||||
|
// distribution. |
||||||
|
// * Neither the name of Google Inc. nor the names of its |
||||||
|
// contributors may be used to endorse or promote products derived from |
||||||
|
// this software without specific prior written permission. |
||||||
|
// |
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
|
||||||
|
#endregion |
||||||
|
|
||||||
|
using System; |
||||||
|
using System.IO; |
||||||
|
using System.Threading; |
||||||
|
using Grpc.Core.Internal; |
||||||
|
|
||||||
|
namespace Grpc.Core.Profiling |
||||||
|
{ |
||||||
|
internal struct ProfilerEntry |
||||||
|
{ |
||||||
|
public enum Type { |
||||||
|
BEGIN, |
||||||
|
END, |
||||||
|
MARK |
||||||
|
} |
||||||
|
|
||||||
|
public ProfilerEntry(Timespec timespec, Type type, string tag) |
||||||
|
{ |
||||||
|
this.timespec = timespec; |
||||||
|
this.type = type; |
||||||
|
this.tag = tag; |
||||||
|
} |
||||||
|
|
||||||
|
public Timespec timespec; |
||||||
|
public Type type; |
||||||
|
public string tag; |
||||||
|
|
||||||
|
public override string ToString() |
||||||
|
{ |
||||||
|
// mimic the output format used by C core. |
||||||
|
return string.Format( |
||||||
|
"{{\"t\": {0}.{1}, \"thd\":\"unknown\", \"type\": \"{2}\", \"tag\": \"{3}\", " + |
||||||
|
"\"file\": \"unknown\", \"line\": 0, \"imp\": 0}}", |
||||||
|
timespec.TimevalSeconds, timespec.TimevalNanos.ToString("D9"), |
||||||
|
GetTypeAbbreviation(type), tag); |
||||||
|
} |
||||||
|
|
||||||
|
internal static string GetTypeAbbreviation(Type type) |
||||||
|
{ |
||||||
|
switch (type) |
||||||
|
{ |
||||||
|
case Type.BEGIN: |
||||||
|
return "{"; |
||||||
|
|
||||||
|
case Type.END: |
||||||
|
return "}"; |
||||||
|
|
||||||
|
case Type.MARK: |
||||||
|
return "."; |
||||||
|
default: |
||||||
|
throw new ArgumentException("Unknown type"); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
@ -0,0 +1,60 @@ |
|||||||
|
#region Copyright notice and license |
||||||
|
|
||||||
|
// Copyright 2015, Google Inc. |
||||||
|
// All rights reserved. |
||||||
|
// |
||||||
|
// Redistribution and use in source and binary forms, with or without |
||||||
|
// modification, are permitted provided that the following conditions are |
||||||
|
// met: |
||||||
|
// |
||||||
|
// * Redistributions of source code must retain the above copyright |
||||||
|
// notice, this list of conditions and the following disclaimer. |
||||||
|
// * Redistributions in binary form must reproduce the above |
||||||
|
// copyright notice, this list of conditions and the following disclaimer |
||||||
|
// in the documentation and/or other materials provided with the |
||||||
|
// distribution. |
||||||
|
// * Neither the name of Google Inc. nor the names of its |
||||||
|
// contributors may be used to endorse or promote products derived from |
||||||
|
// this software without specific prior written permission. |
||||||
|
// |
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
|
||||||
|
#endregion |
||||||
|
|
||||||
|
using System; |
||||||
|
using System.IO; |
||||||
|
using System.Threading; |
||||||
|
using Grpc.Core.Internal; |
||||||
|
|
||||||
|
namespace Grpc.Core.Profiling |
||||||
|
{ |
||||||
|
// Allows declaring Begin and End of a profiler scope with a using statement. |
||||||
|
// declared as struct for better performance. |
||||||
|
internal struct ProfilerScope : IDisposable |
||||||
|
{ |
||||||
|
readonly IProfiler profiler; |
||||||
|
readonly string tag; |
||||||
|
|
||||||
|
public ProfilerScope(IProfiler profiler, string tag) |
||||||
|
{ |
||||||
|
this.profiler = profiler; |
||||||
|
this.tag = tag; |
||||||
|
this.profiler.Begin(this.tag); |
||||||
|
} |
||||||
|
|
||||||
|
public void Dispose() |
||||||
|
{ |
||||||
|
profiler.End(tag); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
@ -0,0 +1,131 @@ |
|||||||
|
#region Copyright notice and license |
||||||
|
|
||||||
|
// Copyright 2015, Google Inc. |
||||||
|
// All rights reserved. |
||||||
|
// |
||||||
|
// Redistribution and use in source and binary forms, with or without |
||||||
|
// modification, are permitted provided that the following conditions are |
||||||
|
// met: |
||||||
|
// |
||||||
|
// * Redistributions of source code must retain the above copyright |
||||||
|
// notice, this list of conditions and the following disclaimer. |
||||||
|
// * Redistributions in binary form must reproduce the above |
||||||
|
// copyright notice, this list of conditions and the following disclaimer |
||||||
|
// in the documentation and/or other materials provided with the |
||||||
|
// distribution. |
||||||
|
// * Neither the name of Google Inc. nor the names of its |
||||||
|
// contributors may be used to endorse or promote products derived from |
||||||
|
// this software without specific prior written permission. |
||||||
|
// |
||||||
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||||
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||||
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||||
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||||
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||||
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||||
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||||
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||||
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
|
||||||
|
#endregion |
||||||
|
|
||||||
|
using System; |
||||||
|
using System.IO; |
||||||
|
using System.Threading; |
||||||
|
using Grpc.Core.Internal; |
||||||
|
|
||||||
|
namespace Grpc.Core.Profiling |
||||||
|
{ |
||||||
|
internal static class Profilers |
||||||
|
{ |
||||||
|
static readonly NopProfiler defaultProfiler = new NopProfiler(); |
||||||
|
static readonly ThreadLocal<IProfiler> profilers = new ThreadLocal<IProfiler>(); |
||||||
|
|
||||||
|
public static IProfiler ForCurrentThread() |
||||||
|
{ |
||||||
|
return profilers.Value ?? defaultProfiler; |
||||||
|
} |
||||||
|
|
||||||
|
public static void SetForCurrentThread(IProfiler profiler) |
||||||
|
{ |
||||||
|
profilers.Value = profiler; |
||||||
|
} |
||||||
|
|
||||||
|
public static ProfilerScope NewScope(this IProfiler profiler, string tag) |
||||||
|
{ |
||||||
|
return new ProfilerScope(profiler, tag); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
internal class NopProfiler : IProfiler |
||||||
|
{ |
||||||
|
public void Begin(string tag) |
||||||
|
{ |
||||||
|
} |
||||||
|
|
||||||
|
public void End(string tag) |
||||||
|
{ |
||||||
|
} |
||||||
|
|
||||||
|
public void Mark(string tag) |
||||||
|
{ |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Profiler using Timespec.PreciseNow |
||||||
|
internal class BasicProfiler : IProfiler |
||||||
|
{ |
||||||
|
ProfilerEntry[] entries; |
||||||
|
int count; |
||||||
|
|
||||||
|
public BasicProfiler() : this(1024*1024) |
||||||
|
{ |
||||||
|
} |
||||||
|
|
||||||
|
public BasicProfiler(int capacity) |
||||||
|
{ |
||||||
|
this.entries = new ProfilerEntry[capacity]; |
||||||
|
} |
||||||
|
|
||||||
|
public void Begin(string tag) { |
||||||
|
AddEntry(new ProfilerEntry(Timespec.PreciseNow, ProfilerEntry.Type.BEGIN, tag)); |
||||||
|
} |
||||||
|
|
||||||
|
public void End(string tag) { |
||||||
|
AddEntry(new ProfilerEntry(Timespec.PreciseNow, ProfilerEntry.Type.END, tag)); |
||||||
|
} |
||||||
|
|
||||||
|
public void Mark(string tag) { |
||||||
|
AddEntry(new ProfilerEntry(Timespec.PreciseNow, ProfilerEntry.Type.MARK, tag)); |
||||||
|
} |
||||||
|
|
||||||
|
public void Reset() |
||||||
|
{ |
||||||
|
count = 0; |
||||||
|
} |
||||||
|
|
||||||
|
public void Dump(string filepath) |
||||||
|
{ |
||||||
|
using (var stream = new StreamWriter(filepath)) |
||||||
|
{ |
||||||
|
Dump(stream); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
public void Dump(TextWriter stream) |
||||||
|
{ |
||||||
|
for (int i = 0; i < count; i++) |
||||||
|
{ |
||||||
|
var entry = entries[i]; |
||||||
|
stream.WriteLine(entry.ToString()); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// NOT THREADSAFE! |
||||||
|
void AddEntry(ProfilerEntry entry) { |
||||||
|
entries[count++] = entry; |
||||||
|
} |
||||||
|
} |
||||||
|
} |
Loading…
Reference in new issue