Skip to content

Commit ba4d9ca

Browse files
Docs reviews (#8359)
1 parent 5e12a3d commit ba4d9ca

5 files changed

Lines changed: 22 additions & 28 deletions

File tree

nservicebus/hosting/nservicebus-host/nservicebus-32-bit-x86-host-process.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ summary: If 32-bit code must be invoked and loaded, use NServiceBus.Host32.exe
44
component: Host
55
redirects:
66
- nservicebus/nservicebus-32-bit-x86-host-process
7-
reviewed: 2024-10-16
7+
reviewed: 2026-06-22
88
---
99

10-
NServiceBus is an "Any CPU" framework. It doesn't have 32-bit or 64-bit specific code. This enables transitioning between 32- and 64-bit operating systems. Unfortunately, not all assemblies can be compiled using the default Any CPU architecture. In many, this is related to legacy systems that have 32-bit specific code for platform interoperability with native C libraries, etc.
10+
NServiceBus is an "Any CPU" framework. It doesn't have 32-bit- or 64-bit-specific code. This enables transitioning between 32- and 64-bit operating systems. Unfortunately, not all assemblies can be compiled using the default Any CPU architecture. For example, this might be related to legacy systems that have 32-bit-specific code for platform interoperability with native C libraries.
1111

12-
With the default NServiceBus.Host, the application always loads in 64-bit (x64) mode if running on a 64-bit OS, or in 32-bit (x86) mode for a 32-bit OS. Again, this is typically not a problem.
12+
With the default NServiceBus.Host, the application always loads in 64-bit (x64) mode on a 64-bit OS, or in 32-bit (x86) mode on a 32-bit OS. Again, this is typically not a problem.
1313

14-
If assemblies or other libraries containing 32-bit code must be invoked and loaded into a 64-bit process a `BadImageFormatException` will be thrown.
14+
If assemblies or other libraries containing 32-bit code must be invoked and loaded into a 64-bit process, a `BadImageFormatException` will be thrown.
1515

16-
There are two specific versions of the NServiceBus Host: the default *Any CPU* version and `NServiceBus.Host32.exe`targeting 32-bit.
16+
There are two specific versions of the NServiceBus Host: the default *Any CPU* version and `NServiceBus.Host32.exe` targeting 32-bit.
1717

18-
The second one allows users running a 64-bit OS to run a 32-bit NServiceBus host process, allowing execution of 32-bit binaries/code without resorting to workarounds such as `corflags.exe` to patch an assembly, which instruct the .NET Framework to run in 32-bit mode.
18+
The second one allows users running a 64-bit OS to run a 32-bit NServiceBus host process, allowing execution of 32-bit binaries/code without resorting to workarounds such as `corflags.exe` to patch an assembly, which instructs the .NET Framework to run in 32-bit mode.
1919

2020
Links to the NuGet packages:
2121

nservicebus/recoverability/subscribing-to-error-notifications.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Error notifications
33
summary: Subscribing to error notifications
4-
reviewed: 2024-10-24
4+
reviewed: 2026-06-22
55
component: Core
66
versions: '[5.0,)'
77
redirects:
@@ -16,15 +16,14 @@ Error notifications are available for several events:
1616

1717
* When an [immediate retry](/nservicebus/recoverability/#immediate-retries) occurs.
1818
* When a [delayed retry](/nservicebus/recoverability/#delayed-retries) occurs.
19-
* When a message fails, all retries fail, and the message is forwarded to the error queue.
19+
* When a message, after exhausting all retries, is forwarded to the error queue.
2020

21-
The following example shows how to be notified every time a message is handled by [recoverability](/nservicebus/recoverability/). While this code writes to the console, any other action could be taken, for example, sending an email or writing to a monitoring system.
21+
The following example shows how to be notified whenever a message is handled by [recoverability](/nservicebus/recoverability/). While this code writes to the console, any other action could be taken, for example, sending an email or writing to a monitoring system.
2222

2323
snippet: SubscribeToErrorsNotifications
2424

2525
include: notificationThread
2626

27-
2827
## Message Body
2928

3029
include: error-notifications-message-body

persistence/cosmosdb/saga-concurrency.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: CosmosDB Persistence Saga Concurrency
33
summary: Explains how concurrency works with sagas in the CosmosDB persister
44
component: CosmosDB
5-
reviewed: 2024-10-15
5+
reviewed: 2026-06-22
66
related:
77
- nservicebus/sagas/concurrency
88
---
99

1010
## Default behavior
1111

12-
When simultaneously handling messages, conflicts may occur. See below for examples of the exceptions which are thrown. _[Saga concurrency](/nservicebus/sagas/concurrency.md)_ explains how these conflicts are handled, and contains guidance for high-load scenarios.
12+
When handling messages simultaneously, conflicts may occur. See below for examples of the exceptions that are thrown. _[Saga concurrency](/nservicebus/sagas/concurrency.md)_ explains how these conflicts are handled, and contains guidance for high-load scenarios.
1313

1414
include: saga-concurrency
1515

@@ -31,4 +31,4 @@ Example exception:
3131
The 'OrderSagaData' saga with id '7ac4d199-6560-4d1a-b83a-b3dad94b0802' was updated by another process or no longer exists.
3232
```
3333

34-
partial: pessimistic-locking
34+
partial: pessimistic-locking

persistence/cosmosdb/saga-concurrency_pessimistic-locking_CosmosDB_[1,].partial.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CosmosDB does not support pessimistic locking natively. The behavior is based on
1212
> It is recommended to choose pessimistic concurrency over optimistic concurrency whenever a saga is experiencing a high number of optimistic concurrency control errors.
1313
1414
> [!NOTE]
15-
> When using pessimistic locking with provisioned throughput it is important to understand the additional patch operation attempts that are issued during the saga loading attempt will lead to higher RU usage. It is important to set the lease lock acquisition minimum and maximum refresh delay according in alignment with the saga contention scenarios to avoid using too much unnecessary RUs.
15+
> When using pessimistic locking with provisioned throughput, it is important to understand that the additional patch operation attempts that are issued during the saga loading attempt will lead to higher RU usage. It is important to set the lease lock acquisition minimum and maximum refresh delay in alignment with the saga contention scenarios to avoid using too many unnecessary RUs.
1616
1717
### Pessimistic concurrency control settings
1818

@@ -32,6 +32,6 @@ snippet: PessimisticLeaseLockAcquisitionTimeout
3232

3333
### Pessimistic lease lock acquisition minimum and maximum refresh delay
3434

35-
To prevent request synchronization, the persister randomizes the interval between lock acquisition requests. By default, the interval has a value between 500 and 1000 milliseconds. These values can be adjusted using the following API:
35+
To prevent request synchronization, the persister randomizes the interval between lock acquisition requests. By default, the interval is between 500 and 1000 milliseconds. These values can be adjusted using the following API:
3636

37-
snippet: PessimisticLeaseLockAcquisitionMinMaxRefreshDelay
37+
snippet: PessimisticLeaseLockAcquisitionMinMaxRefreshDelay

servicepulse/event-types.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,49 @@
11
---
22
title: ServicePulse events
33
summary: Introduction to ServicePulse monitoring events
4-
reviewed: 2024-10-16
4+
reviewed: 2026-06-22
55
component: ServicePulse
66
related:
77
- monitoring/custom-checks/in-servicepulse
88
---
99

10-
ServicePulse gives an overview of a system's health, based on endpoints heartbeats and custom checks, and a detailed view of failed messages.
10+
ServicePulse provides an overview of a system's health based on endpoints' heartbeats and custom checks, as well as a detailed view of failed messages.
1111

1212
> [!NOTE]
1313
> The same information can be consumed not only via the ServicePulse web interface, but also by subscribing to [custom notifications and alerts from ServiceControl](/servicecontrol/contracts.md).
1414
15-
1615
### Heartbeats
1716

18-
1917
#### HeartbeatStopped
2018

21-
The `HeartbeatStopped` event is published each time the monitoring infrastructure does not receive a heartbeat from an endpoint within the expected amount of time.
22-
19+
The `HeartbeatStopped` event is published whenever the monitoring infrastructure fails to receive a heartbeat from an endpoint within the expected time.
2320

2421
#### HeartbeatRestored
2522

26-
The `HeartbeatRestored` event is published to notify when a previously stopped heartbeat has been restored and the related endpoint is running as expected.
23+
The `HeartbeatRestored` event is published to notify when a previously stopped heartbeat has been restored, and the related endpoint is running as expected.
2724

2825
More details on endpoints and heartbeats in [ServicePulse](/monitoring/heartbeats/in-servicepulse.md).
2926

30-
3127
### MessageFailed
3228

33-
The `MessageFailed` event is published to notify that a message has failed all the [immediate retry](/nservicebus/recoverability/#immediate-retries) steps and all the [delayed retry](/nservicebus/recoverability/#delayed-retries) steps and has reached the configured error queue. The event itself carries all the details of the failure and has a `MessageStatus` enumeration that details the type of failure:
29+
The `MessageFailed` event is published to indicate that a message has failed all the [immediate retry](/nservicebus/recoverability/#immediate-retries) and [delayed retry](/nservicebus/recoverability/#delayed-retries) steps and has reached the configured error queue. The event itself carries all the details of the failure and has a `MessageStatus` enumeration that details the type of failure:
3430

3531
* `Failed`: The message has failed and has arrived for the first time in the error queue;
3632
* `RepeatedFailure`: The message has failed multiple times;
3733
* `ArchivedFailure`: The message has been deleted;
3834

3935
More details on [failed message monitoring in ServicePulse](intro-failed-messages.md).
4036

41-
4237
### Custom check / Periodic check
4338

44-
Custom checks allow an endpoint to notify ServicePulse if a business related condition is not met. The endpoint heartbeat signals that the endpoint is running and that a custom check can add more information, for example, that the endpoint is running and can access the external resources required to operate correctly.
39+
Custom checks allow an endpoint to notify ServicePulse if a business-related condition is not met. The endpoint heartbeat signals that the endpoint is running and that a custom check can add more information, for example, that the endpoint is running and can access the external resources required to operate correctly.
4540

4641
## Dashboard screen
4742

4843
The dashboard shows the last 10 events that were reported by ServiceControl.
4944

5045
![dashboard](images/events-dashboard.png 'width=500')
5146

52-
View all events by clicking on the 'Events' link in the menu or the 'View all events' link on the dashboard. These links redirect to the dedicated events page which shows all events captured within ServiceControl.
47+
View all events by clicking on the 'Events' link in the menu or the 'View all events' link on the dashboard. These links redirect to the dedicated events page, which shows all events captured within ServiceControl.
5348

5449
![event page](images/events-page.png 'width=500')

0 commit comments

Comments
 (0)