ServicePulse and ServiceControl docs updates (#6800)

DavidBoike · bording · web-flow · commit eefaab9cf6a5 · 2024-08-12T12:19:38.000-05:00
* Move setting from "lost" page

* And fix links

* Remaining setting is Raven35 only and not needed

* Move raven containers page up a level so we don't need an index

* ServicePulse container

* Update index.md

* Clarity

* Highlgiht reverse proxy feature as a heading

---------

Co-authored-by: Brandon Ording &lt;bording@gmail.com&gt;
diff --git a/menu/menu.yaml b/menu/menu.yaml
@@ -1378,6 +1378,8 @@
       Title: About ServicePulse
     - Url: servicepulse/installation
       Title: Installation
+    - Url: servicepulse/containerization
+      Title: Container deployment
     - Url: servicepulse/intro-failed-messages
       Title: Failed Messages
     - Url: servicepulse/intro-failed-message-retries
@@ -1557,7 +1559,7 @@
     - Title: Backup
       Url: servicecontrol/backup-sc-database
     - Title: Containers
-      Url: servicecontrol/ravendb/deployment/containers
+      Url: servicecontrol/ravendb/containers
     - Title: Compacting the database
       Url: servicecontrol/db-compaction
     - Title: Move database location
diff --git a/servicecontrol/audit-instances/configuration.md b/servicecontrol/audit-instances/configuration.md
@@ -114,7 +114,9 @@ The virtual directory to bind the embedded HTTP server to; modify this setting t
 | string | _None_ |
 
 
-## Database
+## Embedded database
+
+These settings are not valid for ServiceControl instances hosted in a container.
 
 ### ServiceControl.Audit/DbPath
 
@@ -133,6 +135,31 @@ The path where the internal RavenDB is located.
 > [!NOTE]
 > This setting is not relevant when the audit instance is [deployed using a container](/servicecontrol/audit-instances/deployment/containers.md).
 
+### ServiceControl.Audit/RavenDBLogLevel
+
+Controls the LogLevel of the RavenDB logs.
+
+| Context | Name |
+| --- | --- |
+| **Environment variable** | `SERVICECONTROL_AUDIT_RAVENDBLOGLEVEL` |
+| **App config key** | `ServiceControl.Audit/RavenDBLogLevel` |
+| **SCMU field** | N/A |
+
+#if-version [5,)
+| Type | Default value |
+| --- | --- |
+| string | `Operations` |
+
+Valid settings are: `None`, `Information`, `Operations`.
+#end-if
+#if-version [,5)
+| Type | Default value |
+| --- | --- |
+| string | `Warn` |
+
+Valid settings are: `Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`.
+#end-if
+
 #if-version [,5)
 ### Raven/IndexStoragePath
 > [!NOTE]
@@ -445,28 +472,15 @@ The ServiceControl queue name to use for plugin messages (e.g. Heartbeats, Custo
 
 ## Troubleshooting
 
-ServiceControl Audit stores its data in a RavenDB embedded instance. If direct access to the RavenDB instance is required for troubleshooting while ServiceControl Audit is running, see [Accessing the database](/servicecontrol/ravendb/accessing-database.md).
-
-### RavenDB 5
-
-For instances running version 4.26 and above, which are configured to use [the new RavenDB 5 persistence](/servicecontrol/migrations/new-persistence.md) browse to:
-
-```no-highlight
-http://localhost:{configured ServiceControl instance maintenance port}
-```
-
-to access the internal database via [the RavenDB studio interface](https://ravendb.net/docs/article-page/5.4/csharp/studio/overview).
-
-
-#### ServiceControl.Audit/DataSpaceRemainingThreshold
+### ServiceControl.Audit/DataSpaceRemainingThreshold
 
 The percentage threshold for the [Message database storage space](/servicecontrol/servicecontrol-instances/#notifications-health-monitoring-message-database-storage-space) check. If the remaining hard drive space drops below this threshold (as a percentage of the total space on the drive) then the check will fail, alerting the user.
 
 | Type | Default value |
 | --- | --- |
 | int | `20` |
 
-#### ServiceControl.Audit/MinimumStorageLeftRequiredForIngestion
+### ServiceControl.Audit/MinimumStorageLeftRequiredForIngestion
 
 The percentage threshold for the [Critical message database storage space](/servicecontrol/servicecontrol-instances/#notifications-health-monitoring-message-database-storage-space) check. If the remaining hard drive space drops below this threshold (as a percentage of the total space on the drive), then the check will fail, alerting the user. The message ingestion will also be stopped to prevent data loss. Message ingestion will resume once more disk space is made available.
 
@@ -476,7 +490,7 @@ The percentage threshold for the [Critical message database storage space](/serv
 
 #if-version [,5)
 
-#### Raven/Esent/LogsPath
+### Raven/Esent/LogsPath
 
 
 This setting is applicable only on instances that use the RavenDB 3.5 storage engine.
diff --git a/servicecontrol/audit-instances/deployment/containers.md b/servicecontrol/audit-instances/deployment/containers.md
@@ -39,7 +39,7 @@ The following environment settings are required to run a ServiceControl audit in
 |-|-|
 | `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/deployment/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. |
+| `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. |
 
 ## Ports
diff --git a/servicecontrol/audit-instances/index.md b/servicecontrol/audit-instances/index.md
@@ -36,7 +36,7 @@ Data about audit messages is exposed via an HTTP API from a ServiceControl Error
 
 ## Persistence
 
-Each ServiceControl Audit instance stores message data in a RavenDB database. For instances deployed using the ServiceControl Management utility or PowerShell this database is embedded with the ServiceControl Audit instance. For ServiceControl Audit instances deployed using containers the database resides in a [separate container](/servicecontrol/ravendb/deployment/containers.md).
+Each ServiceControl Audit instance stores message data in a RavenDB database. For instances deployed using the ServiceControl Management utility or PowerShell this database is embedded with the ServiceControl Audit instance. For ServiceControl Audit instances deployed using containers the database resides in a [separate container](/servicecontrol/ravendb/containers.md).
 
 By default, audit data is retained for 30 days. [This retention period can be customized](/servicecontrol/audit-instances/configuration.md#data-retention).
 
diff --git a/servicecontrol/import-failed-messages.md b/servicecontrol/import-failed-messages.md
@@ -19,7 +19,7 @@ Messages can fail to be imported into the ServiceControl database for the follow
 
 Messages that fail to be imported are stored in the ServiceControl database in the `FailedAuditImports` and `FailedErrorImports` collections.
 
-In addition, a log with the failure reason is written for the message in the `%ServiceControl/LogPath%` ([error instances](/servicecontrol/servicecontrol-instances/configuration.md#embedded-database-servicecontrollogpath)/[audit instances](/servicecontrol/audit-instances/configuration.md#logging-servicecontrol-auditlogpath)) `\FailedImports\{Audit|Error}\%failureid%.txt`. These messages will not be visible in ServiceInsight.
+In addition, a log with the failure reason is written for the message in the `%ServiceControl/LogPath%` ([error instances](/servicecontrol/servicecontrol-instances/configuration.md#logging-servicecontrollogpath)/[audit instances](/servicecontrol/audit-instances/configuration.md#logging-servicecontrol-auditlogpath)) `\FailedImports\{Audit|Error}\%failureid%.txt`. These messages will not be visible in ServiceInsight.
 
 ## Failed message custom check
 
diff --git a/servicecontrol/migrations/replacing-audit-instances/containers.md b/servicecontrol/migrations/replacing-audit-instances/containers.md
@@ -21,7 +21,7 @@ This article describes how to replace an Audit instance with zero downtime when
 >
 > This guide assumes this is true, and that the user knows how to create routable URLs to allow the communication, even if one instance is hosted on a virtual machine and another instance is running on containerized infrastructure.
 
-First, a new audit instance must be created. [Deploy a new Audit instance container](/servicecontrol/audit-instances/deployment/containers.md) with its own [database container](/servicecontrol/ravendb/deployment/containers.md).
+First, a new audit instance must be created. [Deploy a new Audit instance container](/servicecontrol/audit-instances/deployment/containers.md) with its own [database container](/servicecontrol/ravendb/containers.md).
 
 ## Add the instance to RemoteInstances
 
@@ -51,4 +51,4 @@ Modify the old Audit instance container by specifying the [`INGESTAUDITMESSAGES`
 When the audit retention period has expired and there are no remaining processed messages in the database, you can decommission the old audit instance:
 
 1. Adjust the `REMOTEINSTANCES` environment variable [as described above](#add-the-instance-to-remoteinstances) except remove the old Audit instance URI from the collection.
-2. Remove the old Audit instance by stopping and removing the container, as well as the related [database container](/servicecontrol/ravendb/deployment/containers.md).
+2. Remove the old Audit instance by stopping and removing the container, as well as the related [database container](/servicecontrol/ravendb/containers.md).
diff --git a/servicecontrol/migrations/replacing-error-instances/containers.md b/servicecontrol/migrations/replacing-error-instances/containers.md
@@ -33,7 +33,7 @@ Modify the old Error instance container by specifying the [`INGESTERRORMESSAGES`
 ## Replace the Error instance
 
 
-[Deploy a new Error instance container](/servicecontrol/servicecontrol-instances/deployment/containers.md) with its own [database container](/servicecontrol/ravendb/deployment/containers.md). The [`REMOTEINSTANCES` environment variable](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolremoteinstances) should match the configuration of the old Error instance so that it can communicate to the same Audit instance(s).
+[Deploy a new Error instance container](/servicecontrol/servicecontrol-instances/deployment/containers.md) with its own [database container](/servicecontrol/ravendb/containers.md). The [`REMOTEINSTANCES` environment variable](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolremoteinstances) should match the configuration of the old Error instance so that it can communicate to the same Audit instance(s).
 
 Now, the old and new Error instance's are both available, but the old Error instance is not ingesting messages.
 
diff --git a/servicecontrol/ravendb/configuration.md b/servicecontrol/ravendb/configuration.md
diff --git a/servicecontrol/ravendb/containers.md b/servicecontrol/ravendb/containers.md
@@ -2,6 +2,8 @@
 title: Managing ServiceControl RavenDB instances via Containers
 reviewed: 2024-06-11
 component: ServiceControl
+redirects:
+  - servciecontrol/ravendb/deployment/containers
 ---
 
 When ServiceControl is hosted in containers, the [`particular/servicecontrol-ravendb` image](https://hub.docker.com/r/particular/servicecontrol-ravendb) provides the database storage to the Error and Audit instances.
diff --git a/servicecontrol/ravendb/deployment/index.md b/servicecontrol/ravendb/deployment/index.md
diff --git a/servicecontrol/servicecontrol-instances/configuration.md b/servicecontrol/servicecontrol-instances/configuration.md
@@ -124,7 +124,9 @@ A configuration that specifies one or more attached Audit instances. See also [S
 | --- | --- |
 | string | None |
 
-## Embedded Database
+## Embedded database
+
+These settings are not valid for ServiceControl instances hosted in a container.
 
 ### ServiceControl/DbPath
 
@@ -143,11 +145,38 @@ The path where the internal RavenDB is located.
 > [!NOTE]
 > This setting is not relevant when running an error instance in a container.
 
+### ServiceControl/RavenDBLogLevel
+
+Controls the LogLevel of the RavenDB logs. See [Logging](/servicecontrol/logging.md).
+
+| Context | Name |
+| --- | --- |
+| **Environment variable** | `SERVICECONTROL_RAVENDBLOGLEVEL` |
+| **App config key** | `ServiceControl/RavenDBLogLevel` |
+| **SCMU field** | N/A |
+
+#if-version [5,)
+| Type | Default value |
+| --- | --- |
+| string | `Operations` |
+
+Valid settings are: `None`, `Information`, `Operations`.
+#end-if
+#if-version [,5)
+| Type | Default value |
+| --- | --- |
+| string | `Info` |
+
+Valid settings are: `Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`.
+
+#end-if
+
 #if-version [,5)
-The indexes and Esent logs can be stored in a different path from the the RavenDB database data files by using the following [RavenDB configuration app settings](https://ravendb.net/docs/article-page/2.5/csharp/server/administration/configuration):
 
 ### Raven/IndexStoragePath
 
+The indexes and Esent logs can be stored in a different path from the the RavenDB database data files by using the following [RavenDB configuration app settings](https://ravendb.net/docs/article-page/2.5/csharp/server/administration/configuration):
+
 > [!NOTE]
 > Only supported on RavenDB 3.5 storage engine (prior version 5). Use [symbolic links (soft links) to map any RavenDB storage subfolder](https://ravendb.net/docs/article-page/5.4/csharp/server/storage/customizing-raven-data-files-locations) to other physical drives.
 
@@ -167,6 +196,8 @@ Default: `%SYSTEMDRIVE%\ProgramData\Particular\ServiceControl\<instance_name>\DB
 
 #end-if
 
+## Logging
+
 ### ServiceControl/LogPath
 
 The path for the ServiceControl logs.
@@ -200,30 +231,6 @@ Controls the LogLevel of the ServiceControl logs.
 | --- | --- |
 | string | `Info` |
 
-### ServiceControl/RavenDBLogLevel
-
-Controls the LogLevel of the RavenDB logs. See [Logging](/servicecontrol/logging.md).
-
-| Context | Name |
-| --- | --- |
-| **Environment variable** | `SERVICECONTROL_RAVENDBLOGLEVEL` |
-| **App config key** | `ServiceControl/RavenDBLogLevel` |
-| **SCMU field** | N/A |
-
-| Type | Default value |
-| --- | --- |
-#if-version [5,)
-| string | `Operations` |
-
-Valid settings are: `None`, `Information`, `Operations`.
-#end-if
-#if-version [,5)
-| string | `Info` |
-
-Valid settings are: `Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`.
-
-#end-if
-
 ## Recoverability
 
 ### ServiceControl/TimeToRestartErrorIngestionAfterFailure
diff --git a/servicecontrol/servicecontrol-instances/deployment/containers.md b/servicecontrol/servicecontrol-instances/deployment/containers.md
@@ -40,7 +40,7 @@ The following environment settings are required to run a ServiceControl error in
 |-|-|
 | `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/deployment/containers.md) that stores the error instance's data. The database container should be exclusive to the error instance, and not shared by any other ServiceControl instances. |
+| `RAVENDB_CONNECTIONSTRING` | Provides the URL to connect to the [database container](/servicecontrol/ravendb/containers.md) that stores the error instance's data. The database container should be exclusive to the error instance, and not shared by any other ServiceControl instances. |
 | `REMOTEINSTANCES` | A JSON structure that provides URLs for the Error instance to access any [remote audit instances](/servicecontrol/servicecontrol-instances/remotes.md). When requesting audit data via the ServiceControl API, the Error instance will communicate to each of the remote audit instances in a scatter-gather pattern and then return the combined results. The URLs must be accessible by the Error instance directly, not constructed to be accessible from an external browser. |
 | `PARTICULARSOFTWARE_LICENSE` | The Particular Software license. The environment variable should contain the full multi-line contents of the license file. |
 
diff --git a/servicecontrol/servicecontrol-instances/index.md b/servicecontrol/servicecontrol-instances/index.md
@@ -17,7 +17,7 @@ A ServiceControl Error instance:
 
 ## Persistence
 
-Each ServiceControl Error instance stores message data in a RavenDB database. For instances deployed using the [ServiceControl Management Utility](/servicecontrol/servicecontrol-instances/deployment/scmu.md) or [PowerShell](/servicecontrol/servicecontrol-instances/deployment/powershell.md) this database is embedded with the ServiceControl Error instance. For ServiceControl Error instances deployed using [containers](/servicecontrol/servicecontrol-instances/deployment/containers.md) the database resides in a [separate container](/servicecontrol/ravendb/deployment/containers.md).
+Each ServiceControl Error instance stores message data in a RavenDB database. For instances deployed using the [ServiceControl Management Utility](/servicecontrol/servicecontrol-instances/deployment/scmu.md) or [PowerShell](/servicecontrol/servicecontrol-instances/deployment/powershell.md) this database is embedded with the ServiceControl Error instance. For ServiceControl Error instances deployed using [containers](/servicecontrol/servicecontrol-instances/deployment/containers.md) the database resides in a [separate container](/servicecontrol/ravendb/containers.md).
 
 Failed message data is retained until 7 days after successful retry is detected or the failed message is [manually archived](/servicepulse/intro-archived-messages.md). [This retention period can be customized](/servicecontrol/servicecontrol-instances/configuration.md#data-retention).
 
diff --git a/servicecontrol/servicecontrol-self-monitoring.include.md b/servicecontrol/servicecontrol-self-monitoring.include.md
diff --git a/servicepulse/containerization/index.md b/servicepulse/containerization/index.md
