Skip to content

Commit

Permalink
Merge pull request #6993 from Particular/legacy-docs-dennis
Browse files Browse the repository at this point in the history
Legacy Docs review
  • Loading branch information
dvdstelt authored Feb 14, 2025
2 parents 0f0b5c5 + fd98ade commit 083d626
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion nservicebus/dependency-injection/autofac.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Autofac
summary: Details on how to Configure NServiceBus to use Autofac for dependency injection.
component: Autofac
reviewed: 2022-10-31
reviewed: 2025-02-14
related:
- samples/dependency-injection/autofac
redirects:
Expand Down
2 changes: 1 addition & 1 deletion samples/servicecontrol/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: ServiceControl Samples
reviewed: 2022-10-19
reviewed: 2025-02-14
component: ServiceControl
---
8 changes: 4 additions & 4 deletions servicecontrol/backup-sc-database.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Backup the ServiceControl Data
summary: How to backup the ServiceControl RavenDB Embedded instance
reviewed: 2022-10-26
summary: How to backup the ServiceControl RavenDB instance
reviewed: 2025-02-14
---
ServiceControl uses an embedded RavenDB for data storage. To backup or restore the database instance, follow these procedures:
ServiceControl uses RavenDB for data storage. To backup or restore the database instance, follow these procedures:

## Instances using RavenDB 5

Expand Down Expand Up @@ -45,7 +45,7 @@ For ServiceControl instances using RavenDB 3.5, the following steps outline how

### Do not migrate to a different Windows Server version

Care should be taken when planning to move ServiceControl from one server to another. Moving databases between servers can be problematic. The embedded RavenDB does not support moving from a new versions of Windows back to older versions of Windows. See [Getting error while restoring backup file in raven DB](https://stackoverflow.com/questions/25625910/getting-error-while-restoring-backup-file-in-raven-db) for more details.
Care should be taken when planning to move ServiceControl from one server to another. Moving databases between servers can be problematic. RavenDB does not support moving from a new versions of Windows back to older versions of Windows. See [Getting error while restoring backup file in raven DB](https://stackoverflow.com/questions/25625910/getting-error-while-restoring-backup-file-in-raven-db) for more details.

### Restore to the same ServiceControl version

Expand Down
10 changes: 5 additions & 5 deletions servicecontrol/how.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: How does ServiceControl work?
summary: An overview of how ServiceControl collects and processes messages and data from an NServiceBus system
reviewed: 2022-10-19
reviewed: 2025-02-14
---

ServiceControl is a background process that will collect and store data and make it available via an HTTP API to ServicePulse and ServiceControl.
ServiceControl is a background process that will collect and store data and make it available via an HTTP API to ServicePulse and ServiceInsight.

> [!NOTE]
> The ServiceControl HTTP API may change at any time. It is designed for use by ServicePulse and ServiceInsight only. The use of this HTTP API for other purposes is not supported.
Expand Down Expand Up @@ -57,16 +57,16 @@ graph LR

[Recoverability](/nservicebus/recoverability/) is an important feature in NServiceBus. It enables automatic retries and continuity within a system, as failed messages will be moved aside to allow other messages to be processed while the errors are investigated. Those error messages contain business data that must eventually be processed.

NServiceBus will move messages it cannot process to an [error queue](/nservicebus/recoverability/#fault-handling). This is where ServiceControl comes into play to consume these messages. ServiceControl will pick up the message and store it in an internal database. ServiceControl uses an embedded RavenDB instance for the internal database. After it is stored in the database, the message is made available to ServicePulse and ServiceInsight for visualization, retries, and other operations.
NServiceBus will move messages it cannot process to an [error queue](/nservicebus/recoverability/#fault-handling). This is where ServiceControl comes into play to consume these messages. ServiceControl will pick up the message from the queue and store it in its RavenDb database. After it is stored in the database, the message is made available to ServicePulse and ServiceInsight for visualization, retries, and other operations.

> [!NOTE]
> It is recommended not to provide end-users with the ability to retry messages. The message could fail again and end up in ServiceControl once again. It could be even more problematic when many messages are retried during a peak in message processing. This will result in even more messages being processed by an endpoint, causing valid messages to be delayed even longer.
> It is recommended not to provide end-users with the ability to retry messages. The message could fail again and end up in ServiceControl once again. It could be even more problematic when many messages are retried during a peak in message processing. This will result in even more messages being processed by an endpoint, causing valid messages to be delayed even longer. Potentially even more messages can fail due to locking in your saga persistence.
Find out more about [failed messages](/servicepulse/intro-failed-messages.md) in ServicePulse.

### Audit instances

To enable ServiceInsight to visualize the message flow through the system, it must have access to every message that has been successfully processed by the system. This requires endpoints to [enable auditing](/nservicebus/operations/auditing.md). ServiceControl consumes these messages and stores them in its internal database.
To enable ServiceInsight to visualize the message flow through the system, it must have access to every message that has been successfully processed by the system. This requires endpoints to [enable auditing](/nservicebus/operations/auditing.md). ServiceControl consumes these messages and stores them in its database.

ServiceInsight will retrieve the data from ServiceControl via the HTTP API and use header information (added by NServiceBus during message processing) to figure out which message caused other messages to be sent, including which sagas were accessed when the [SagaAudit plugin](/nservicebus/sagas/saga-audit.md) is configured in an endpoint.

Expand Down

0 comments on commit 083d626

Please sign in to comment.