Skip to content

Commit b778b45

Browse files
authored
legacy docs review (#7209)
* legacy docs review
1 parent 449e4e3 commit b778b45

File tree

3 files changed

+19
-20
lines changed

3 files changed

+19
-20
lines changed

nservicebus/bridge/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Messaging Bridge
33
summary: Connect endpoints in a system that use different transports with the messaging bridge
4-
reviewed: 2023-07-04
4+
reviewed: 2025-06-13
55
component: Bridge
66
related:
77
- samples/bridge/simple
@@ -11,7 +11,7 @@ related:
1111

1212
The NServiceBus Messaging Bridge allows NServiceBus endpoints to connect to other endpoints that are not using the same transport using the [Messaging Bridge Pattern](https://www.enterpriseintegrationpatterns.com/patterns/messaging/MessagingBridge.html).
1313

14-
The bridge is transparent when sending and receiving endpoints. Therefore, endpoints are unaware that a bridge transfers messages to a different transport. Endpoints send and receive messages to and from logical endpoints as if no bridge was involved.
14+
The bridge is transparent to both sending and receiving endpoints. Endpoints are unaware that messages are being transferred across different transports. They send and receive messages to and from logical endpoints as if no bridge were involved.
1515

1616
> [!NOTE]
1717
> The bridge package version is not tied to any specific version of NServiceBus. Therefore, the latest version of the Messaging Bridge package should be used, independent of the NServiceBus version used in any endpoints.

nservicebus/bridge/scenarios.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
---
22
title: Usage scenarios
33
summary: Scenarios in which the NServiceBus Messaging Bridge can be used in a system
4-
reviewed: 2023-07-04
4+
reviewed: 2025-06-13
55
component: Bridge
66
---
7-
Several scenarios can be achieved when using the NServiceBus Messaging Bridge, including:
7+
The NServiceBus Messaging Bridge supports several key scenarios, including:
88

99
- Migrating a system from one transport to another transport
10-
- Using different transports in a microservices environment where each service uses the transport that provides the most benefit for it
11-
- Using multiple instances of the same transport, differentiated by some distinguishing factor (e.g. Azure Service Bus namespaces, or SQL Server database instances)
10+
- Using different transports in a microservices architecture, allowing each service to choose the most suitable transport
11+
- Connecting multiple instances of the same transport, such as different Azure Service Bus namespaces or separate SQL Server database instances
1212

1313
## Migrate to a different transport
1414

1515
Migrating from one transport to another can be a complex task. In-flight messages (i.e. ones that have been sent but not yet processed) must be accounted for at all times. Some common examples of in-flight messages:
1616

17-
- In a queue, waiting to be processed by an instance of the logical endpoint
18-
- In the error queue, waiting to be retried (or picked up by ServiceControl)
19-
- In ServiceControl, waiting to be retried
17+
- Messages in a queue, waiting to be processed by an instance of the logical endpoint
18+
- Messages in the error queue, waiting to be retried (or picked up by ServiceControl)
19+
- Messages in ServiceControl, waiting to be retried
2020

21-
When a plan is created to move or sunset an endpoint, re-configuring the routing for any endpoint is straightforward and NServiceBus takes care of new messages sent after the endpoint is re-deployed on the new transport. However in-flight messages must be carefully considered and action must be taken to ensure these messages arrive at the correct destination, which is not always the place where these messages were originally sent to.
21+
When planning to move or retire an endpoint, re-configuring the routing for any endpoint is straightforward. NServiceBus automatically handles new messages sent after the endpoint is redeployed on the new transport. However in-flight messages must be carefully considered to ensure these messages arrive at the correct destination, which is not always the place where these messages were originally sent to.
2222

23-
Take the scenario where a system migrates from the MSMQ transport to the SQL Server transport. Converting the endpoints to use SQL Server all at once would be difficult, as all in-flight messages would be stuck in MSMQ. Instead, the NServiceBus messaging bridge can provide a way to migrate these endpoints one-by-one.
23+
For example, consider a system migrating from the MSMQ transport to SQL Server. Migrating all endpoints at once is risky, as in-flight messages would remain stuck in MSMQ. Instead, the NServiceBus Messaging Bridge allows endpoints to be migrated incrementally, enabling safe and controlled transitions between transports.
2424

2525
### Initial situation
2626

27-
Taking a sample migration scenario, assume there are four endpoints that can communicate with each other via messaging. Each endpoint can communicate with the others, but for simplicity the number of arrows between them are reduced.
27+
Consider a sample migration scenario system with four endpoints that communicate with each other via messaging. Initially, all four endpoints use the MSMQ transport. Each endpoint can communicate with the others, but for simplicity the number of arrows between them are reduced.
2828

2929
```mermaid
3030
flowchart LR
@@ -35,7 +35,7 @@ B[Endpoint B] <---> D[Endpoint D]
3535

3636
### Initiating the migration
3737

38-
To slowly migrate endpoints to the other transport and to prevent moving all endpoints at once, the migration will start with two endpoints and move them to the SQL Server transport.
38+
To slowly migrate endpoints to the other transport say SQL Server and to prevent moving all endpoints at once, the migration will start with two endpoints and move them to the SQL Server transport.
3939

4040
```mermaid
4141
flowchart LR
@@ -54,22 +54,21 @@ subgraph sql
5454
D
5555
end
5656
```
57-
58-
In this scenario, a new endpoint is introduced which will act as the bridge. The bridge is configured with two instances of `BridgeTransport`, one for MSMQ and one for SQL Server. The MSMQ `BridgeTransport` is configured to have `EndpointA` and `EndpointB` and the SQL Server `BridgeTransport` is configured to have `EndpointC` and `EndpointD`. If any events are involved, the publishers for those [must be configured](/nservicebus/bridge/configuration.md#registering-publishers).
57+
In this scenario, a new endpoint is introduced which will act as the bridge. The bridge is configured with two instances of `BridgeTransport`, one for MSMQ and one for SQL Server. The MSMQ `BridgeTransport` is configured to have `EndpointA` and `EndpointB` and the SQL Server `BridgeTransport` is configured to have `EndpointC` and `EndpointD`. If any events are involved, the publishers for those [must be configured](/nservicebus/bridge/configuration.md#registering-publishers) to ensure proper message routing.
5958

6059
### Finishing the migration
6160

62-
Eventually the last endpoints can be moved over. It is then possible to configure the bridge to have all endpoints on the SQL Server transport, so the in-flight messages that are retried and returned to their logical endpoint, end up at the bridge and are moved over to the SQL Server transport by the bridge.
61+
Once all endpoints are migrated, the bridge can be updated to include only SQL Server transports. This setup ensures that any in-flight messages retried by ServiceControl are routed through the bridge and delivered to their intended destination on the new SQL Server transport.
6362

6463
## Multiple transports
6564

66-
Every transport has [pros and cons](/transports/selecting.md). Some transports have higher throughput, others have higher reliability and consistency. Sometimes some messages are better handled in the cloud where hosting is taken care off by the cloud provider, but other messages must be on-premise and not leave the network.
65+
Every transport has [pros and cons](/transports/selecting.md). Some offer higher throughput, while others prioritize reliability or consistency. In many cases, certain messages are better handled in the cloud, where hosting is managed by a provider. Other messages, however, may need to remain on-premises for security or compliance reasons.
6766

68-
Each endpoint of a distributed system should be free to choose the transport that best suits its needs. In fact, this is encouraged in a microservices architecture. The NServiceBus Messaging Bridge can be used to set up endpoints on different transports, just like in the migration scenario above. Except in this scenario, there is no migration; the different transports might remain in place for the life of the system. This is a perfectly viable scenario and easily achieved using the bridge.
67+
In a distributed or microservices-based system, each endpoint should be free to choose the transport that best meets its specific requirements. This approach is not only valid—it is encouraged. The NServiceBus Messaging Bridge allows endpoints on different transports to communicate seamlessly. Unlike migration scenarios, these transports may remain in place permanently, making this a stable and supported pattern.
6968

7069
### Particular Platform
7170

72-
In a multiple transport scenario, it is likely that error and audit messages need to be collected by a single ServiceControl instance, rather than separate instances for each transport. It is possible to bridge the information that is directed at ServiceControl via the bridge.
71+
In a multiple transport scenario, error and audit messages often need to be collected by a single ServiceControl instance, rather than separate instances per transport. The NServiceBus Messaging Bridge can be used to route these messages to a central ServiceControl instance across different transports.
7372

7473
The [configuration documentation](/nservicebus/bridge/configuration.md) describes how this can be achieved.
7574

servicepulse/host-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configuring Hosting
33
summary: Describes how to configure the ServicePulse host and connections
4-
reviewed: 2023-06-30
4+
reviewed: 2025-06-13
55
component: ServicePulse
66
redirects:
77
- servicepulse/servicepulse-host-config

0 commit comments

Comments
 (0)