The Data Service manages connections between Tealeaf components and services and the databases they are querying. This service allows database connectivity to be managed as a Windows™-based service for security, reliability, and control.
To acquire data, Tealeaf servers and services send queries through the Data Service, which then issues queries to the appropriate databases, canisters, or both.
- Search Server does not communicate directly with the database.
- Any non-Portal Server that issues a command that requires the Data Service is redirected to the Search Server that is associated with the Portal Server. This instance of Search Server queries the Data Service and returns the data.
During the installation process, the Data Service is installed on the same server where the Data Collector is installed. The Data Service uses the same registry settings to self-configure and connect to the databases.
Connections
The Data Service replaces some of the functionality managed by the Search Server, which uses SQL authentication for direct access to the Tealeaf databases. In some environments, this authentication method is problematic.
Currently, the Data Service manages the following connections:
- User data: Tealeaf user information is made available to Tealeaf components through the data service.
- System status: The Status report uses Data Service to retrieve statistical information about the Tealeaf servers and databases.
- Portal Control Settings: Configuration settings internal to the Portal are stored in the
TL_SYSTEM
database and are retrieved at startup for use. - Canister Server Definitions: The Portal uses the service to acquire the definitions for all Canister servers in the environment.
- RTV Search and Replay Audit Logs: The CX RealiTea Viewer uses the service to commit audit logs to the Portal database which can be seen in the User Activity Reports.
- NT/Active Directory User Lists: When NT/AD authentication is enabled for Tealeaf, the Portal retrieves the list of configured NT/AD groups from the Data Service. The Data Service collects them at a scheduled interval from Search Servers in the Tealeaf system.
- Portal Reports: Wherever possible, the Portal relies on the data service as the data source during report generation. In particular, the data service provides inputs to the following reports:
- System status reports
- Active status and events reports and the Alert Monitor
- The Reporting Service is one component of the Data Service.
- Event and Dimension Definitions: Events, dimensions, session attributes, and other run-time data definitions are managed through Search Server, which queries the Data Service to interact with the database tables.
Configuring the Data Service
Through Search Server, Tealeaf servers and services communicate with the Data Service and the Report Server by extension.
On each Tealeaf server specified in TMS, the Search Server configuration must be supplied with a method for connecting to the Data Service, depending on the server type:
- Portal Server: The machine hosting the Portal Server must be provided a valid entry for
TeaLeaf Data Service
.- In most configurations, the service is installed on the Report Server, which is typically installed on the Portal Server machine. In these configurations, this value is
localhost:23000
. - If the Portal Server and the Report Server are split onto separate machines or if the service is installed in a non-standard server, then the value must be specified to point to the hostname and port number of the hosting server:
<Server_hosting_Data_Service>:23000
- In most configurations, the service is installed on the Report Server, which is typically installed on the Portal Server machine. In these configurations, this value is
- All other servers: All other Tealeaf servers require a valid entry for the Portal Server in their Search Server configurations.
- These servers communicate through the Portal Server, which knows how to contact the Data Service based on the configuration in the previous step.
- In Search Server configuration for non-Portal Server machines, the value for the data service should be left blank.
Note: If you set
EnableTLS
totrue
, Tealeaf Data Service will function normally, but it won't be accessible over an https URL using a browser. If you need to access the Data Service URL for debugging or troubleshooting purposes whileEnableTLS
is on, set theAllowUntrustedAuthentication
value parameter to1
and restart the server.
Starting and stopping the service
You can start, stop, and restart the Data Service through TMS.
- Log in to the Portal as an administrator.
- From the Portal menu, navigate to TMS.
- Click the WorldView tab.
- Select Servers view.
- Click the Data Service node.
The available commands are displayed in the Component Actions panel.
Accessing logs
Tealeaf administrators may access the Data Service log files through the Portal.
The Data Service generates log messages in the following log file:
<install_directory>\Logs\TLDataService.log
The log file is rolled daily at midnight. Log files from previous days include a YYYYMMDD
indicator in the filename.
- From the Portal menu, navigate to Portal Management.
- Click the Servers link in the left navigation pane.
- Click Manage Servers.
- The right side of the screen is populated with the configured servers.
- Select the Report Server.
- In the toolbar above the server configuration panel, click the Logs icon.
- From the Filter By drop-down, select Data Service.
The Data Service logs currently stored on the Report Server are listed.
You can also access the database entries for the Data Service through the Logs section in the Portal Management page.
Changing the log level
By default, the log level for the Data Service is set to 1, which means that the log file contains only three status messages: startup, shut-down, verification of connection to all databases.
If needed to resolve specific issues with the Data Service, you can change the logging level to a higher value. If Log Level 9 is enabled through TMS, the Data Service log file contains individual request information and additional trace/debug statements to assist in resolving issues.
The Data Service shares the same logging controls as other services managed through the Report Server. To change the logging level for it and other Report Server functions, set the Log Level value on the Database tab in the Report Server configuration in TMS.
Per-minute Data Service statistics
In addition to core logging functions, the Data Service writes statistical information on its current state to .CSV
files in the Logs
directory. These files provide performance information on the Data Service CPU usage, threads, handles, requests, and more.
Files are in the following location:
<install_directory>\Logs\TLDataService-Stats_YYYYMMDD.log
This file is updated every minute and is rolled every day. The file contains the following tab-delimited fields.
Field | Description |
---|---|
LogTime |
Timestamp for when the entry was written to the file |
DsUptime |
Current uptime for the Data Service in minutes |
ReqsSinceStart |
Requests since the Data Service was last restarted |
ReqsInLastMinute |
Requests to the Data Service in the last minute |
AvgReqsPerMinute |
Average requests to the Data Service per minute since last restart |
CPU |
CPU usage by the Data Service at the time the entry was written |
Handles |
Number of handles in use by the Data Service |
Threads |
Number of threads in use by the Data Service |
WorkingSet |
The amount of physical memory allocated for the Data Service |
PeakWorkingSet |
The maximum amount of physical memory used by the Data Service since last restart |
PrivateMemory |
The current amount of paged memory allocated by the Data Service |
PagedMemory |
The current amount of paged memory allocated by the Data Service |
PeakPagedMemory |
The maximum amount of memory in the virtual memory paging file used by the Data Service since last restart |
NonpagedSystemMemory |
The current amount of nonpaged system memory allocated for the Data Service |
PagedSystemMemory |
The current amount of pageable system memory allocated for the Data Service |
VirtualMemory |
The current amount of the virtual memory allocated for the Data Service |
PeakVirtualMemory |
The maximum amount of virtual memory used by the Data Service since last restart |
AvailWorkerThreads |
The number of worker threads currently available to the Data Service |
AvailCpThread |
The number of available asynchronous I/O threads available to the Data Service |