Skip to content

Commit b2a284e

Browse files
Legacy Docs Review - 2024-10-21 (#6872)
* Legacy Docs Review - 2024-10-21 * Update subscribing-to-error-notifications.md * Update design.md * Update assembly-scanning.md * Update assembly-scanning.md * Update assembly-scanning.md * Update assembly-scanning.md
1 parent 778a9b4 commit b2a284e

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

nservicebus/hosting/assembly-scanning.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Assembly scanning
3-
summary: To enable automatic detection of various features NServiceBus scans assemblies for well known types
4-
reviewed: 2022-02-15
3+
summary: To enable the automatic detection of various features, NServiceBus scans assemblies for well-known types
4+
reviewed: 2024-10-24
55
component: core
66
redirects:
77
- nservicebus/assembly-scanning
@@ -11,28 +11,28 @@ NServiceBus scans assemblies at endpoint startup to automatically detect and loa
1111

1212
There are some cases where finer control over which assemblies are loaded is required:
1313

14-
* To limit the number of assemblies being scanned and hence provide improvements to startup time.
15-
* If hosting multiple endpoints out of the same directory each endpoint may require a subset of assemblies to be loaded.
14+
* To limit the number of assemblies being scanned and hence improve startup time.
15+
* If hosting multiple endpoints out of the same directory, each endpoint may require loading a subset of assemblies.
1616

1717
> [!NOTE]
1818
> NServiceBus extensions such as `NServiceBus.RavenDB.dll` are not considered a core assembly but still must be included when customizing the assembly scanning.
1919
2020
## AppDomain assemblies
2121

22-
By default, the assemblies that are already loaded into the AppDomain are scanned. The endpoint can also be configured to disable AppDomain assembly scanning:
22+
By default, the assemblies already loaded into the AppDomain are scanned. The endpoint can also be configured to disable AppDomain assembly scanning:
2323

2424
snippet: ScanningApDomainAssemblies
2525

2626
## Assembly files
2727

28-
By default all assemblies in the endpoint's `bin` directory are scanned in search of related interfaces so that the endpoint can configure them automatically.
28+
By default, all assemblies in the endpoint's `bin` directory are scanned for related interfaces so that the endpoint can configure them automatically.
2929

3030
### Additional assembly scanning path
3131

3232
> [!NOTE]
3333
> This configuration option is available only in NServiceBus version 7.4 and above.
3434
35-
Assembly scanning can be configured to scan an additional path for assemblies located outside of the default scanning path.
35+
Assembly scanning can be configured to scan an additional path for assemblies outside the default scanning path.
3636

3737
snippet: AdditionalAssemblyScanningPath
3838

@@ -53,7 +53,7 @@ snippet: disable-file-scanning
5353
5454
## Assemblies to scan
5555

56-
The assemblies being scanned can be further controlled via user-defined exclusions. This supports common scenarios removing specific assemblies from scanning without the risk of accidentally excluding required assemblies.
56+
The assemblies being scanned can further be controlled via user-defined exclusions. This supports common scenarios removing specific assemblies from scanning without the risk of accidentally excluding required assemblies.
5757

5858
### Exclude specific assemblies by name
5959

@@ -74,9 +74,9 @@ snippet: ScanningExcludeTypes
7474
> [!NOTE]
7575
> This configuration option is only available in NServiceBus 6.2 and above.
7676
77-
By default, exceptions occurred during assembly scanning will be re-thrown. Those exceptions can be ignored using the following:
77+
By default, exceptions that occurred during assembly scanning will be re-thrown. Those exceptions can be ignored using the following:
7878

7979
snippet: SwallowScanningExceptions
8080

8181
> [!WARNING]
82-
> Ignoring assembly scanning exceptions can cause the endpoint to not load some features, behaviors, messages or message handlers and cause incorrect behavior.
82+
> Ignoring assembly scanning exceptions can cause the endpoint not to load some features, behaviors, messages or message handlers and cause incorrect behavior.

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

Lines changed: 3 additions & 3 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: 2022-02-09
4+
reviewed: 2024-10-24
55
component: Core
66
versions: '[5.0,)'
77
redirects:
@@ -16,9 +16,9 @@ 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 and is forwarded to the error queue.
19+
* When a message fails, all retries fail, and the message 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 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.
2222

2323
snippet: SubscribeToErrorsNotifications
2424

servicecontrol/import-failed-messages.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Re-processing messages that failed to be imported
33
summary: How to attempt to re-process messages that failed to be imported
4-
reviewed: 2022-01-26
4+
reviewed: 2024-10-24
55
redirects:
66
- servicecontrol/import-failed-audit-messages
77
- servicecontrol/import-failed-audits
@@ -15,7 +15,7 @@ Messages can fail to be imported into the ServiceControl database for the follow
1515
* [Forwarding](/servicecontrol/errorlog-auditlog-behavior.md) is enabled, and the destination queue does not exist, or ServiceControl cannot send messages to it. This could happen when the message or size limit has been reached or storage resources are exhausted.
1616

1717
> [!NOTE]
18-
> Messages that have corrupt (i.e. unreadable, not deserializable) header data will not be processed at all and will move to ServiceControl's 'error' queue.
18+
> Messages with corrupt (i.e. unreadable, not deserializable) header data will not be processed and will move to ServiceControl's 'error' queue.
1919
2020
Messages that fail to be imported are stored in the ServiceControl database in the `FailedAuditImports` and `FailedErrorImports` collections.
2121

@@ -30,7 +30,7 @@ When a failed import is detected in the ServiceControl database, the [**Message
3030
To reimport the failed messages, the instance must be shut down and started from a command line using one of the following commands:
3131

3232
> [!NOTE]
33-
> The value to use for `--serviceName` is the instance name. It is available in the Windows Service information as well as the ServiceControl Management Utility.
33+
> The value to use for `--serviceName` is the instance name. It is available in the Windows Service information and ServiceControl Management Utility.
3434
3535
**ServiceControl instance:**
3636

@@ -48,10 +48,10 @@ ServiceControl.Audit.exe --serviceName=Particular.Servicecontrol.Audit --import-
4848

4949
While in import mode, ServiceControl or ServiceControl Audit will not process its input queues. Once the message is re-processed successfully, it is available in ServicePulse and ServiceInsight. ServiceControl or ServiceControl Audit instance can then be started again.
5050

51-
The custom check will no longer be displayed if all failed imports have been successfully reimported
51+
The custom check will no longer be displayed if all failed imports have been successfully reimported.
5252

5353
## Modify message data
5454

55-
If the message still fails to import it usually means that the message is malformed, and ServiceControl won't be able to ingest it. It may be possible to correct the message data manually to allow ServiceControl to import the message. To review the malformed messages, start ServiceControl in [maintenance mode](/servicecontrol/ravendb/accessing-database.md#windows-deployment-maintenance-mode) and inspect the `FailedAuditImports` or `FailedErrorImports` collection. Review the import failure logs to determine why the import continues to fail. If modifying the audit message, data can resolve the issue, make the necessary changes to the message document to allow ServiceControl to import the message.
55+
If the message still fails to import, it usually means that the message is malformed, and ServiceControl won't be able to ingest it. It may be possible to correct the message data manually to allow ServiceControl to import the message. To review the malformed messages, start ServiceControl in [maintenance mode](/servicecontrol/ravendb/accessing-database.md#windows-deployment-maintenance-mode) and inspect the `FailedAuditImports` or `FailedErrorImports` collection. Review the import failure logs to determine why the import continues to fail. If modifying the audit message data can resolve the issue, make the necessary changes to the message document to allow ServiceControl to import the message.
5656

5757
Once the data has been modified, the message can be reimported by running ServiceControl from the command line with the `--import-failed-errors` or ServiceControl Audit with the `--import-failed-audits` option again.

transports/sql/design.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: SQL Transport Design
33
summary: The design and implementation details of SQL Server Transport
4-
reviewed: 2022-02-09
4+
reviewed: 2024-10-24
55
component: SqlTransport
66
redirects:
77
- nservicebus/sqlserver/design
@@ -15,7 +15,7 @@ In SQL Server Transport each queue is represented as table inside a database. De
1515

1616
## Structure
1717

18-
The queue table consists of the following columns
18+
The queue table consists of the following columns.
1919

2020
### ID
2121

@@ -29,7 +29,7 @@ The `CorrelationId` column contains the value of `NServiceBus.CorrelationId` hea
2929

3030
### ReplyToAddress
3131

32-
The `ReplyToAddress` column contains the value of `NServiceBus.ReplyToAddress` header. This value is kept in a separate column to he maintain wire-level compatibility with [NServiceBus.SqlServer](https://www.nuget.org/packages/NServiceBus.SqlServer) transport Version 1.
32+
The `ReplyToAddress` column contains the value of the `NServiceBus.ReplyToAddress` header. This value is kept in a separate column to maintain wire-level compatibility with [NServiceBus.SqlServer](https://www.nuget.org/packages/NServiceBus.SqlServer) transport Version 1.
3333

3434

3535
### Recoverable
@@ -43,12 +43,12 @@ The `CorrelationId`, `ReplyToAddress` and `Recoverable` columns are required for
4343

4444
When receiving messages sent by endpoints that use later versions, the values of correlation ID and reply-to address should be read from the headers (`NServiceBus.CorrelationId` and `NServiceBus.ReplyToAddress`) instead. The value `Recoverable` can be ignored as it is always `true`/`1`.
4545

46-
When sending messages to endpoints that use later versions, the values of correlation ID and reply-to address columns could be set to `NULL` and the actual values are provided in the headers (`NServiceBus.CorrelationId` and `NServiceBus.ReplyToAddress`). The value `Recoverable` should always be `true`/`1`.
46+
When sending messages to endpoints that use later versions, the values of correlation ID and reply-to address columns could be set to `NULL` with the actual values provided in the headers (`NServiceBus.CorrelationId` and `NServiceBus.ReplyToAddress`). The value `Recoverable` should always be `true`/`1`.
4747

4848

4949
### Expires
5050

51-
The `Expires` column contains the optional date and time when the message is going to expire. An expired message is dropped by the transport. Depending on version, expired messages might be actively purged from the queue. For details see [discarding expired messages](/transports/sql/discard-expired-messages.md).
51+
The `Expires` column contains the optional date and time when the message will expire. An expired message is dropped by the transport. Depending on version, expired messages might be actively purged from the queue. For details see [discarding expired messages](/transports/sql/discard-expired-messages.md).
5252

5353
partial: expired-index
5454

@@ -69,7 +69,7 @@ partial: messageBodyString-column
6969

7070
The `RowVersion` column is used to define the FIFO order of the queue. It is auto-incremented by SQL Server (`identity(1,1)`). The receive message T-SQL query returns a message with the lowest value of `RowVersion` that is not locked by any other concurrent receive operation.
7171

72-
The clustered index of the queue table is based on the `RowVersion` column to ensure the new messages are always added at the end of the table.
72+
The clustered index of the queue table is based on the `RowVersion` column to ensure that new messages are always added at the end of the table.
7373

7474

7575
## Behavior
@@ -87,4 +87,4 @@ Messages are sent by executing an `insert` command against the queue table.
8787
Messages are received by executing a `delete` command against the queue table. The `delete` is limited to a row with the lowest `RowVersion` not locked by other concurrent `delete`. This ensures that multiple threads within an endpoint instance and multiple instances of the same scaled-out endpoint can operate at full speed without conflicts.
8888

8989

90-
partial: concurrency
90+
partial: concurrency

0 commit comments

Comments
 (0)