ErrorDock.Wpf 0.1.0-rc.1

ErrorDock.Wpf

ErrorDock for WPF. Crashes, handled failures, feature usage and sessions, sent to ErrorDock — with a queue that survives a machine with no network.

dotnet add package ErrorDock.Wpf

Targets net472 and net8.0-windows, so it runs on .NET Framework 4.7.2 and on .NET 8, 9 and 10 alike.

Getting started

using ErrorDock;

public partial class App : Application
{
    protected override void OnStartup(StartupEventArgs e)
    {
        ErrorDockWpf.Install(this, options =>
        {
            options.ApiKey = "ed_app_…";
            options.Endpoint = "https://api.errordock.com";
            options.Release = typeof(App).Assembly.GetName().Version?.ToString();
        });

        base.OnStartup(e);
    }
}

That one call starts the SDK, turns session tracking on, installs the handlers below, and flushes on Application.Exit.

Use an application key

Use an ed_app_ key, created in the project's settings. Not ed_live_: a server key is a secret, and a secret inside an installer is a secret every one of your users holds. Not ed_pub_ either — a browser key is fenced by an origin allowlist, and a desktop process sends no Origin header, so the fence would reject every request it ever made.

An ed_app_ key is write-only. The worst a leaked one buys somebody is the ability to send you junk, which the rate limit and your quota both bound. Rotating one means shipping a release, so treat the decision to rotate as a release decision.

What it catches

The rule behind all four: ErrorDock observes, it does not decide. A monitoring SDK that quietly keeps an application alive has changed the behaviour it was installed to watch.

Sessions and users

A launch is a visit. Sessions rotate after 30 minutes of inactivity, at 24 hours, and at UTC midnight, which is what makes crash-free rate, daily active users and app opens mean the same thing here as in a browser.

Users are counted by an install id: one GUID written once beside the queue, hashed by the server. Nothing that identifies the machine or the person is collected — no machine name, no Windows username, no domain, no MAC address.

Window activation already counts as activity — this package subscribes to Application.Activated for you — so a session does not roll over while somebody reads a screen for forty minutes. ErrorDockWpf.ReportActivity() is there for anything else that should count.

Reporting

// A timed execution with an outcome — the denominator of the feature error rate.
var receipt = ErrorDockSdk.Client.RunFeature("checkout", () => _payments.Charge(order));

ErrorDockSdk.Client.CaptureException(ex, "Order could not be paid");
ErrorDockSdk.Client.TrackInteraction("pay-clicked", "CheckoutButton");

Interactions are always explicit. This package could subscribe to every click in your application and does not, because that is the fastest way to turn your quota into a mouse log.

Offline

A crash on a machine with no network is written to disk and delivered on the next launch, with the timestamp it originally had — so it is attributed to the release that produced it and lands on the right day. Events older than 24 hours are dropped rather than sent, because the server would rewrite their timestamps and file them under today. See ErrorDock.Core for the knobs.

Licence

MIT. The ErrorDock service itself is proprietary; this SDK is not.