prometheus-net.SystemMetrics 3.1.0

dotnet add package prometheus-net.SystemMetrics --version 3.1.0                
NuGet\Install-Package prometheus-net.SystemMetrics -Version 3.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="prometheus-net.SystemMetrics" Version="3.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add prometheus-net.SystemMetrics --version 3.1.0                
#r "nuget: prometheus-net.SystemMetrics, 3.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install prometheus-net.SystemMetrics as a Cake Addin
#addin nuget:?package=prometheus-net.SystemMetrics&version=3.1.0

// Install prometheus-net.SystemMetrics as a Cake Tool
#tool nuget:?package=prometheus-net.SystemMetrics&version=3.1.0                

prometheus-net SystemMetrics

NuGet version  Build Status

prometheus-net SystemMetrics allows you to export various system metrics (such as CPU usage, disk usage, etc) from your .NET application to Prometheus. It is designed to be a very lightweight alternative to node_exporter, only containing essential metrics. This is useful on systems with limited RAM or where it is easier to add this library to your app instead of deploying a totally separate service.

Usage

Install the prometheus-net.SystemMetrics library using NuGet.

Add the services to your Startup.cs:

using Prometheus.SystemMetrics;

public void ConfigureServices(IServiceCollection services)
{
    // ...
    services.AddSystemMetrics();
}

If you have not already done so, you will also need to expose the Prometheus metrics endpoint by calling MapMetrics in Configure:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapMetrics();
        // ...
    });
}

After doing this, going to /metrics should return the new metrics.

Customization

By default, this will add all the collectors. To only add some collectors, you can instead only render the collectors you want to use:

services.AddSystemMetrics(registerDefaultCollectors: false);
services.AddSystemMetricCollector<CpuUsageCollector>();

Metrics

Where possible, metrics have the same name and format as node_exporter.

CPU

The number of seconds the CPU has spent in each mode (system, user, idle, etc). Available on Linux and Windows. Example data:

node_cpu_seconds_total{cpu="0",mode="system"} 172.35
node_cpu_seconds_total{cpu="0",mode="user"} 292.27
node_cpu_seconds_total{cpu="0",mode="idle"} 30760.4

Disk

The amount of free disk space on all mounts. Available on all platforms. Example data:

# Linux
node_filesystem_avail_bytes{mountpoint="/",fstype="ext4"} 57061916672

# Windows
node_filesystem_avail_bytes{mountpoint="C:\\",fstype="NTFS"} 101531594752

Load Average

Available on Linux. Example data:

node_load1 0.06
node_load5 0.03
node_load15 0.26

Memory

Stats such as available RAM, RAM used by caches, etc. Available on Linux and Windows. Example data:

node_memory_MemAvailable_bytes 1527701504
node_memory_Cached_bytes 572964864
node_memory_MemFree_bytes 961966080
node_memory_MemTotal_bytes 2085904384

Network

Total amount of data sent and received over the network. Available on all platforms. Example data:

node_network_transmit_bytes_total{device="eth0"} 3053723
node_network_receive_bytes_total{device="eth0"} 5822231

Changelog

3.0.0 - 30th November 2023

  • Bumped to .NET 8.0.
  • Bumped prometheus-net dependency to version 8.
  • Wrapped metric collector creation in try-catch so that one collector failing doesn't break the whole app.
  • Updated Windows memory counters so their names more closely match the Linux version. Notably, node_memory_MemFree is now node_memory_MemAvailable_bytes, and node_memory_MemTotal is now node_memory_MemTotal_bytes. Currently, both the old and new counters exist (for backwards compatibility), but the old ones will be removed in the next major version.

2.0.0 - 8th October 2021

  • Added memory and CPU collectors for Windows (thanks to @masterworgen for the initial implementation in PR #3).
  • Added .NET Framework 4.6.2 builds, since prometheus-net itself supports this framework version.

1.0.1 - 17th May 2020

  • Added memory stats for Linux.
  • Added total file size to disk collector.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (13)

Showing the top 5 NuGet packages that depend on prometheus-net.SystemMetrics:

Package Downloads
Oms.Framework

Update page result

Genocs.Metrics

The metrics interface library useful to build .NET Core projects.

Convey.Metrics.Prometheus

Convey.Metrics.Prometheus

NPitaya

A full implementation of pitaya backend framework for .NET

Jakar.Database

Package Description

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on prometheus-net.SystemMetrics:

Repository Stars
slskd/slskd
A modern client-server application for the Soulseek file sharing network.
snatch-dev/Convey
A simple recipe for .NET Core microservices.
Version Downloads Last updated
3.1.0 230,617 1/22/2024
3.0.0 41,164 12/1/2023
2.0.0 1,801,690 8/9/2021
1.0.1 569,102 5/17/2020
1.0.0 1,995 5/15/2020