Merge branch 'master' into nsb-tutorial-cleanup

Particular · Nov 14, 2024 · 3643d2a · 3643d2a
2 parents c315fd8 + 28229cd
commit 3643d2a
Show file tree

Hide file tree

Showing 19 changed files with 100 additions and 86 deletions.
diff --git a/menu/menu.yaml b/menu/menu.yaml
@@ -42,14 +42,6 @@
       Title: "Monitoring NServiceBus Demo - Message backlogs"
     - Url: tutorials/monitoring-demo/walkthrough-3
       Title: "Monitoring NServiceBus Demo - Struggling endpoints"
-  - Title: More tutorials
-    Articles:
-    - Url: tutorials/message-replay
-      Title: Message replay tutorial
-    - Url: tutorials/monitoring-setup
-      Title: NServiceBus monitoring setup
-    - Url: tutorials
-      Title: All tutorials
   - Url: get-started
     Title: Overview
   - Url: get-started/high-level-content

diff --git a/monitoring/heartbeats/in-servicepulse.md b/monitoring/heartbeats/in-servicepulse.md
@@ -1,7 +1,7 @@
 ---
 title: Managing endpoint heartbeats in ServicePulse
 summary: Describes how ServicePulse monitors endpoints activity and availability using heartbeat messages
-reviewed: 2022-03-11
+reviewed: 2024-11-07
 redirects:
   - servicepulse/intro-endpoints-heartbeats
 ---
@@ -59,7 +59,7 @@ There are bulk operation buttons at the top of the screen to allow for muting or
 
 ### Removing Endpoint Instances
 
