The Session Router session agent is used for routing traffic, which is necessary in a multi-processor or multi-canister environment, where the Transport Service must route traffic to one or more processing servers.
Routing is always done on a session percentage basis. For example, in a system with a Transport component and three Processor components to receive data, the Session Router agent can be configured to send each processing component a third of the traffic.
- For some deployments of the Processing Server, this session agent is included in the default pipeline and is required.
- Since this agent routes traffic at the session level, the data must be properly sessionized beforehand.
- If traffic is segregated using a method other than percentages, then the RTASplit session agent is required.
Configuration Settings
The following configuration settings are available for this session agent:
- Display Name values are displayed in TMS, which is the recommended method for configuring session agents.
- Name values are displayed in
TealeafCaptureSocket.cfg.
| Display Name | Name | Description |
|---|---|---|
Init Script |
InitScript |
TCL script that initializes this session agent.
The default value is PipelineSplitterCFG.tcl. |
Keep TEMP Config |
KeepTEMPConfig |
When set to true, temporary pipeline
configuration files are retained, which is useful for debugging. The
default value is false. |
Pipeline (0) |
PipelineEx0 |
This setting contains the default pipeline configuration, which sends hits to
next session agent in the current pipeline. This default configuration is the following:
|
Pipeline (1) |
PipelineEx1 |
This setting can be used for routing statistics hits to the appropriate
pipeline. The default setting is the following:
|
Sample Configuration
Sample SessionRouter section from TealeafCaptureSocket.cfg:
[SessionRouter]
TypeName=SessionRouter
DLL=SessionAgentPipelineSplitter.dll
DownStreamConfigSection=Null
InitScript=PipelineSplitterCFG.tcl
KeepTEMPConfig=False
PipelineEx0=Traffic SessPct=0-100
PipelineEx1=Traffic Stats || Decouple || Socket TeaBag0:1966
PipelineEx2=Traffic SessPct=0-50 || Decouple ||
Socket TeaBag1:1966
PipelineEx3=Traffic SessPct=51-100 || Decouple ||
Socket TeaBag2:1966 UseSSL=trueThe above example has a main pipeline (PipelineEx0) and three child pipelines, one of which is the Traffic Status pipeline and the other two receiving 50% of the traffic.
Pipe 0 (PipelineEx0)
is the main pipeline, as specified in TealeafCaptureSocket.cfg.
Normally, SessionRouter terminates the main pipeline, as in the above
example where the DownStreamConfigSection points to Null.
All the other pipelines are considered to be child pipelines to SessionAgentSessionRouter.
- The stats pipeline is for statistics hits, which are routed to the Reporting Server.
- The two session traffic pipelines route the two halves of the traffic to the two processing servers.
- The Session Router session agent supports the creation of up to 64 child pipelines.