Plugin.Maui.AppHealth 1.0.0

Plugin.Maui.AppHealth

NuGet · GitHub

Detect app, device, and environment problems in .NET MAUI on Android and iOS.

Instead of reading battery, storage, memory, thermal, and connectivity APIs in every feature, you inspect once and get a structured report:

• Overall status: Healthy, Degraded, or Unhealthy
• Findings with stable codes such as battery.low and network.offline
• Raw environment measurements for dashboards and support screens
• Optional watching so the app reacts when conditions change

Install

Package: https://www.nuget.org/packages/Plugin.Maui.AppHealth

dotnet add package Plugin.Maui.AppHealth

Or reference the project:

<ProjectReference Include="..\src\Plugin.Maui.AppHealth\Plugin.Maui.AppHealth.csproj" />

Target frameworks:

• net10.0 (unit tests / shared)
• net10.0-android
• net10.0-ios

Register the plugin

builder
    .UseMauiApp<App>()
    .UseAppHealth(options =>
    {
        options.EnableLogging = true;
        options.LowBatteryPercent = 20;
        options.CriticalBatteryPercent = 5;
        options.LowStorageMegabytes = 512;
        options.CriticalStorageMegabytes = 128;
        options.HighMemoryPercent = 80;
        options.CriticalMemoryPercent = 92;
        options.WatchInterval = TimeSpan.FromSeconds(30);

        // Optional: warn when the OS is older than your support policy.
        options.MinimumAndroidVersion = new Version(8, 0);
        options.MinimumIosVersion = new Version(16, 0);

        // All check groups start enabled.
        options.Checks.Thermal = true;
        options.Checks.Network = true;
    });

Resolve IAppHealth from dependency injection, or use AppHealth.Current.

Inspect now

var report = await AppHealth.Current.InspectAsync();

if (!report.IsHealthy)
{
    foreach (var finding in report.Findings)
    {
        // finding.Code, finding.Severity, finding.Title, finding.Suggestion
    }
}

if (report.Has(HealthCodes.NetworkOffline))
{
    // Queue work until connectivity returns.
}

Limit the run to one or more groups:

await AppHealth.Current.InspectAsync(new InspectOptions
{
    Only = [HealthCheckKind.Battery, HealthCheckKind.Network]
});

report.Environment includes charge percent, free storage, memory, thermal state, connectivity, device model, and app version.

Watch for changes

AppHealth.Current.HealthChanged += (_, e) =>
{
    StatusLabel.Text = e.Current.Status.ToString();
};

AppHealth.Current.FindingChanged += (_, e) =>
{
    foreach (var added in e.Added)
        Log($"NEW {added.Code}");
};

AppHealth.Current.StartWatching();

Watching re-inspects when battery, energy saver, connectivity, thermal, or memory-warning events fire, and also on WatchInterval.

AppHealth.Current.StartWatching(new WatchOptions
{
    Interval = TimeSpan.FromSeconds(15),
    Only = [HealthCheckKind.Network, HealthCheckKind.Thermal]
});

Call StopWatching() when the page disappears.

What you get

Status aggregation:

• Any critical finding → Unhealthy
• Otherwise any warning → Degraded
• Info findings do not change status

Stable codes live on HealthCodes so you can switch without parsing titles.

Host app setup

The plugin reads platform APIs. The host app should declare network state access on Android.

Android

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

Thermal status is available on Android 10 (API 29) and later. Older devices skip that signal.

iOS

No extra Info.plist keys are required for battery, storage, thermal, or connectivity.

Platform notes

Sample

samples/AppHealth.Sample inspects the device, lists findings, and watches for changes.

dotnet build src/Plugin.Maui.AppHealth/Plugin.Maui.AppHealth.csproj
dotnet pack src/Plugin.Maui.AppHealth/Plugin.Maui.AppHealth.csproj -c Release
dotnet test tests/Plugin.Maui.AppHealth.Tests/Plugin.Maui.AppHealth.Tests.csproj
dotnet build samples/AppHealth.Sample/AppHealth.Sample.csproj -f net10.0-android

Pack

dotnet pack src/Plugin.Maui.AppHealth/Plugin.Maui.AppHealth.csproj -c Release

Packages are written to artifacts/.