Skip to content

Commit 3dfdf57

Browse files
authored
Document the hierarchical entities connection string parameter for 6.12.0 of ServiceControl (#8068)
* Document the hierarchical entities connection string parameter for 6.12.0 release * Update ASBS ServiceControl example connection string * Spelling and capitalization tweaks
1 parent 8b2cae9 commit 3dfdf57

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

servicecontrol/transports.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,27 +63,32 @@ As of versions 4.33.3 and 5.0.5 of ServiceControl, support for partitioned entit
6363

6464
### Enabling Hierarchical Entities
6565

66-
When [a hierarchy namespace prefix](/transports/azure-service-bus/configuration.md#entity-creation-hierarchy-namespace) is configured on endpoints, ServiceControl needs to be configured for the hierarchy namespace to monitor those endpoints.
66+
As of version 6.12.0 of ServiceControl, support for hierarchical entities can be enabled by adding the following connection string parameter:
6767

68-
At a minimum, the error queue name needs the prefix prepended to the queue name, separated by a `/`. If monitoring or auditing are enabled, they also need to be modified.
69-
70-
For example, given a hierarchy namespace of `my-hierarchy` and error, audit, and monitoring queues named `error`, `audit`, and `monitoring`:
71-
- The [error queue name](/servicecontrol/servicecontrol-instances/configuration.md#transport-servicebuserrorqueue) would need to be set to `my-hierarchy/error`.
72-
- The [audit queue name](/servicecontrol/audit-instances/configuration.md#transport-servicebusauditqueue) would need to be set to `my-hierarchy/audit`.
73-
- The [monitoring queue name](/servicecontrol/monitoring-instances/configuration.md#transport-monitoringerrorqueue) would need to be set to `my-hierarchy/monitoring`.
68+
* `HierarchyNamespace=<hierarchyNamespacePrefix>` — Configures the transport to use [a hierarchy namespace prefix](/transports/azure-service-bus/configuration.md#entity-creation-hierarchy-namespace). The default value is `null`, which means no hierarchy namespace is used.
7469

7570
This isolates the ServiceControl instance to the hierarchy, so an instance-per-hierarchy would be required to monitor multiple hierarchies.
7671

7772
#### Configuring a single ServiceControl instance for multiple hierarchies
7873

7974
Endpoints configured with a hierarchy namespace will use error, audit, and monitoring queues prefixed with the hierarchy namespace. To monitor all hierarchies with a single ServiceControl installation:
8075
1. Configure ServiceControl error, audit, and monitoring instances as you would without using a hierarchy namespace.
81-
2. For each hierarchy-specific error, audit, and monitoring queue that you wish to monitor centrally, configure [auto-forwarding for their corresponding queues in azure](https://learn.microsoft.com/en-us/azure/service-bus-messaging/enable-auto-forward#update-the-auto-forward-setting-for-an-existing-queue) to forward messages to the central error, audit, and monitoring queues.
76+
2. For each hierarchy-specific error, audit, and monitoring queue that you wish to monitor centrally, configure [auto-forwarding for their corresponding queues in Azure](https://learn.microsoft.com/en-us/azure/service-bus-messaging/enable-auto-forward#update-the-auto-forward-setting-for-an-existing-queue) to forward messages to the central error, audit, and monitoring queues.
77+
78+
#### Previous versions
79+
80+
Previous versions of ServiceControl can still be configured on a per-hierarchy basis. At a minimum, the error queue name needs the prefix prepended to the queue name, separated by a `/`. If monitoring or auditing are enabled, they also need to be modified.
81+
82+
For example, given a hierarchy namespace of `my-hierarchy` and error, audit, and monitoring queues named `error`, `audit`, and `monitoring`:
83+
- The [error queue name](/servicecontrol/servicecontrol-instances/configuration.md#transport-servicebuserrorqueue) would need to be set to `my-hierarchy/error`.
84+
- The [audit queue name](/servicecontrol/audit-instances/configuration.md#transport-servicebusauditqueue) would need to be set to `my-hierarchy/audit`.
85+
- The [monitoring queue name](/servicecontrol/monitoring-instances/configuration.md#transport-monitoringerrorqueue) would need to be set to `my-hierarchy/monitoring`.
86+
8287

8388
### Example connection string
8489

8590
```text
86-
Endpoint=sb://[namespace].servicebus.windows.net; SharedSecretIssuer=<owner>;SharedSecretValue=<someSecret>;QueueLengthQueryDelayInterval=<IntervalInMilliseconds(Default=500ms)>;TopicName=<TopicBundleName(Default=bundle-1)>;EnablePartitioning=<true|false(Default=false)>
91+
Endpoint=sb://[namespace].servicebus.windows.net; SharedSecretIssuer=<owner>;SharedSecretValue=<someSecret>;QueueLengthQueryDelayInterval=<IntervalInMilliseconds(Default=500ms)>;TopicName=<TopicBundleName(Default=bundle-1)>;EnablePartitioning=<true|false(Default=false)>;HierarchyNamespace=<hierarchyNamespacePrefix>
8792
```
8893

8994
## Azure Storage Queues

0 commit comments

Comments
 (0)