Plugin.Maui.Observability
1.0.0
See the version list below for details.
dotnet add package Plugin.Maui.Observability --version 1.0.0
NuGet\Install-Package Plugin.Maui.Observability -Version 1.0.0
<PackageReference Include="Plugin.Maui.Observability" Version="1.0.0" />
<PackageVersion Include="Plugin.Maui.Observability" Version="1.0.0" />
<PackageReference Include="Plugin.Maui.Observability" />
paket add Plugin.Maui.Observability --version 1.0.0
#r "nuget: Plugin.Maui.Observability, 1.0.0"
#:package Plugin.Maui.Observability@1.0.0
#addin nuget:?package=Plugin.Maui.Observability&version=1.0.0
#tool nuget:?package=Plugin.Maui.Observability&version=1.0.0
Plugin.Maui.Observability
The umbrella telemetry layer for the NugetWorld MAUI plugins.
One registration call. One signal stream. Any backend.
App
├── Network
├── API
├── Upload
├── Sync
├── Background
├── Device
└── Crash
UseMauiObservability() registers the pipeline and the seven plugins underneath it, then fans every health, network, API, upload, sync, background, device, and crash event into a single export path.
Install
dotnet add package Plugin.Maui.Observability
Target frameworks: net10.0, net10.0-android, net10.0-ios.
The package depends on:
- Plugin.Maui.AppHealth
- Plugin.Maui.NetworkMonitor
- Plugin.Maui.ApiResilience
- Plugin.Maui.BackgroundTasks
- Plugin.Maui.OfflineSync
- Plugin.Maui.SmartUpload
- Plugin.Maui.DeviceSession
Quick start
using Plugin.Maui.Observability;
public static class MauiProgram
{
public static MauiApp CreateMauiApp()
{
var builder = MauiApp.CreateBuilder();
builder
.UseMauiApp<App>()
.UseMauiObservability();
return builder.Build();
}
}
Services-only (pipeline + exporters; plugin bridges attach when those services are already registered):
builder.Services.AddMauiObservability();
Resolve IMauiObservability from dependency injection, or use MauiObservability.Current.
MauiObservability.TrackEvent(TelemetryDomain.Api, "checkout.started");
MauiObservability.TrackException(exception);
Console.WriteLine(MauiObservability.FormatTree());
await MauiObservability.FlushAsync();
What you get
| Branch | Source | Signals |
|---|---|---|
| App | AppHealth + process lifecycle | Health status, findings, foreground / background |
| Network | NetworkMonitor | Internet, captive portal, Wi-Fi vs cellular |
| API | ApiResilience + optional HTTP handler | Retry, circuit, timeout, offline queue, token refresh |
| Upload | SmartUpload | Progress, state, completion, failure |
| Sync | OfflineSync | Status, push/pull counts, conflicts |
| Background | BackgroundTasks | Started, completed, failed |
| Device | DeviceSession | Device id, installation, session start/end |
| Crash | Built-in | Unhandled exceptions, unobserved tasks, Android uncaught Java exceptions |
Already registered plugins are reused. Missing ones are registered for you when RegisterPlugins is true (the default on UseMauiObservability).
Export
builder.UseMauiObservability(options =>
{
options.ServiceName = "shop";
options.Export.Console = true;
options.Export.OpenTelemetry = true;
options.Export.OpenTelemetryEndpoint = new Uri("http://localhost:4318/v1/traces");
options.Export.ApplicationInsightsConnectionString = appInsights;
options.Export.SentryDsn = sentryDsn;
options.Export.DatadogApiKey = datadogKey;
options.Export.DatadogSite = "datadoghq.com";
options.Export.HttpEndpoint = new Uri("https://telemetry.example/ingest");
options.Export.HttpHeaders["X-Api-Key"] = "secret";
});
| Exporter | How it works |
|---|---|
| Console | Writes HH:mm:ss Domain Severity Name lines. On by default. |
| OpenTelemetry | Emits Activity + Meter instruments named Plugin.Maui.Observability. An existing OTel SDK picks them up. Optional JSON POST to OpenTelemetryEndpoint. |
| Application Insights | POSTs to /v2/track using a connection string or instrumentation key. |
| Sentry | POSTs store events parsed from a DSN. |
| Datadog | POSTs to the HTTP logs intake (DD-API-KEY). |
| Custom HTTP | POSTs { "serviceName", "signals": [ ... ] }. |
Add your own destination:
options.Exporters.Add(new MyExporter());
ITelemetryExporter.ExportAsync is best-effort. Failures never throw into the app.
Manual tracking
observability.TrackEvent(TelemetryDomain.App, "login.success");
observability.TrackMetric(TelemetryDomain.Upload, "upload.progress", 0.42);
observability.TrackSpan(TelemetryDomain.Api, "api.success", TimeSpan.FromMilliseconds(120));
observability.TrackException(exception, TelemetryDomain.Api, fatal: false);
Automatic API spans
builder.Services.AddHttpClient("shop", client =>
{
client.BaseAddress = new Uri("https://api.shop");
}).AddObservabilityHandler();
The handler writes api.request, api.success, and api.failure. Query paths are used without the query string.
The tree
var snapshot = observability.Snapshot;
snapshot.Network.HasInternet;
snapshot.Api.Circuit;
snapshot.Upload.ActiveCount;
snapshot.Sync.LastPushed;
snapshot.Device.SessionId;
snapshot.Crash.LastType;
observability.FormatTree();
App Healthy
├── Network Online WiFi
├── API Closed retries=0
├── Upload 0 active
├── Sync Idle
├── Background Idle
├── Device session 1
└── Crash none
Configure plugins
builder.UseMauiObservability(options =>
{
options.Plugins.OfflineSync = true;
options.Plugins.ConfigureOfflineSync = sync =>
{
sync.UseInMemoryStore = false;
sync.RemoteBaseAddress = new Uri("https://api.shop/sync");
};
options.Plugins.ConfigureAppHealth = health =>
{
health.LowBatteryPercent = 15;
};
options.Plugins.SmartUpload = false; // keep the package, skip this branch
});
Set options.RegisterPlugins = false when you already call UseAppHealth(), AddNetworkMonitor(), and the rest yourself. Bridges still attach to whatever is in the container.
Without the generic host
var observability = MauiObservability.Create(new MauiObservabilityOptions
{
Export = { Console = true }
});
observability.Start();
Platform notes
Android — declare network access if the host app does not already:
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
iOS — no extra Info.plist keys for the pipeline itself. Child plugins may require their own entries (background tasks, background sync).
| Android | iOS | net10.0 |
|
|---|---|---|---|
| Unified pipeline / exporters | Yes | Yes | Yes (tests) |
| Plugin auto-registration | Yes | Yes | Yes |
| Unhandled / unobserved exceptions | Yes | Yes | Yes |
| Native uncaught Java exceptions | Yes | — | — |
Sample
samples/Plugin.Maui.Observability.Sample shows the live domain tree and a timeline. Buttons emit Network, API, Upload, Sync, Background, Device, and Crash signals.
dotnet build src/Plugin.Maui.Observability/Plugin.Maui.Observability.csproj
dotnet pack src/Plugin.Maui.Observability/Plugin.Maui.Observability.csproj -c Release -o artifacts
dotnet test tests/Plugin.Maui.Observability.Tests/Plugin.Maui.Observability.Tests.csproj
dotnet build samples/Plugin.Maui.Observability.Sample/Plugin.Maui.Observability.Sample.csproj -f net10.0-android
Pack from source
dotnet pack src/Plugin.Maui.Observability/Plugin.Maui.Observability.csproj -c Release -o artifacts
The .nupkg is written to artifacts/Plugin.Maui.Observability.1.0.0.nupkg.
License
MIT
Support
If this plugin saved you a weekend of native plumbing, consider buying me a coffee. Your support keeps it maintained, documented, and free.
This library stays open source. A coffee helps cover time for bug fixes, new features, and docs.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-android36.0 is compatible. net10.0-browser was computed. net10.0-ios was computed. net10.0-ios26.0 is compatible. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Microsoft.Extensions.Http (>= 10.0.2)
- Plugin.Maui.ApiResilience (>= 1.0.0)
- Plugin.Maui.AppHealth (>= 1.0.0)
- Plugin.Maui.BackgroundTasks (>= 1.0.0)
- Plugin.Maui.DeviceSession (>= 1.0.0)
- Plugin.Maui.NetworkMonitor (>= 1.0.0)
- Plugin.Maui.OfflineSync (>= 1.0.1)
- Plugin.Maui.SmartUpload (>= 1.0.0)
-
net10.0-android36.0
- Microsoft.Extensions.Http (>= 10.0.2)
- Plugin.Maui.ApiResilience (>= 1.0.0)
- Plugin.Maui.AppHealth (>= 1.0.0)
- Plugin.Maui.BackgroundTasks (>= 1.0.0)
- Plugin.Maui.DeviceSession (>= 1.0.0)
- Plugin.Maui.NetworkMonitor (>= 1.0.0)
- Plugin.Maui.OfflineSync (>= 1.0.1)
- Plugin.Maui.SmartUpload (>= 1.0.0)
-
net10.0-ios26.0
- Microsoft.Extensions.Http (>= 10.0.2)
- Plugin.Maui.ApiResilience (>= 1.0.0)
- Plugin.Maui.AppHealth (>= 1.0.0)
- Plugin.Maui.BackgroundTasks (>= 1.0.0)
- Plugin.Maui.DeviceSession (>= 1.0.0)
- Plugin.Maui.NetworkMonitor (>= 1.0.0)
- Plugin.Maui.OfflineSync (>= 1.0.1)
- Plugin.Maui.SmartUpload (>= 1.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Initial release. Unified MAUI telemetry pipeline over AppHealth, NetworkMonitor, ApiResilience, BackgroundTasks, OfflineSync, SmartUpload, and DeviceSession, with OpenTelemetry, Application Insights, Sentry, Datadog, Console, and HTTP exporters.