Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions platform/throughput-report/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ ServiceControl is installed as a Windows service, and starts automatically. It i
- Run the executable. This will require Admin privileges
- Add a new ServiceControl instance
![Add new ServiceControl Instance](scmu-1.png 'width=500')
- Uncheck the `ServiceControl Audit` node, since this isn't required for usage reports
![Uncheck Audit Instance](scmu-2.png 'width=500')
- Choose your transport and supply the connection string
![Choose transport](scmu-3.png 'width=500')
- Click 'Add'
Expand Down
Binary file modified platform/throughput-report/scmu-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed platform/throughput-report/scmu-2.png
Binary file not shown.
6 changes: 3 additions & 3 deletions servicecontrol/audit-instances/deployment/scmu.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Deploying Audit instances using ServiceControl Management
reviewed: 2026-04-02
reviewed: 2026-09-02
component: ServiceControl
---

include: portable-application-note

When using ServiceControl Management to [create a new ServiceControl instance](/servicecontrol/servicecontrol-instances/deployment/scmu.md), a connected ServiceControl Audit instance is automatically created by default.
When using ServiceControl Management to [create a new ServiceControl instance](/servicecontrol/servicecontrol-instances/deployment/scmu.md), a connected ServiceControl Audit instance can be created at the same time. Do this by clicking **New** > **Error + Audit** > **Next**

If necessary, a new Audit instance can be created by clicking **New** > **Add ServiceControl and Audit Instances**, and then unchecking the **ServiceControl** checkbox, leaving only **ServiceControl Audit** checked.
If necessary, a new Audit instance can be created by clicking **New** > **Audit only** > **Next**.
9 changes: 4 additions & 5 deletions servicecontrol/migrations/replacing-audit-instances/scmu.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Replacing an Audit instance using ServiceControl Management
summary: Instructions on how to replace a ServiceControl Audit instance with zero downtime
reviewed: 2026-04-17
reviewed: 2026-09-02
component: ServiceControl
related:
- servicecontrol/migrations/replacing-audit-instances/powershell
Expand All @@ -16,10 +16,9 @@ This article describes how to use the ServiceControl Management Utility to repla
First, a new audit instance must be created. If it is on the same machine, different ports must be specified. Deploying it on a separate machine is preferable, as the databases of each instance will not compete for the same resources.

1. Open ServiceControl Management.
2. Click **New**, then **Add ServiceControl and Audit Instances**.
3. Uncheck the **ServiceControl** checkbox so that only an Audit instance will be installed.
4. Configure the new Audit instance as desired, or to match the previous instance, except that new ports must be selected if deploying on the same machine.
5. Click the **Add** button to create and start the new instance.
2. Click **New**, then **Audit only**.
3. Configure the new Audit instance as desired, or to match the previous instance, except that new ports must be selected if deploying on the same machine.
4. Click the **Add** button to create and start the new instance.

## Add the instance to RemoteInstances

Expand Down
9 changes: 5 additions & 4 deletions servicecontrol/migrations/replacing-error-instances/scmu.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,11 @@ Once confident of a successful upgrade, the old database can be removed:
If the Error instance cannot be force-upgraded, instead create a new Error instance.

1. Open ServiceControl Management.
2. Click **New**, then **Add ServiceControl and Audit Instances**.
3. Uncheck the **ServiceControl.Audit** checkbox so that only a ServiceControl (Error) instance will be installed.
4. Configure the new Error instance as desired, or to match the previous instance, except that new ports must be selected if deploying on the same machine.
5. Click the **Add** button to create and start the new instance.
2. Click **New**, then **Error handling**.
3. If using a stand alone version of [ServicePulse](/servicepulse/), uncheck the `Integrated ServicePulse` check box.
4. Click **Next**.
5. Configure the new Error instance as desired, or to match the previous instance, except that new ports must be selected if deploying on the same machine.
6. Click the **Add** button to create and start the new instance.

Now that the instance is created, the configuration must be modified so that the Error instance can communicate with the same Audit instances as the previous Error instance.

Expand Down
4 changes: 2 additions & 2 deletions servicecontrol/monitoring-instances/deployment/scmu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deploying ServiceControl Monitoring instances using SCMU
reviewed: 2025-04-17
reviewed: 2026-09-02
redirects:
- servicecontrol/monitoring-instances/installation
---
Expand Down Expand Up @@ -41,7 +41,7 @@ Clicking the upgrade link will:

## Using ServiceControl Management to add monitoring instances

Click on the `+ NEW` link at the top of the screen and select "Monitoring instance" to launch the "New instance form". Complete the form to register a new monitoring instance.
Click on the `+ NEW` link at the top of the screen and select "Monitoring only" then "Next" to launch the "New instance form". Complete the form to register a new monitoring instance.

## Service name and plugins

Expand Down
14 changes: 14 additions & 0 deletions servicecontrol/servicecontrol-instances/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -852,6 +852,20 @@ Set to `false` to disable ingesting new error messages. Useful in some upgrade s
| --- | --- |
| bool | `true` |

### ServiceControl/AllowMessageEditing

Set to `true` to enable message editing when retrying messages.

| Context | Name |
| --- | --- |
| **Environment variable** | `SERVICECONTROL_ALLOWMESSAGEEDITING` |
| **App config key** | `ServiceControl/AllowMessageEditing` |
| **SCMU field** | N/A |

| Type | Default value |
| --- | --- |
| bool | `false` |

## Data retention

