QueueHawk.Agent configuration reference

builder.Services.AddQueueHawk(options =>
{
    options.ApiKey = builder.Configuration["QueueHawk:ApiKey"];
    options.Environment = "Production";
    // every option below is optional and has a sensible default
});

Job payloads: off by default

IncludeJobPayloads controls whether the actual argument values passed into a Hangfire job — not just its type and method name — are sent to QueueHawk. It defaults to false because job arguments routinely carry customer data: a SendInvoice(Guid customerId, decimal amount) job's arguments are exactly the kind of thing that shouldn't leave your infrastructure without a deliberate decision to send it. Turning it on is global, not per job type — there's currently no way to opt in for one job type and not another.

Redacting exception content with OnBeforeSend

Job payloads and exception content are handled differently on purpose. Exception messages and stack traces are sent by default (only length-truncated via MaxStackTraceLength) — an alert with no exception detail isn't much of an alert. But an exception message is free text written by whatever code threw it, and it can occasionally echo something sensitive: a validation error that quotes a rejected email address, a database constraint violation that includes a row's key, a third-party SDK that logs a request URL with a query string attached.

OnBeforeSend is the hook for that case — a Func<JobEventDto, JobEventDto?> called for every captured state-change event, before it's written to the local buffer:

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

    options.OnBeforeSend = jobEvent =>
    {
        // only Failed events carry exception content
        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]"),
        };
    };
});

• Runs for every state-change event, not only failures — check jobEvent.ExceptionMessage/jobEvent.State to scope your logic to failed jobs.
• Return null to drop the event entirely — nothing is buffered or sent for that state change.
• Never breaks your job pipeline: an exception thrown from your callback drops that one event, but is caught the same way every other agent operation is (see below) rather than propagating into Hangfire.
• Runs before the local ring buffer, not right before the HTTPS call — a redacted field is never briefly held unredacted in your process's memory.

Longer write-up with more examples: Keeping PII out of exception messages before they ever leave your app.

Reliability guarantees that apply regardless of configuration

These aren't configurable — they're architectural properties of the agent that hold no matter how the options above are set: