QueueHawk.Agent Konfigurationsreferenz

builder.Services.AddQueueHawk(options =>
{
    options.ApiKey = builder.Configuration["QueueHawk:ApiKey"];
    options.Environment = "Production";
    // jede Option unten ist optional und hat einen sinnvollen Default
});

Job-Payloads: standardmässig aus

IncludeJobPayloads steuert, ob die tatsächlichen Argumentwerte eines Hangfire-Jobs — nicht nur Typ und Methodenname — an QueueHawk gesendet werden. Standardmässig false, da Job-Argumente regelmässig Kundendaten enthalten: die Argumente eines SendInvoice(Guid customerId, decimal amount)-Jobs sind genau die Art von Daten, die die eigene Infrastruktur nicht ohne bewusste Entscheidung verlassen sollten. Das Aktivieren ist global, nicht pro Job-Typ — aktuell gibt es keinen Weg, es für einen Job-Typ zu aktivieren und für einen anderen nicht.

Exception-Inhalte zensieren mit OnBeforeSend

Job-Payloads und Exception-Inhalte werden bewusst unterschiedlich behandelt. Exception-Messages und Stacktraces werden standardmässig gesendet (nur längen-gekürzt via MaxStackTraceLength) — ein Alert ohne Exception-Detail ist kaum ein Alert. Aber eine Exception-Message ist Freitext, geschrieben vom werfenden Code, und kann gelegentlich etwas Sensibles wiedergeben: eine Validierungs-Exception, die eine abgelehnte E-Mail-Adresse zitiert, eine Datenbank-Constraint-Verletzung, die den Schlüssel einer Zeile enthält, ein Third-Party-SDK, das eine Request-URL samt Query-String protokolliert.

OnBeforeSend ist der Hook für diesen Fall — ein Func<JobEventDto, JobEventDto?>, aufgerufen für jedes erfasste State-Change-Event, bevor es in den lokalen Puffer geschrieben wird:

builder.Services.AddQueueHawk(options =>
{
    options.ApiKey = builder.Configuration["QueueHawk:ApiKey"];
    options.Environment = "Production";

    options.OnBeforeSend = jobEvent =>
    {
        // nur Failed-Events tragen Exception-Inhalte
        if (jobEvent.ExceptionMessage is null)
        {
            return jobEvent;
        }

        return jobEvent with
        {
            ExceptionMessage = Regex.Replace(
                jobEvent.ExceptionMessage,
                @"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}",
                "[REDACTED-EMAIL]"),
        };
    };
});

• Läuft für jedes State-Change-Event, nicht nur für Fehlschläge — jobEvent.ExceptionMessage/jobEvent.State prüfen, um die eigene Logik auf fehlgeschlagene Jobs zu beschränken.
• null zurückgeben, um das Event komplett zu verwerfen — für diesen State-Change wird dann nichts gepuffert oder gesendet.
• Bricht den Job-Pfad nie: eine im eigenen Callback geworfene Exception verwirft nur dieses eine Event, wird aber genauso abgefangen wie jede andere Agent-Operation (siehe unten), statt in Hangfire zu propagieren.
• Läuft vor dem lokalen Ring-Buffer, nicht erst kurz vor dem HTTPS-Aufruf — ein zensiertes Feld liegt dadurch nie kurzzeitig unzensiert im Speicher des eigenen Prozesses.

Ausführlicherer Artikel mit weiteren Beispielen: Personenbezogene Daten aus Exception-Messages fernhalten, bevor sie die App verlassen.

Zuverlässigkeits-Garantien, unabhängig von der Konfiguration

Diese sind nicht konfigurierbar — es sind architektonische Eigenschaften des Agenten, die unabhängig davon gelten, wie die obigen Optionen gesetzt sind: