The Tealeaf Event Bus is a separately configurable component of Tealeaf cxConnect for Data Analysis.
To install the Event Bus:
- In your Tealeaf software distribution, navigate to the following directory:
cxConnect\Event Bus
- Copy all files in this directory to the Tealeaf installation directory on the server where cxConnect for Data Analysis is installed. These files include:
CEPCustomFields.cfg
- configuration file for custom Event Bus fields.TeaLeaf.Pipeline.CEP.dll
- core Event Bus processingTealeaf EventBus.doc
- documentation for Event BusTeaLeafEventBus.cfg
- configuration file for core Event Bus
If any of these fields is missing from the installation directory where cxConnect for Data Analysis was installed, check the software distribution. For more information, contact Support.
Enabling the Event Bus
To enable the pipeline, edit the Canister configuration by using TMS.
- Log in to the Portal as an admin user.
- From the Portal menu, navigate to TMS.
- In the Servers view, select the wanted server to drill down to components.
- Open the Canister node to display the configurations.
- Click the Canister configuration.
- In the Config Actions pane, click View/Edit.
- In the Services Perform tab, select Enable Event Bus.
- Click Save.
The Canister automatically recognizes the change in configuration and creates the Event Bus pipeline.
After you enabled the Event Bus, you can review the status of the Event Bus pipeline to verify that hits are being delivered to it.
To view the status of the Event Bus pipeline, use the Tealeaf Capture Status utility on the host server or the Pipeline Status tab in TMS.
Configuring the Event Bus
You can edit details of the Event Bus configuration by using the Pipeline Editor.
- In TMS, open the Canister node to display the configurations.
- Click Event bus configuration.
- In the Config Actions pane, click View/Edit.
The Event Bus configuration is displayed in the Pipeline Editor.
- In the left pane, select the topmost node: Event Bus configuration. Then, click Edit.
The Event Bus configuration is displayed:
Setting Description Application Name
For the Event Bus, set this value to TealeafEventBus
.VM Free Disable Threshold
The threshold percentage of free virtual memory below which the pipeline automatically shuts down. To disable this check, set this value to 0. VM Free Enable Threshold
After a shutdown, the pipeline restarts when the percentage of free virtual memory exceeds this value. This value should be greater than the value set for VM Free Disable Threshold
, even if that value is set to 0.Restart Interval
The interval in seconds at which the pipeline checks to see if a restart is necessary. Restart Reset Interval
The period in seconds over which the pipeline can attempt restarts.
Changing timestamps
If necessary, you can change the timestamp format that is recorded for requests in the events sent to the Event Bus, by using the Portal.
By default, time values in the request are written into the [timestamp]
section of the request in a familiar format. For example:
[timestamp]
RequestTimeEx=2011-06-28T04:20:35.074529Z
RequestEndTimeEx=2011-06-28T04:20:35.074529Z
If needed, you can change the timestamp format that is recorded for requests in the events sent to the Event Bus to use UNIX™ ticks.
- This timestamp format change applies only to HTTP output for CEP.
- The change applies only to the
RequestTimeEx
timestamp in the hit request, if it is included in the[HTTPFields]
section in theCustomFields.cfg
file. - The
[CEP]
section of the request has a DateTime name-value pair that is in seconds since 1970 format at a resolution of one second. The event timing entry is not affected by this configuration change. - This change must be applied to each Canister sending events to the Event Bus.
Complete the following steps to enable this configuration change.
- From the Portal menu, navigate to TMS.
- Click the WorldView tab.
- Select View > Servers.
- For each server that hosts a Canister:
- Select the server.
- Click the Canister node.
- Click Event Bus configuration.
- Click View/Edit Raw.
- Search the configuration for
[CEP]
. This section contains the raw version of the configuration for the Event Bus on the selected Canister. - Search the
[CEP]
section forHTTP_PageTimeFormat
. - If the entry does not exist, add the following:
HTTP_PageTimeFormat=unix
Note: If the entry is not present, the default Tealeaf time formatting is applied. To switch back to the default, either delete or comment out the line. Or, you can change theunix
value totealeaf
. - Click Save.
- Add the job to a task. Do not submit.
- Repeat the above steps to the other Canisters hosting the Event Bus.
- Submit the task to make the change at the same time for all Event Bus instances.
- If you did not do so already, insert the
RequestTimeEx
field in the[HTTPFields]
section in theCustomFields.cfg
file.
Testing the Event Bus
To test, you can direct the Event Bus to deliver .TLA
files to an archive directory.
- In TMS, open the Canister node to display the configurations.
- Click Event bus configuration.
- In the Config Actions pane, click View/Edit.
The Event Bus configuration is displayed in the Pipeline Editor.
- In the left pane, review the session agents in the Event Bus pipeline.
In the default configuration, the terminating session agent is the Null session agent. The terminating session agent defines where pipeline data is delivered after processing by the pipeline. In this case, it is not delivered.
- From the Available Session Agents pane on the right side of the screen, click and drag the Archive session agent into the pipeline. Drop it just in front of the Null session agent.
- Drag the Null session agent back to the Available Session Agents pane.
The Event Bus pipeline is now terminated at the Archive session agent.
- Select the Archive session agent and click Edit.
- Review the settings.
In particular, verify the setting for Archive Directory, which identifies the folder in which the
.TLA
files are delivered from the Event Bus pipeline. This directory is typically the following:C:\TeaLeaf\Archives
- Click OK.
- In the Pipeline Editor, click Save.
- In the Update Servers dialog, accept all options and click Add Tasks and Submit.
The job is submitted to TMS for immediate processing. The job includes a restart of the affected Canister(s). You can monitor the progress of the job in the Jobs tab.
When the job is completed, sessions containing Event Bus data are delivered in Tealeaf archives to the designated directory.
- Check the directory for the presence of these files.
- Select one
.TLA
file and open it in RTV. - Open one of the enclosed sessions.
Note: If you did not include the response in the data sent to the Event Bus, replay view does not display properly.
- In the RTV toolbar, click the Request button. The request of the first page is displayed.
- Scroll down the request view until you see the
[CEP]
section.If the data is present, then the Event Bus is working properly.
You can now configure the Event Bus to deliver hits to the appropriate destination.