From 26b2b024d59624c5a89b0ba037f067cef172b3dc Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Fri, 13 Dec 2024 16:28:13 +0100 Subject: [PATCH 1/5] Document ServiceControl headers --- nservicebus/messaging/headers.md | 36 ++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/nservicebus/messaging/headers.md b/nservicebus/messaging/headers.md index 88e91eb643e..d20e1d1561b 100644 --- a/nservicebus/messaging/headers.md +++ b/nservicebus/messaging/headers.md @@ -486,3 +486,39 @@ snippet: HeaderWriterDataBusConvention #### Example body snippet: HeaderWriterDataBusConventionBody + +## ServiceControl + +### ServiceControl.TargetEndpointAddress + +Used by messageging bridge to return the message back to the correct queue if the failed message reach + +### ServiceControl.Retry.AcknowledgementQueue + +Value:Queue name + +The queue to send an acknowledgement system message back to a specific ServiceControl queue to mark a retried message as processed. + + +### ServiceControl.Retry.StagingId + +?? + +### ServiceControl.Retry.Attempt.MessageId + +?? + +### ServiceControl.Retry.Successful + +Contains a timestamp in the format `yyyy-MM-dd HH:mm:ss:ffffff Z` to indicate when a message was succesfully processed. + +Part of the control message send back to ServiceControl to signal that a message that was manually retried in ServicePulse/Control and flag as processed succesful. + +### ServiceControl.Retry.UniqueMessageId + +Contains the [NServiceBus.MessageId](#messaging-interaction-headers-nservicebusmessageid) value of the message that was succesfully processed. + +Part of the control message send back to + + +The presence of any header key that starts with `ServiceControl.` would indicate its a message that is manually retried. \ No newline at end of file From 3d86682ec0c22de74387378ba888ccb450837678 Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Fri, 13 Dec 2024 16:34:39 +0100 Subject: [PATCH 2/5] Added ServiceControl.RetryTo --- nservicebus/messaging/headers.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/nservicebus/messaging/headers.md b/nservicebus/messaging/headers.md index d20e1d1561b..92e05003330 100644 --- a/nservicebus/messaging/headers.md +++ b/nservicebus/messaging/headers.md @@ -489,23 +489,36 @@ snippet: HeaderWriterDataBusConventionBody ## ServiceControl +### ServiceControl.RetryTo + +Value: Queue name + +When present in a failed message to ServiceControl, ServiceControl will send the message to this queue instead of the queue name value from [NServiceBus.FailedQ](#error-forwarding-headers-nservicebusfailedq) + +This is used by the ServiceControl transport adapter to bridge failed messages between different transports. + ### ServiceControl.TargetEndpointAddress +Value: Queue name Used by messageging bridge to return the message back to the correct queue if the failed message reach ### ServiceControl.Retry.AcknowledgementQueue -Value:Queue name +Value: Queue name The queue to send an acknowledgement system message back to a specific ServiceControl queue to mark a retried message as processed. ### ServiceControl.Retry.StagingId +Value: UUID + ?? ### ServiceControl.Retry.Attempt.MessageId +Value: UUID ?? + ?? ### ServiceControl.Retry.Successful From 930d64b043cdef630bfdf3728da1005ac11ec00f Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Wed, 18 Dec 2024 13:00:59 +0100 Subject: [PATCH 3/5] Remove headers not present in messages to/from endpoints --- nservicebus/messaging/headers.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/nservicebus/messaging/headers.md b/nservicebus/messaging/headers.md index 92e05003330..af5efc2be9b 100644 --- a/nservicebus/messaging/headers.md +++ b/nservicebus/messaging/headers.md @@ -508,19 +508,6 @@ Value: Queue name The queue to send an acknowledgement system message back to a specific ServiceControl queue to mark a retried message as processed. - -### ServiceControl.Retry.StagingId - -Value: UUID - -?? - -### ServiceControl.Retry.Attempt.MessageId - -Value: UUID ?? - -?? - ### ServiceControl.Retry.Successful Contains a timestamp in the format `yyyy-MM-dd HH:mm:ss:ffffff Z` to indicate when a message was succesfully processed. From 17b40a5975b729f32b42737505429b2ed1a1905b Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Wed, 18 Dec 2024 13:13:05 +0100 Subject: [PATCH 4/5] Fix anchor --- nservicebus/messaging/headers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nservicebus/messaging/headers.md b/nservicebus/messaging/headers.md index af5efc2be9b..8f3e8d155f2 100644 --- a/nservicebus/messaging/headers.md +++ b/nservicebus/messaging/headers.md @@ -516,7 +516,7 @@ Part of the control message send back to ServiceControl to signal that a message ### ServiceControl.Retry.UniqueMessageId -Contains the [NServiceBus.MessageId](#messaging-interaction-headers-nservicebusmessageid) value of the message that was succesfully processed. +Contains the [NServiceBus.MessageId](#messaging-interaction-headers-nservicebus-messageid) value of the message that was succesfully processed. Part of the control message send back to From 519b21bf45025e0eed7ab67f3fd341717cd3f491 Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Wed, 18 Dec 2024 13:18:02 +0100 Subject: [PATCH 5/5] Fix anchor --- nservicebus/messaging/headers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nservicebus/messaging/headers.md b/nservicebus/messaging/headers.md index 8f3e8d155f2..59ede98354d 100644 --- a/nservicebus/messaging/headers.md +++ b/nservicebus/messaging/headers.md @@ -493,7 +493,7 @@ snippet: HeaderWriterDataBusConventionBody Value: Queue name -When present in a failed message to ServiceControl, ServiceControl will send the message to this queue instead of the queue name value from [NServiceBus.FailedQ](#error-forwarding-headers-nservicebusfailedq) +When present in a failed message to ServiceControl, ServiceControl will send the message to this queue instead of the queue name value from [NServiceBus.FailedQ](#error-forwarding-headers-nservicebus-failedq) This is used by the ServiceControl transport adapter to bridge failed messages between different transports.