In the following settings, X indicates the index number for the canister.
| Setting | Description |
|---|---|
CanisterNameX |
Name or IP address of the target canister. |
CanisterPipeIDX |
ID of the associated HBR_PipelineX.cfg so that HBR knows the child
pipeline associated with the canister. |
CanisterAppNameX |
AppName value from the HBR_PipelineX.cfg file, so that HBR knows the
Governor Status entry from the GovernorStatusEx command. |
CanisterSSPortX |
The search server port number for the target canister. The default value is 19000. |
CanisterPerSecMaxX |
Maximum hits/sec for the target canister, which overrides the default global setting and enables the deployment of canisters with different capacities. The default value is the global default value. |
CanisterSSLogX |
Whether HBR requests should be logged to the Search Server log. The default value is
False. |
Canister Down Times
Health-based routing (HBR) must be apprised of scheduled canister down times. For each canister, you can specify the daily or weekly times when HBR should wind down usage before stopping the flow of hits to the canister, so that maintenance tasks can be performed on it.
The following configurations describe multiple scheduled downtimes for the same canister.
Individual downtimes begin with the same identifier (CanisterOffline=1) and may be
appended with a unique extension (a, b) to specify multiple downtimes.
Example configurations:
CanisterOffline1=Daily at 2300 for 10 minutes winddown 20 minutesEvery day at 10:40 PM, stop the flow of new hits to this canister. At 11:00 PM, stop the canister for 10 minutes.
CanisterOffline1a=Tuesday at 0200 for 10 minutes winddown 20 minutesEvery Tuesday at 1:40 AM, stop the flow of new hits to this canister. At 2:00 AM, stop the canister for 10 minutes.
CanisterOffline1b=Friday at 0500 for 10 minutes winddown 20 minutesEvery Friday at 4:40 AM, stop the flow of new hits to this canister. At 5:00 AM, stop the canister for 10 minutes.
Disabling HBR-Canister connections
You can disable HBR connections to individual Canisters through the HBR configuration files. However, for nonscheduled downtime, making these changes without interrupting data capture and processing may be challenging. You can use the following method instead.