Diagnosztikai ügyfélkódtár
Ez a cikk a következőre vonatkozik: ✔️ .NET Core 3.0 SDK és újabb verziók célalkalmazásokhoz, .NET Standard 2.0 a kódtár használatához.
Microsoft.Diagnostics.NETCore.ClientA (más néven diagnosztikai ügyfélkódtár) egy felügyelt kódtár, amely lehetővé teszi a .NET Core-futtatókörnyezettel (CoreCLR) való kommunikációt a különböző diagnosztikai feladatokhoz, például az EventPipe-en keresztüli nyomkövetéshez, a memóriakép kéréséhez vagy egy ICorProfilercsatoláshoz. Ez a kódtár számos diagnosztikai eszköz mögötti háttértár, például dotnet-counters, dotnet-trace, dotnet-gcdump, dotnet-dump és dotnet-monitor. Ezzel a kódtárzal saját diagnosztikai eszközöket írhat az adott forgatókönyvhez testre szabva.
A Microsoft.Diagnostics.NETCore.Client beszerzéséhez adjon hozzá egy PackageReference újat a projekthez. A csomag üzemeltetése a következőn NuGet.orgtörténik: .
A következő szakaszokban található minták bemutatják a Microsoft.Diagnostics.NETCore.Client kódtár használatát. Néhány példa az esemény hasznos adatainak a TraceEvent-kódtár használatával történő elemzését is mutatja.
Csatolja a folyamatot, és nyomtassa ki az összes GC-eseményt
Ez a kódrészlet bemutatja, hogyan indíthat eventPipe-munkamenetet a .NET futtatókörnyezet-szolgáltatóval a GC kulcsszóval információs szinten. Azt is bemutatja, hogyan használhatja a EventPipeEventSource TraceEvent könyvtár által biztosított osztályt a bejövő események elemzéséhez és a nevük valós idejű kinyomtatásához a konzolon.
using Microsoft.Diagnostics.NETCore.Client;
using Microsoft.Diagnostics.Tracing;
using Microsoft.Diagnostics.Tracing.EventPipe;
using Microsoft.Diagnostics.Tracing.Parsers;
using System;
using System.Collections.Generic;
using System.Diagnostics.Tracing;
public class RuntimeGCEventsPrinter
{
public static void PrintRuntimeGCEvents(int processId)
{
var providers = new List<EventPipeProvider>()
{
new EventPipeProvider("Microsoft-Windows-DotNETRuntime",
EventLevel.Informational, (long)ClrTraceEventParser.Keywords.GC)
};
var client = new DiagnosticsClient(processId);
using (EventPipeSession session = client.StartEventPipeSession(providers, false))
{
var source = new EventPipeEventSource(session.EventStream);
source.Clr.All += (TraceEvent obj) => Console.WriteLine(obj.ToString());
try
{
source.Process();
}
catch (Exception e)
{
Console.WriteLine("Error encountered while processing events");
Console.WriteLine(e.ToString());
}
}
}
}
Alapvető memóriakép írása
Ez a minta bemutatja, hogyan aktiválható egy magos memóriakép gyűjteménye a következő használatávalDiagnosticsClient: .
using Microsoft.Diagnostics.NETCore.Client;
public partial class Dumper
{
public static void TriggerCoreDump(int processId)
{
var client = new DiagnosticsClient(processId);
client.WriteDump(DumpType.Normal, "/tmp/minidump.dmp");
}
}
Központi memóriakép aktiválása, ha a CPU-használat túllépi a küszöbértéket
Ez a minta bemutatja, hogyan figyelheti a cpu-usage .NET-futtatókörnyezet által közzétett számlálót, és kérhet memóriaképet, ha a processzorhasználat túllép egy bizonyos küszöbértéket.
using Microsoft.Diagnostics.NETCore.Client;
using Microsoft.Diagnostics.Tracing;
using Microsoft.Diagnostics.Tracing.EventPipe;
using Microsoft.Diagnostics.Tracing.Parsers;
using System;
using System.Collections.Generic;
using System.Diagnostics.Tracing;
public partial class Dumper
{
public static void TriggerDumpOnCpuUsage(int processId, int threshold)
{
var providers = new List<EventPipeProvider>()
{
new EventPipeProvider(
"System.Runtime",
EventLevel.Informational,
(long)ClrTraceEventParser.Keywords.None,
new Dictionary<string, string>
{
["EventCounterIntervalSec"] = "1"
}
)
};
var client = new DiagnosticsClient(processId);
using (var session = client.StartEventPipeSession(providers))
{
var source = new EventPipeEventSource(session.EventStream);
source.Dynamic.All += (TraceEvent obj) =>
{
if (obj.EventName.Equals("EventCounters"))
{
var payloadVal = (IDictionary<string, object>)(obj.PayloadValue(0));
var payloadFields = (IDictionary<string, object>)(payloadVal["Payload"]);
if (payloadFields["Name"].ToString().Equals("cpu-usage"))
{
double cpuUsage = Double.Parse(payloadFields["Mean"].ToString());
if (cpuUsage > (double)threshold)
{
client.WriteDump(DumpType.Normal, "/tmp/minidump.dmp");
}
}
}
};
try
{
source.Process();
}
catch (Exception) {}
}
}
}
Cpu-nyomkövetés aktiválása adott számú másodpercre
Ez a minta bemutatja, hogyan aktiválhat egy EventPipe-munkamenetet bizonyos ideig az alapértelmezett CLR nyomkövetési kulcsszóval és a mintaprofilozóval. Ezután beolvassa a kimeneti streamet, és kiírja a bájtokat egy fájlba. Lényegében ez az, ami dotnet-trace belsőleg használ egy nyomkövetési fájl írásához.
using Microsoft.Diagnostics.Tracing;
using Microsoft.Diagnostics.Tracing.Parsers;
using Microsoft.Diagnostics.NETCore.Client;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.Tracing;
using System.IO;
using System.Threading.Tasks;
public partial class Tracer
{
public void TraceProcessForDuration(int processId, int duration, string traceName)
{
var cpuProviders = new List<EventPipeProvider>()
{
new EventPipeProvider("Microsoft-Windows-DotNETRuntime", EventLevel.Informational, (long)ClrTraceEventParser.Keywords.Default),
new EventPipeProvider("Microsoft-DotNETCore-SampleProfiler", EventLevel.Informational, (long)ClrTraceEventParser.Keywords.None)
};
var client = new DiagnosticsClient(processId);
using (var traceSession = client.StartEventPipeSession(cpuProviders))
{
Task copyTask = Task.Run(async () =>
{
using (FileStream fs = new FileStream(traceName, FileMode.Create, FileAccess.Write))
{
await traceSession.EventStream.CopyToAsync(fs);
}
});
Task.WhenAny(copyTask, Task.Delay(TimeSpan.FromMilliseconds(duration * 1000)));
traceSession.Stop();
}
}
}
Diagnosztikai csatornát közzétevő folyamatok nevének nyomtatása
Ez a minta bemutatja, hogyan nyomtathatja ki a diagnosztikai IPC-csatornát közzétevő .NET-folyamatok nevét az API használatával DiagnosticsClient.GetPublishedProcesses .
using Microsoft.Diagnostics.NETCore.Client;
using System;
using System.Diagnostics;
using System.Linq;
public class ProcessTracker
{
public static void PrintProcessStatus()
{
var processes = DiagnosticsClient.GetPublishedProcesses()
.Select(Process.GetProcessById)
.Where(process => process != null);
foreach (var process in processes)
{
Console.WriteLine($"{process.ProcessName}");
}
}
}
Események elemzése valós időben
Ez a minta egy példát mutat be, ahol két feladatot hozunk létre, egyet, amely elemzi az élőben EventPipeEventSource érkező eseményeket, és egyet, amely beolvassa a konzol bemenetét a program végét jelző felhasználói bemenethez. Ha a célalkalmazás kilép, mielőtt a felhasználó lenyomja az entert, az alkalmazás elegánsan kilép. Ellenkező esetben a Stop parancsot elküldi a csőbe, inputTask és elegánsan kilép.
using Microsoft.Diagnostics.NETCore.Client;
using Microsoft.Diagnostics.Tracing;
using Microsoft.Diagnostics.Tracing.EventPipe;
using Microsoft.Diagnostics.Tracing.Parsers;
using System;
using System.Collections.Generic;
using System.Diagnostics.Tracing;
using System.Threading.Tasks;
public partial class Tracer
{
public static void PrintEventsLive(int processId)
{
var providers = new List<EventPipeProvider>()
{
new EventPipeProvider("Microsoft-Windows-DotNETRuntime",
EventLevel.Informational, (long)ClrTraceEventParser.Keywords.Default)
};
var client = new DiagnosticsClient(processId);
using (var session = client.StartEventPipeSession(providers, false))
{
Task streamTask = Task.Run(() =>
{
var source = new EventPipeEventSource(session.EventStream);
source.Clr.All += (TraceEvent obj) => Console.WriteLine(obj.EventName);
try
{
source.Process();
}
// NOTE: This exception does not currently exist. It is something that needs to be added to TraceEvent.
catch (Exception e)
{
Console.WriteLine("Error encountered while processing events");
Console.WriteLine(e.ToString());
}
});
Task inputTask = Task.Run(() =>
{
Console.WriteLine("Press Enter to exit");
while (Console.ReadKey().Key != ConsoleKey.Enter)
{
Task.Delay(TimeSpan.FromMilliseconds(100));
}
session.Stop();
});
Task.WaitAny(streamTask, inputTask);
}
}
}
ICorProfiler-profiler csatolása
Ez a minta bemutatja, hogyan csatolhat egy ICorProfilert egy folyamathoz profilkészítő csatolással.
using System;
using Microsoft.Diagnostics.NETCore.Client;
public class Profiler
{
public static void AttachProfiler(int processId, Guid profilerGuid, string profilerPath)
{
var client = new DiagnosticsClient(processId);
client.AttachProfiler(TimeSpan.FromSeconds(10), profilerGuid, profilerPath);
}
}
