Structured Logging for Delayed Retry Warnings

[atruskot]

Describe the suggested improvement

Is your improvement related to a problem? Please describe.

Aggregation and reporting of the following warning log message is difficult as the message template isn't formatted as expected.

NServiceBus/src/NServiceBus.Core/Recoverability/DelayedRetry.cs

Line 38 in d7b35c1

Logger.Warn($"Delayed Retry will reschedule message '{message.MessageId}' after a delay of {Delay} because of an exception:", exception);

Describe the suggested solution

Define fields for use in structured logs to be rendered like:

{
    "MessageTemplate": "Delayed Retry will reschedule message '{@MessageId}' after a delay of {@Delay} because of an exception: {@Exception}",
    "RenderedMessage": "Delayed Retry will reschedule message '54376023-b96f-4555-9777-b1b000ea062a' after a delay of 00:00:11.9860000 because of an exception: exception text..",
    "MessageId": "54376023-b96f-4555-9777-b1b000ea062a",
    "Delay": "00:00:11.9860000",
    "Exception": "exception text..."
}

rather than:

{
    "MessageTemplate": "Delayed Retry will reschedule message '54376023-b96f-4555-9777-b1b000ea062a' after a delay of 00:00:11.9860000 because of an exception:",
    "RenderedMessage": "Delayed Retry will reschedule message '54376023-b96f-4555-9777-b1b000ea062a' after a delay of 00:00:11.9860000 because of an exception:",
    "Exception": "exception text..."
}

Describe alternatives you've considered

None.

Additional Context

No response

[tmasternak]

Hi @atruskot, thank you for your feedback. We will consider this during our upcoming enhancement releases.