Configuration Settings

The following configuration settings are available for HBR.

Table 1. Configuration Settings
Display Name Name Description
Maximum Amount of Sessions MaxSessions Indicates the maximum number of concurrent sessions that HBR needs to monitor. HBR maintains a session table to track the canister for that session, this indicates how big to make the session table (sessions kept/removed per LRU methodology).
Global Default Hits Per Second Per Canister DefaultPerSecMax The global number of hits/sec per canister (for 5 canisters and with the default of 200, HBR will throttle traffic to 1000 hits/sec). This global value can be overridden per canister with the CanisterPerSecMaxX directive.
HBR Rules PreProcess TCL Script PreProcScript Path to the HBR rules Pre-Process TCL Script.
Health Routing Method RoutingMethod Indicates how HBR should route traffic. HBR can route traffic in two ways, 1) "equal" indicating that it should equally balance traffic among the target processing machines, 2) "biased" indicating it should as much traffic as possible to the first canister and should it become unhealthy then fallover to the second canister and so forth.
StartUpRouting StartUpRouting The fallback routing method should HBR somehow be unable determine routing. This is a highly unlikely event, but an instance where it could occur is if DiscoverCaptureSocket.cfg in the [DecoupleEx] section was not configured with "SpoolAtStartUp=True", so that at service startup traffic would hit the HBR session agent before it had a chance to poll the target canisters for their health.
Script Trace ScriptTrace Script tracing enables tracking of session agent activities, which is useful for debugging.
Large Session Deletion Time Period in Seconds LargeSessionTimePeriodSecs Sets the amount of time in seconds wherein a certain number of hits are recorded. Ex. LargeSessionTimePeriodSecs=10, the time period being measured in this example is 10 seconds.
Large Session Deletion Hits Within Time Period LargeSessionTimePeriodHits Determines the number of hits that occur within a certain number of seconds. Ex. LargeSessionTimePeriodHits=500, the number of hits retained in a 10-second time period is 500. Once 500 hits have been reached, HBR will delete any remaining hits for that session.
Large Session Deletion Required Field LargeSessionReqField A way to exempt a session from deletion. For example, when using LargeSessionReqField=URL, then a specific string within the URL will determine which session is exempt from deletion.
Large Session Deletion Required Value LargeSessionReqValue The specific value within a field that will exempt a session from deletion. If any hit in a session meets these two criteria, LargeSessionReqField and LargeSessionReqValue, and if a particular field (in this case, the URL) contains a specific string, then the session is exempt from deletion regardless of whether it met the LargeSessionTimePeriodSecs and LargeSessionTimePeriodHits values. Take for example, LargeSessionReqValue=ReO. If the URL contains ReO (case insensitive), then that session is exempt from deletion.

Per Processing Server

For each processing server:

Table 2. Configuration Settings
Display Name Name Description
Canister Name CanisterName Machine name (or IP address) of the processing server to monitor.
SearchServer Port CanisterSSPort Port number for the SearchServer on the target Canister machine (default is 19000).
Canister Pipeline ID CanisterPipeID Associated with HBR are the child pipelines (the PipelineConfig* parameter) and this ties the canister to the child pipeline (this number is the * in PipelineConfig* parameter).
CanisterAppName CanisterAppName Specifies the AppName parameter of the associated HBR_Pipeline*.cfg (each AppName must be unique). HBR uses this value when parsing the GovernorStsEx to find the correct entry.
Canister Down Times CanisterOffline Scheduled Canister down times. "Daily at 2300 for 10 minutes winddown 20 minutes" indicates that at 10:40PM no new sessions (existing sessions only), 11:00PM no traffic whatsoever, resume all traffic at 11:10PM". An optional format would be "Tuesday at 2300 for 10 minutes winddown 20 minutes" indicating that it would be offline every Tuesday at this time.
HBR Initialization Time Out value InitTimeOut Specifies the amount of time (in seconds) that HBR will spend during initialization. Initialization can be time consuming in cases where there is a large amount of spool files.