Universe.CpuUsage    

CPU Usage for .NET Core, .NET Framework and Mono on Linux, Windows and macOS

Crossplatform CPU Usage metrics

It receives the amount of time that the current thread(s)/process has executed in kernel and user mode.

Works everywhere: Linux, OSX and Windows.

Targets everywhere: Net Framework 2.0+, Net Standard 1.3+, Net Core 1.0+

Coverage and supported OS

Minimum OS requirements: Linux Kernel 2.6.26, Mac OS 10.9, Windows XP/2003

Autotests using .NET Core and .NET Framework cover:

• Linux x86_64 and Arm 64-bit on appveyor
• Windows Server 2016 on appveyor
• macOS 10.14 on travis-ci.org
• Raspbian 10 Buster on Azure Piplines using self-hosted agent on Raspberry pi

Autotests using Mono:

• Linux x86_64, Arm 64-bit, Arm-v7 32 bit, i386 using mono on travis-ci.org
• Mac OSX 10.10 using travis-ci.org

Manually tested on:

• Windows 7 x86 (.NET Core), Windows 10 ARM64 (.NET Core)
• FreeBSD 12 (both .NET Core and Mono).
• Debian 8 on armv5 (Mono)

Integration tests on exotic platforms

For mono only platforms (i386, ppc64, mips, arm v5/v6, etc) here is the script for integration tests: test-on-mono-only-platforms.sh

url=https://raw.githubusercontent.com/devizer/Universe.CpuUsage/master/test-on-mono-only-platforms.sh;
(wget -q -nv --no-check-certificate -O - $url 2>/dev/null || curl -ksSL $url) | bash

Implementation

The implementation utilizes platform invocation (P/Invoke) of the corresponding system libraries depending on the OS:

Precision depends on

Here is a summary of CPU usage precision. In general, it depends on OS and version and it does not depend on CPU performance except of FreeBSD

Detailed histograms of precision are produced by PrecisionTest.cs

Low level API: class CpuUsage

var onStart = CpuUsage.GetByThread();
... 
var onEnd = CpuUsage.GetByThread();
Console.WriteLine("CPU Usage: " + (onEnd-onStart));

High level API: class CpuUsageAsyncWatcher

public void Configure(IApplicationBuilder app)
{
    // Here is a "middleware" that displays total CPU usage
    // of all the Tasks executed by ASP.NET Core pipeline during each http request
    app.Use(async (context, next) =>
    {
        CpuUsageAsyncWatcher watcher = new CpuUsageAsyncWatcher();
        await next.Invoke();
        watcher.Stop();
        Console.WriteLine($"Cpu Usage by http request is {watcher.GetSummaryCpuUsage()}");
    });
}

Benchmark

Just for illustration here is a comparison to well known DateTime.Now and Stopwatch using benchmark.net. All of them are taken using .NET Core 3.0 runtime.

Linux x64, kernel 4.15

Linux 32 bit @ ARM, kernel 3.4 (Orange PI, H3, 1500 MHz)

macOS 10.14

Windows Server 2016

Legend

• Stopwatch: var sw = new Stopwatch(); var ticks = sw.ElapsedTicks;
• Process CPU Usage: CpuUsageReader.GetByProcess();
• Thread CPU Usage: CpuUsageReader.GetByThread();
• ns - nanosecond, μs - microsecond