-When an endpoint instance has been decommissioned, and should no longer be displayed in ServicePulse, it can be removed. 
+When an endpoint instance has been decommissioned, and should no longer be displayed in ServicePulse, it can be removed.
 - For [Tracked Instances](#configuration-track-instances), click the `Delete` button on the instance row to remove it from ServicePulse
 - For [Untracked Instances](#configuration-do-not-track-instances), the endpoint instance will automatically be removed after 6 hours of inactivity.
 

diff --git a/monitoring/metrics/install-plugin.md b/monitoring/metrics/install-plugin.md
@@ -1,7 +1,7 @@
 ---
 title: Send Metrics data to ServiceControl
 summary: Install the Metrics plugin to send monitoring data to ServiceControl
-reviewed: 2022-03-18
+reviewed: 2024-11-07
 component: MetricsServiceControl
 related:
   - samples/logging/metrics
@@ -13,7 +13,7 @@ The `NServiceBus.Metrics.ServiceControl` component enables sending monitoring da
 
 ## Configuration
 
-After adding the package to the project, metrics are sent to ServiceControl once enabled.
+The package allows collection and propagation of metrics to ServiceControl.
 
 It can be enabled via:
 
@@ -39,7 +39,7 @@ It is recommended to [override the *host id* and *host display name* via NServic
 > [!NOTE]
 > Make sure that the `InstanceId` value is unique and human readable.
 
-A human readable value is being passed in the following example:
+A human-readable value is passed in the following example:
 
 snippet: SendMetricDataToServiceControlHostId
 

diff --git a/nservicebus/upgrades/all-versions.include.md b/nservicebus/upgrades/all-versions.include.md
@@ -157,7 +157,7 @@
 
 | Version   | Released       | Supported until   | Notes                             |
 |:---------:|:--------------:|:-----------------:|:---------------------------------:|
-| [7.0.x](https://www.nuget.org/packages/NServiceBus.SqlServer/7.0.7) | 2023-08-28     | 2026-04-16        | Bounded by NServiceBus 8.2.x      |
+| [7.0.x](https://www.nuget.org/packages/NServiceBus.SqlServer/7.0.8) | 2023-08-28     | 2026-04-16        | Bounded by NServiceBus 8.2.x      |
 | [6.3.x](https://www.nuget.org/packages/NServiceBus.SqlServer/6.3.8) | 2021-06-23     | 2024-11-17        | Extended by NServiceBus 7.8.x     |
 | [~~6.2.x~~](https://www.nuget.org/packages/NServiceBus.SqlServer/6.2.0) | ~~2020-11-19~~ | ~~2021-09-23~~    | ~~Superseded by 6.3.x~~           |
 | [~~6.1.x~~](https://www.nuget.org/packages/NServiceBus.SqlServer/6.1.2) | ~~2020-06-24~~ | ~~2021-02-19~~    | ~~Superseded by 6.2.x~~           |
@@ -219,15 +219,15 @@
 
 | Version   | Released       | Supported until   | Notes                             |
 |:---------:|:--------------:|:-----------------:|:---------------------------------:|
-| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.PostgreSql/8.1.5) | 2024-06-25     | -                 | -                                 |
+| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.PostgreSql/8.1.6) | 2024-06-25     | -                 | -                                 |
 
 #### [NServiceBus.Transport.SqlServer](/nuget/NServiceBus.Transport.SqlServer)
 
 | Version   | Released       | Supported until   | Notes                             |
 |:---------:|:--------------:|:-----------------:|:---------------------------------:|
-| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/8.1.5) | 2024-06-25     | -                 | -                                 |
+| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/8.1.6) | 2024-06-25     | -                 | -                                 |
 | [~~8.0.x~~](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/8.0.0) | ~~2024-04-16~~ | ~~2024-09-25~~    | ~~Superseded by 8.1.x~~           |
-| [7.0.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/7.0.7) | 2023-08-28     | 2026-04-16        | Extended by NServiceBus 8.2.x     |
+| [7.0.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/7.0.8) | 2023-08-28     | 2026-04-16        | Extended by NServiceBus 8.2.x     |
 | [6.3.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/6.3.8) | 2021-06-23     | 2024-11-17        | Extended by NServiceBus 7.8.x     |
 | [~~6.2.x~~](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/6.2.0) | ~~2020-11-19~~ | ~~2021-09-23~~    | ~~Superseded by 6.3.x~~           |
 | [~~6.1.x~~](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/6.1.2) | ~~2020-06-24~~ | ~~2021-02-19~~    | ~~Superseded by 6.2.x~~           |
@@ -1105,8 +1105,8 @@
 | [3.10.x](https://www.nuget.org/packages/Particular.PlatformSample/3.10.0) | 2024-08-26     | 2024-12-02        | Superseded by 3.11.x              |
 | [3.9.x](https://www.nuget.org/packages/Particular.PlatformSample/3.9.0) | 2024-08-16     | 2024-11-26        | Superseded by 3.10.x              |
 | [3.8.x](https://www.nuget.org/packages/Particular.PlatformSample/3.8.0) | 2024-08-13     | 2024-11-16        | Superseded by 3.9.x               |
-| [3.7.x](https://www.nuget.org/packages/Particular.PlatformSample/3.7.0) | 2024-08-12     | 2024-11-13        | Superseded by 3.8.x               |
-| [3.6.x](https://www.nuget.org/packages/Particular.PlatformSample/3.6.0) | 2024-08-01     | 2024-11-12        | Superseded by 3.7.x               |
+| [~~3.7.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.7.0) | ~~2024-08-12~~ | ~~2024-11-13~~    | ~~Superseded by 3.8.x~~           |
+| [~~3.6.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.6.0) | ~~2024-08-01~~ | ~~2024-11-12~~    | ~~Superseded by 3.7.x~~           |
 | [~~3.5.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.5.0) | ~~2024-07-23~~ | ~~2024-11-01~~    | ~~Superseded by 3.6.x~~           |
 | [~~3.4.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.4.0) | ~~2024-07-12~~ | ~~2024-10-23~~    | ~~Superseded by 3.5.x~~           |
 | [~~3.3.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.3.0) | ~~2024-07-08~~ | ~~2024-10-12~~    | ~~Superseded by 3.4.x~~           |

diff --git a/nservicebus/upgrades/supported-versions-downstreams.include.md b/nservicebus/upgrades/supported-versions-downstreams.include.md
@@ -35,7 +35,7 @@
 
 | Version   | Released       | Supported until   | Notes                             |
 |:---------:|:--------------:|:-----------------:|:---------------------------------:|
-| [7.0.x](https://www.nuget.org/packages/NServiceBus.SqlServer/7.0.7) | 2023-08-28     | 2026-04-16        | Bounded by NServiceBus 8.2.x      |
+| [7.0.x](https://www.nuget.org/packages/NServiceBus.SqlServer/7.0.8) | 2023-08-28     | 2026-04-16        | Bounded by NServiceBus 8.2.x      |
 | [6.3.x](https://www.nuget.org/packages/NServiceBus.SqlServer/6.3.8) | 2021-06-23     | 2024-11-17        | Extended by NServiceBus 7.8.x     |
 
 #### [NServiceBus.Transport.AzureServiceBus](/nuget/NServiceBus.Transport.AzureServiceBus)
@@ -66,15 +66,15 @@
 
 | Version   | Released       | Supported until   | Notes                             |
 |:---------:|:--------------:|:-----------------:|:---------------------------------:|
-| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.PostgreSql/8.1.5) | 2024-06-25     | -                 | -                                 |
+| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.PostgreSql/8.1.6) | 2024-06-25     | -                 | -                                 |
 
 #### [NServiceBus.Transport.SqlServer](/nuget/NServiceBus.Transport.SqlServer)
 
 | Version   | Released       | Supported until   | Notes                             |
 |:---------:|:--------------:|:-----------------:|:---------------------------------:|
-| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/8.1.5) | 2024-06-25     | -                 | -                                 |
+| [8.1.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/8.1.6) | 2024-06-25     | -                 | -                                 |
 | [~~8.0.x~~](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/8.0.0) | ~~2024-04-16~~ | ~~2024-09-25~~    | ~~Superseded by 8.1.x~~           |
-| [7.0.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/7.0.7) | 2023-08-28     | 2026-04-16        | Extended by NServiceBus 8.2.x     |
+| [7.0.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/7.0.8) | 2023-08-28     | 2026-04-16        | Extended by NServiceBus 8.2.x     |
 | [6.3.x](https://www.nuget.org/packages/NServiceBus.Transport.SqlServer/6.3.8) | 2021-06-23     | 2024-11-17        | Extended by NServiceBus 7.8.x     |
 
 ### Persistence packages
@@ -338,7 +338,6 @@
 |:---------:|:--------------:|:-----------------:|:---------------------------------:|
 | [2.0.x](https://www.nuget.org/packages/NServiceBus.AwsLambda.Sqs/2.0.0) | 2024-04-16     | -                 | -                                 |
 | [1.1.x](https://www.nuget.org/packages/NServiceBus.AwsLambda.Sqs/1.1.1) | 2023-09-21     | 2026-04-16        | Extended by NServiceBus 8.2.x     |
-| [~~0.6.x~~](https://www.nuget.org/packages/NServiceBus.AwsLambda.Sqs/0.6.0) | ~~2023-04-27~~ | ~~2024-05-09~~    | ~~Superseded by 1.0.x~~           |
 
 #### [NServiceBus.AzureFunctions.InProcess.ServiceBus](/nuget/NServiceBus.AzureFunctions.InProcess.ServiceBus)
 
@@ -578,8 +577,8 @@
 | [3.10.x](https://www.nuget.org/packages/Particular.PlatformSample/3.10.0) | 2024-08-26     | 2024-12-02        | Superseded by 3.11.x              |
 | [3.9.x](https://www.nuget.org/packages/Particular.PlatformSample/3.9.0) | 2024-08-16     | 2024-11-26        | Superseded by 3.10.x              |
 | [3.8.x](https://www.nuget.org/packages/Particular.PlatformSample/3.8.0) | 2024-08-13     | 2024-11-16        | Superseded by 3.9.x               |
-| [3.7.x](https://www.nuget.org/packages/Particular.PlatformSample/3.7.0) | 2024-08-12     | 2024-11-13        | Superseded by 3.8.x               |
-| [3.6.x](https://www.nuget.org/packages/Particular.PlatformSample/3.6.0) | 2024-08-01     | 2024-11-12        | Superseded by 3.7.x               |
+| [~~3.7.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.7.0) | ~~2024-08-12~~ | ~~2024-11-13~~    | ~~Superseded by 3.8.x~~           |
+| [~~3.6.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.6.0) | ~~2024-08-01~~ | ~~2024-11-12~~    | ~~Superseded by 3.7.x~~           |
 | [~~3.5.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.5.0) | ~~2024-07-23~~ | ~~2024-11-01~~    | ~~Superseded by 3.6.x~~           |
 | [~~3.4.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.4.0) | ~~2024-07-12~~ | ~~2024-10-23~~    | ~~Superseded by 3.5.x~~           |
 | [~~3.3.x~~](https://www.nuget.org/packages/Particular.PlatformSample/3.3.0) | ~~2024-07-08~~ | ~~2024-10-12~~    | ~~Superseded by 3.4.x~~           |

diff --git a/nservicebus/upgrades/supported-versions.json b/nservicebus/upgrades/supported-versions.json
@@ -1103,14 +1103,6 @@
           "Minor": "2.40",
           "SupportLevel": "Mainstream"
         },
-        {
-          "Minor": "3.6",
-          "SupportLevel": "Mainstream"
-        },
-        {
-          "Minor": "3.7",
-          "SupportLevel": "Mainstream"
-        },
         {
           "Minor": "3.8",
           "SupportLevel": "Mainstream"

diff --git a/nservicebus/upgrades/third-party-license-data.include.md b/nservicebus/upgrades/third-party-license-data.include.md
@@ -41,7 +41,7 @@
 
 | Dependency | License | Project Site |
 |:-----------|:-------:|:------------:|
-| <a href="https://www.nuget.org/packages/System.Data.SqlClient/" target="_blank">System.Data.SqlClient</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/dotnet/corefx" target="_blank">Project Site</a> |
+| <a href="https://www.nuget.org/packages/System.Data.SqlClient/" target="_blank">System.Data.SqlClient</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/dotnet/maintenance-packages" target="_blank">Project Site</a> |
 
 ### [NServiceBus.Transport.AzureServiceBus](/nuget/NServiceBus.Transport.AzureServiceBus)
 
@@ -55,8 +55,8 @@
 | Dependency | License | Project Site |
 |:-----------|:-------:|:------------:|
 | <a href="https://www.nuget.org/packages/Azure.Data.Tables/" target="_blank">Azure.Data.Tables</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.Tables_12.9.1/sdk/tables/Azure.Data.Tables/README.md" target="_blank">Project Site</a> |
-| <a href="https://www.nuget.org/packages/Azure.Storage.Blobs/" target="_blank">Azure.Storage.Blobs</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Azure/azure-sdk-for-net/blob/Azure.Storage.Blobs_12.22.2/sdk/storage/Azure.Storage.Blobs/README.md" target="_blank">Project Site</a> |
-| <a href="https://www.nuget.org/packages/Azure.Storage.Queues/" target="_blank">Azure.Storage.Queues</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Azure/azure-sdk-for-net/blob/Azure.Storage.Queues_12.20.1/sdk/storage/Azure.Storage.Queues/README.md" target="_blank">Project Site</a> |
+| <a href="https://www.nuget.org/packages/Azure.Storage.Blobs/" target="_blank">Azure.Storage.Blobs</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Azure/azure-sdk-for-net/blob/Azure.Storage.Blobs_12.23.0/sdk/storage/Azure.Storage.Blobs/README.md" target="_blank">Project Site</a> |
+| <a href="https://www.nuget.org/packages/Azure.Storage.Queues/" target="_blank">Azure.Storage.Queues</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Azure/azure-sdk-for-net/blob/Azure.Storage.Queues_12.21.0/sdk/storage/Azure.Storage.Queues/README.md" target="_blank">Project Site</a> |
 | <a href="https://www.nuget.org/packages/BitFaster.Caching/" target="_blank">BitFaster.Caching</a> | <a href="https://www.nuget.org/packages/BitFaster.Caching/2.5.2/license" target="_blank">View License</a> | <i>None provided</i> |
 | <a href="https://www.nuget.org/packages/System.Linq.Async/" target="_blank">System.Linq.Async</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/dotnet/reactive" target="_blank">Project Site</a> |
 
@@ -104,7 +104,7 @@
 
 | Dependency | License | Project Site |
 |:-----------|:-------:|:------------:|
-| <a href="https://www.nuget.org/packages/Microsoft.Azure.Cosmos/" target="_blank">Microsoft.Azure.Cosmos</a> | <a href="https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.45.0/license" target="_blank">View License</a> | <a href="https://github.com/Azure/azure-cosmos-dotnet-v3" target="_blank">Project Site</a> |
+| <a href="https://www.nuget.org/packages/Microsoft.Azure.Cosmos/" target="_blank">Microsoft.Azure.Cosmos</a> | <a href="https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.45.2/license" target="_blank">View License</a> | <a href="https://github.com/Azure/azure-cosmos-dotnet-v3" target="_blank">Project Site</a> |
 | <a href="https://www.nuget.org/packages/Newtonsoft.Json/" target="_blank">Newtonsoft.Json</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://www.newtonsoft.com/json" target="_blank">Project Site</a> |
 
 ### [NServiceBus.Persistence.CosmosDB.TransactionalSession](/nuget/NServiceBus.Persistence.CosmosDB.TransactionalSession)
@@ -206,7 +206,7 @@
 
 | Dependency | License | Project Site |
 |:-----------|:-------:|:------------:|
-| <a href="https://www.nuget.org/packages/Azure.Storage.Blobs/" target="_blank">Azure.Storage.Blobs</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Azure/azure-sdk-for-net/blob/Azure.Storage.Blobs_12.22.2/sdk/storage/Azure.Storage.Blobs/README.md" target="_blank">Project Site</a> |
+| <a href="https://www.nuget.org/packages/Azure.Storage.Blobs/" target="_blank">Azure.Storage.Blobs</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Azure/azure-sdk-for-net/blob/Azure.Storage.Blobs_12.23.0/sdk/storage/Azure.Storage.Blobs/README.md" target="_blank">Project Site</a> |
 | <a href="https://www.nuget.org/packages/Microsoft.IO.RecyclableMemoryStream/" target="_blank">Microsoft.IO.RecyclableMemoryStream</a> | <a href="https://licenses.nuget.org/MIT" target="_blank">MIT</a> | <a href="https://github.com/Microsoft/Microsoft.IO.RecyclableMemoryStream" target="_blank">Project Site</a> |
 
 ## Host packages

diff --git a/servicecontrol/audit-instances/deployment/containers.md b/servicecontrol/audit-instances/deployment/containers.md
@@ -46,14 +46,11 @@ Using `--setup-and-run` removes the need to repeat a setup process when the cont
 
 ## Required settings
 
-The following environment settings are required to run a ServiceControl audit instance:
-
-| Environment Variable | Description |
-|-|-|
-| `TRANSPORTTYPE` | Determines the message transport used to communicate with message endpoints. See [ServiceControl transport configuration](/servicecontrol/transports.md) for valid TransportType values. |
-| `CONNECTIONSTRING` | Provides the connection information to connect to the chosen transport. The form of this connection string is different for every message transport. See [ServiceControl transport support](/servicecontrol/transports.md) for more details on options available to each message transport. |
-| `RAVENDB_CONNECTIONSTRING` | Provides the URL to connect to the [database container](/servicecontrol/ravendb/containers.md) that stores the audit instance's data. The database container should be exclusive to the error instance, and not shared by any other ServiceControl instances. |
-| `PARTICULARSOFTWARE_LICENSE` | The Particular Software license. The environment variable should contain the full multi-line contents of the license file. |
+The following environment settings are required to run a ServiceControl audit instance.
+
+include: servicecontrol-container-transport
+include: servicecontrol-container-ravenconnectionstring
+include: servicecontrol-container-license
 
 ## Ports
 

diff --git a/...econtrol/common-includes/containers/servicecontrol-container-license.include.md b/...econtrol/common-includes/containers/servicecontrol-container-license.include.md
@@ -0,0 +1,11 @@
+### License
+
+_Environment variable:_ `PARTICULARSOFTWARE_LICENSE`
+
+The Particular Software license, which is most easily provided to a container [as an environment variable](/nservicebus/licensing/#license-management-environment-variable). The environment variable should contain the full multi-line contents of the license file.
+
+A license file can also be volume-mounted to the container in the [machine-wide license location for Linux](/nservicebus/licensing/#license-management-machine-wide-license-location):
+
+```shell
+-v license.xml:/usr/share/ParticularSoftware/license.xml
+```
diff --git a/...n-includes/containers/servicecontrol-container-ravenconnectionstring.include.md b/...n-includes/containers/servicecontrol-container-ravenconnectionstring.include.md
@@ -0,0 +1,11 @@
+### RavenDB connection string
+
+_Environment variable:_ `RAVENDB_CONNECTIONSTRING`
+
+Provides the URL to connect to the database container that stores the audit instance's data. The database container should be exclusive to the error instance, and not shared by any other ServiceControl instances.
+
+If the [storage requirements for the RavenDB container](/servicecontrol/ravendb/containers.md#required-settings) cannot be met by the container hosting infrastructure, especially in cloud-hosted environments, an externally-hosted and separately-licensed RavenDB instance can also be used starting with ServiceControl version 6.0.
+
+In this case, the RavenDB Major.Minor version must match the version expected by ServiceControl as shown in this table:
+
+include: servicecontrol-ravendb-versions