The Tealeaf Status report generates current metrics from each Tealeaf server configured in the Portal Management page. These incremental snapshots can be captured at intervals and can be used to track system changes over time or when specific modifications are made to it.
The Tealeaf Status report is a useful mechanism for troubleshooting issues in your Tealeaf solution. Tealeaf Status reports can be scheduled to be run periodically or can be manually executed from the command line.
- Login as an administrator.
- Navigate to Portal Management.
- Click Logs in the left navigation pane.
- Click View Tealeaf Status.
Queried servers
After the report is enabled, report data is automatically gathered for all Tealeaf servers that are identified in the Portal. If the list of active servers in the Portal Management page reflects the sources for the Tealeaf Status report, no further configuration is required.
To review the currently active Tealeaf servers:
- Login as an administrator.
- Navigate to Portal Management.
- Click Tealeaf Servers.
- Click Manage Servers.
- The list of servers is displayed. When you generate a Tealeaf Status report, data is queried from all servers listed as Active.
- To create a reference to a server that is not on the list, click New.
Adding optional servers
In some situations, a server may be configured as a failover option if another server goes down. The Tealeaf Status report can be configured to look for these additional backup servers.
You may use the following steps to add optional servers to the TealeafStatus configuration file.
- Login as an administrator.
- Navigate to TMS.
- Click the WorldView tab.
- Select the Scheduling Service node.
- Click TealeafStatus configuration file.
- In the Config Actions panel, click View/Edit.
- At the bottom of the file, you should see the following configuration information.
Note: If this configuration information is not available and you are using a build that supports this optional configuration, you can copy and paste the following into your configuration file.
# # Server Types: # #Processor #DataCollector #DataServer #cxConnect #Tms #ReplayServer #ReportService #SelectiveArchive #Hbr #Database #Pca #Verify #Visitor #Report #Tli # # AdditionalServers: Server_<n>=[ServerName],[ssPort],[ServerType],[ServerType],... # #Note: Can be multiple types. # # Where: # <n> = a number, each one must be unique. # [ServerName] = Name of the server # [Title] = Server Title for TealeafStatus # [Port] = Port number of server # [,ServerType] = Server Type ie: DataCollector # [,ServerType] = Server Type ie: cxConnect # [AdditionalServers] #Server_1=ServerName,DataCollector(warm),19000,DataCollector - Under the
[AdditionalServers]section, you can add new servers by doing the following:- Copy the
Server_1line. - Paste it as a new line.
- Remove the hash mark (
#) at the front of the line. - Change the settings for the new server as needed.
Note: An optional server can be marked as a server of multiple types. Add new server entries as comma-separated text values from the Server Types list at the top of the text above.
- Copy the
- When you are satisfied with your changes, click Save.
- Submit the job to TMS.
When Tealeaf Status runs, these additional servers are added to the list of servers Tealeaf Status queries.
Generating Tealeaf Status from the command line
You can run Tealeaf Status reports at the command line when needed.
Run the following command:
<install_directory>\Tools\TealeafStatus.exe
The command line accepts the following parameters.
| Parameter | Description |
|---|---|
-? |
Get help from TealeafStatus.exe. |
-dataserver |
Server host of the Data Service |
-dataserverport |
Port number through which to communicate with the Data Service on the above host |
-general |
Generate a general Tealeaf Status report |
-verbose |
Generate a verbose Tealeaf Status report |
-file |
The filename of the report |