Oakrey.Applications.Performance 6.0.0

Oakrey.Applications.Performance

A .NET 10 Windows library for real-time CPU and RAM performance monitoring. Usage data is exposed as reactive IObservable streams, with optional automatic logging integration and support for dependency injection.

Main Features

• Real-time CPU usage monitoring exposed as IObservable<int> (percent).
• Real-time RAM usage monitoring exposed as IObservable<int> (MB).
• Aggregated IObservable<PerformanceLog> stream for combined diagnostics.
• Configurable polling interval (default: 1000 ms).
• Optional PerformanceMonitoringLoggingService for automatic structured logging via Oakrey.Log.
• Implements IDisposable for clean resource management.
• Designed for use with dependency injection containers.

Architecture

classDiagram
    class IPerformanceMonitoringService {
        +IObservable~int~ CpuUsage
        +IObservable~int~ RamUsage
        +IObservable~PerformanceLog~ Usage
    }

    class PerformanceMonitoringService {
        +PerformanceMonitoringService(msPeriod)
        +PerformanceMonitoringService()
        +Dispose()
    }

    class PerformanceMonitoringLoggingService {
        +PerformanceMonitoringLoggingService(IPerformanceMonitoringService)
        +Dispose()
        +Preload(CancellationToken)
    }

    IPerformanceMonitoringService <|.. PerformanceMonitoringService
    PerformanceMonitoringLoggingService --> IPerformanceMonitoringService

Requirements

• .NET 10 (Windows)
• Oakrey.Debug.Windows >= 3.0.1
• Oakrey.Log >= 2.0.0
• System.Reactive >= 6.1.0

Installation

.NET CLI

dotnet add package Oakrey.Applications.Performance

Package Manager Console

Install-Package Oakrey.Applications.Performance

NuGet Package Manager

Search for Oakrey.Applications.Performance under Tools > NuGet Package Manager > Manage NuGet Packages for Solution.

Configuration

PerformanceMonitoringService accepts an optional polling interval in milliseconds. The default is 1000 ms.

// Default interval (1000 ms)
IPerformanceMonitoringService monitor = new PerformanceMonitoringService();

// Custom interval
IPerformanceMonitoringService monitor = new PerformanceMonitoringService(msPeriod: 500);

Example Usage

Subscribe to individual streams

using Oakrey.Applications.Performance;

using PerformanceMonitoringService monitor = new PerformanceMonitoringService(msPeriod: 1000);

monitor.CpuUsage.Subscribe(cpu => Console.WriteLine($"CPU: {cpu}%"));
monitor.RamUsage.Subscribe(ram => Console.WriteLine($"RAM: {ram} MB"));

Subscribe to the combined log stream

monitor.Usage.Subscribe(log => Console.WriteLine($"CPU: {log.CPU}%, RAM: {log.RAM} MB"));

Dependency injection registration

services.AddSingleton<IPerformanceMonitoringService>(
    _ => new PerformanceMonitoringService(msPeriod: 1000));

// Optional: automatic logging on each tick
services.AddSingleton<PerformanceMonitoringLoggingService>();

Development Notes

• The project targets net10.0-windows and relies on Windows-specific performance counter APIs via Oakrey.Debug.Windows.
• PerformanceMonitoringLoggingService implements IPreLoadable, which integrates with the Oakrey application startup pipeline.
• All observable subjects are BehaviorSubject<int>, so new subscribers immediately receive the last known value.
• Always dispose PerformanceMonitoringService when the application shuts down to release the underlying PerformanceMonitor.

Project Information

License

This project is licensed under the MIT License.