Auditing Messages

Component: NServiceBus
NuGet Package NServiceBus (7-pre)
This page targets a pre-release version and is subject to change prior to the final release.

The distributed nature of parallel, message-driven systems make them more difficult to debug than their sequential, synchronous and centralized counterparts. For these reasons, NServiceBus provides built-in message auditing for every endpoint. Configure NServiceBus to audit and it will capture a copy of every received message and forward it to a specified audit queue.

By default Auditing is not enabled and must be configured for each endpoint.

It is recommended to specify a central auditing queue for all related endpoints (i.e. endpoints that belong to the same system). This gives an overview of the entire system in one place and see how messages correlate. One can look at the audit queue as a central record of everything that is happening in the system. A central audit queue is also required by the Particular Service Platform and especially ServiceControl, which consumes messages from these auditing queues. For more information, see ServicePulse documentation.

Message headers

The audited message is enriched with additional headers, which contain information related to processing the message:

  • Processing start and end times.
  • Processing host id and name.
  • Processing machine address.
  • Processing endpoint.

Handling Audit messages

Those audit messages can then be handled as needed: Save them in a database, do custom logging, etc. It is important not to leave the messages in the audit queue however, as most queuing technologies have upper-bound limits on their queue sizes and depth. By not processing these messages, the limits of the underlying queue technology may be reached.

Audit configuration options

There two settings that control Auditing:

Queue Name

The queue name to forward audit messages to

OverrideTimeToBeReceived

To force a TimeToBeReceived on audit messages by setting OverrideTimeToBeReceived use the configuration syntax below.

Note that while the phrasing is "forwarding a message" in the implementation it is actually "cloning and sending a new message". This is important when considering TimeToBeReceived since the time taken to receive and process the original message is not part of the TimeToBeReceived of the new audit message. So in effect the audit message receives the full time allotment of whatever TimeToBeReceived is used.

Since MSMQ forces the same TimeToBeReceived on all messages in the a transaction, OverrideTimeToBeReceived is not supported when using the MSMQ Transport. If OverrideTimeToBeReceived is detected when using MSMQ an exception, with the following text, will be thrown:

Setting a custom OverrideTimeToBeReceived for audits is not supported on transactional MSMQ

Default Value

If no OverrideTimeToBeReceived is defined then:

Versions 5 and below: TimeToBeReceived of the original message will be used.

Versions 6 and above: No TimeToBeReceived will be set.

Configuring auditing

Configure the target audit queue using the configuration API.

endpointConfiguration.AuditProcessedMessagesTo("targetAuditQueue");

Related Articles


Last modified