### ServiceControl/ExpirationProcessTimerInSeconds
Expand Down
14 changes: 9 additions & 5 deletions servicecontrol/servicecontrol-instances/deployment/scmu.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Deploying Error instances using ServiceControl Management
summary: A guide to using ServiceControl Management Utility to set up ServiceControl instances. Information about installing and upgrading ServiceControl instances.
reviewed: 2026-03-20
reviewed: 2026-09-02
component: ServiceControl
related:
- servicecontrol/servicecontrol-instances/hardware
Expand Down Expand Up @@ -29,16 +29,20 @@ See [ServiceControl Capacity Planning](/servicecontrol/capacity-and-planning.md)

## Installing ServiceControl instances

There are [three types](/servicecontrol/#servicecontrol-instance-types) of ServiceControl instances that can be installed using the ServiceControl Management utility. As the error and audit instance usually go side-by-side, they are installed and configured at the same time.
There are [three types](/servicecontrol/#servicecontrol-instance-types) of ServiceControl instances that can be installed using the ServiceControl Management utility. As the error and audit instance usually go side-by-side, they can be installed and configured at the same time.

1. Open the ServiceControl Management Utility.
2. Click the `New` button at the top-right and a popup window appears.
3. Select either `Add ServiceControl and Audit instances` or `Add monitoring instance`.
3. Select one of the following before clicking `Next`:
1. `Error only` - to install only the Error instance, with the option to include [integrated ServicePulse](/servicecontrol/servicecontrol-instances/integrated-servicepulse.md)
2. `Error + Audit` - to install the Error and Audit instances, with the option to include [integrated ServicePulse](/servicecontrol/servicecontrol-instances/integrated-servicepulse.md)
3. `Audit only` - to install only the Audit instance
4. `Monitoring only` - to install only the Monitoring instance
4. Provide a name and transport.
1. The default name is `Particular.ServiceControl`.
The name is used to derive names for the error and audit instances. The name of each instance can be adjusted from its default if required.
2. The transport should match the endpoint's transport.
5. For additional instance settings, open the `ServiceControl` and `ServiceControl Audit` sections.
5. For additional instance settings, the `ServiceControl` and `ServiceControl Audit` sections are expanded.
1. The name of the instance can be modified; the defaults for error and audit are `Particular.ServiceControl` and `Particular.ServiceControl.Audit`.
1. The name of the error instance is especially important to [enable plugins to send information](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolinstancename) to ServiceControl.
2. If multiple instances for different systems are installed on the same server, a name like `Particular.SystemName` is a common option.
Expand All @@ -50,7 +54,7 @@ There are [three types](/servicecontrol/#servicecontrol-instance-types) of Servi
This queue is important to endpoints that send error and audit messages to these ServiceControl instances, as well as [plugins](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolinstancename).
6. If needed, configure [forwarding queues](/servicecontrol/errorlog-auditlog-behavior.md).
7. Full-text search can be turned off for [performance reasons](/servicecontrol/capacity-and-planning.md#storage-performance) if it's not needed.
8. Disable [integrated ServicePulse](/servicecontrol/servicecontrol-instances/integrated-servicepulse.md) if it is not needed.
8. [Integrated ServicePulse](/servicecontrol/servicecontrol-instances/integrated-servicepulse.md) can be confirmed as on or off.

A monitoring instance differs from error and audit instances in its configuration:

Expand Down
10 changes: 4 additions & 6 deletions tutorials/monitoring-setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,28 +102,26 @@ Once it has finished installing, run the ServiceControl Management Utility.
> [!NOTE]
> You can use an existing ServiceControl instance if it is version 1.43 or higher.

In the `ServiceControl Management Utility`, click **+ New** and select **ServiceControl instance** from the list of options.
In the `ServiceControl Management Utility`, click **+ New**, then **Error only** followed by **Next**.

![ServiceControl Management Utility - Add new ServiceControl instance](scmu-add-new-sc-instance.png "width=615")

Scroll down to the **Transport Configuration** section. Select the transport that your NServiceBus system uses. Depending on the transport you may need to add an additional connection string.

Under **Audit Forwarding** select either On or Off. If you are not currently using an audit queue, you can safely turn this off. See [audit forwarding](/servicecontrol/errorlog-auditlog-behavior.md) for more information.

Click the Add button. Your ServiceControl instance will start and appear on the main page of the `ServiceControl Management Utility`.

![ServiceControl Management Utility - List instance - ServiceControl instance](scmu-list-sc-instance.png "width=615")

The listing for the ServiceControl instance includes a URL. This URL will be needed when installing ServicePulse below.

> [!NOTE]
> Creating the ServiceControl instance will also create the audit and error queues if they did not already exist. By default these are called _audit_ and _error_ respectively.
> Creating the ServiceControl instance will also create the error queue if it did not already exist. By default this queue is called _error_.

### Create a ServiceControl monitoring instance

A monitoring instance collects data from the monitoring queue and aggregates information from all of the endpoints in the system.

In the `ServiceControl Management Utility`, click **+ New** and select **monitoring endpoint** from the list of options.
In the `ServiceControl Management Utility`, click **+ New**, then **Monitoring only** followed by **Next**

![ServiceControl Management Utility - Add new Monitoring instance](scmu-add-new-mon-instance.png "width=615")

Expand Down Expand Up @@ -190,7 +188,7 @@ snippet: SetupMonitoring-ConfigureError

Whenever an NServiceBus endpoint successfully processes a message, it can be configured to send a copy to a centralized audit queue. Each environment should contain a single audit queue and should not share an audit queue with another environment.

The audit queue is created with a new ServiceControl instance. By default, it is named `audit`.
The audit queue is created with a new ServiceControl Audit instance. By default, it is named `audit`.

Configure your endpoint to send processed messages to an audit queue.

Expand Down
Binary file modified tutorials/monitoring-setup/scmu-add-new-mon-instance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tutorials/monitoring-setup/scmu-add-new-sc-instance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.