Viewing and managing backend services
TrueSight Capacity Optimization has a set of core services and APIs that allow data interchange and integration. The integration APIs are completed by a standardized data format designed for data interchange.
To view a backend service, navigate to Administration > SYSTEM > Status, select the Data Hub or Service Container component, and then select the backend service. The service details page is displayed.
You can perform operations on the backend service, such as view log, reload configuration, and so on. For details about relocating a backend service, see Relocating-a-backend-service.
For more information about each available backend service, see the following sections.
Auto Forecasting service
The auto forecasting service is responsible to calculate indicators. On the Active services table, click Core Services - Auto Forecasting Service and use one of the following functions:
- Run: By default this service is in the running mode. You can click Run to resume the auto forecasting service.
- Pause: Can be used for pausing the auto forecasting service temporarily. This function can be useful for debugging purposes.
- Wake up: The auto forecasting service runs continuously but for set intervals. It is not running during the interval sleeping time (300 seconds). You can click Wake up to force running of the auto forecasting service during the sleeping time so that it starts processing data.
- Force indicators refresh: When you modify any of the indicator thresholds, it might take up to a day to see the updated indicators values for affected systems. You can click Force indicators refresh to force refresh the indicators and view the latest data.
- Show log: Can be used to view the application log.
Backend Control service
The Backend Control service allows the execution of backend jobs, for example, scheduler tasks, through standardized APIs. Examples are:
- asynchronous scheduler task execution
- synchronous scheduler task execution
- asynchronous report execution
- synchronous report execution
Web services are exposed under the BASE_CONTEXT/CaplanBackendWS context. The exposed web services are:
- WSDHScheduler (the wsdl file is exposed under BASE_CONTEXT/CaplanBackendWS/WSDHScheduler?wsdl)
- WSDHReport (the wsdl file is exposed under BASE_CONTEXT/CaplanBackendWS/WSDHReport?wsdl)
For more information on developing clients for these services, refer to Using-Public-APIs.
Chargeback service
The chargeback service API provides methods to configure and view results of chargeback models. The supported protocol for this backend service is the REST web interface. On the Active services table, click API Providers - Chargeback service, to view the detail page and perform one of the following functions:
- Relocate: Can be used to relocate this backend service to another service container. For more information, see Relocating a backend service.
- Show log: Can be used to view the application log for this backend service.
Cost Estimation service
The Cost Estimation service estimates the aggregated costs, trends, and cost forecasts that are displayed on the TrueSight Cloud Cost Control user interface.
On the Active services table, click Core Services - Cost Estimation Service to view the detail page, and perform one of the following functions:
- Run: By default, this service is in the running mode. You can click Run to resume the service.
- Pause: Can be used to pause the service temporarily. This function can be useful for debugging purposes.
- Wake up: The service runs continuously but for set intervals. It is not running during the interval sleeping time (300 seconds). You can click Wake up to force running of the service during the sleeping time so that it starts processing data.
- Show log: Can be used to display the application log.
Data Provider service
Data Provider Service API provides methods to handle views workflow.
Data service
The Data service allows data exchange from/to TrueSight Capacity Optimization using a specific format; it also provides a way to send and retrieve data from TrueSight Capacity Optimization using standardized formats.
On the Active services table, click API Providers - Data service, to access the detail page for this backend service and perform one of the following functions:
- Run: Resumes the data service.
Pause: Pauses the data service.
- Reload configuration: Reloads the lookup cache held by the data service. This function is mainly useful to force the data service to reload look up caches in a scenario where you might have performed some manual look up changes for remote ETL lookups.
- Show log: Displays the application log for this backend service.
The supported protocol is the REST Web Service.
Lookup service
Lookup Service API provides methods to perform lookup and entity creation for ETL processes. The Lookup service loads only Private entity catalog into the memory. The Shared entity catalog is not loaded into the memory. This service executes a set of queries on the Shared entity catalog for searching only the required lookup fields i.e. it retrieves only a very small fraction of the catalog. If the searched lookup fields are not available, it will assign a new ID.
If the lookup service is unavailable during the execution of the ETL loader (for example, when the maintenance is performed on service container), ETL loader performs the caching of the unresolved entities locally. The ETL loader tries to resolve the entities during the next execution of the ETL.
Near-Real-Time Warehouse service
The NRTWH service is TrueSight Capacity Optimization's warehousing engine, responsible for the immediate warehousing of data.
Details for the Near-Real-Time Warehouse service
On the Active services table, click Core Services - Near-real-time Warehouse Service and use one of the following functions:
- Run: Resumes the near-real-time warehouse service. By default this service is in the running mode.
- Pause: Pauses the service temporarily. This function can be useful for debugging purposes.
- On demand processing: Wakes up the service.
- Reload configuration: Reloads the configuration of this service.
- Show log: Displays the application log.
The Processing status table provides useful information on the health of the Near-Real-Time Warehouse service. Statistics are updated at regular intervals and rolled up every hour. For each queue, the table provides the following details:
- Timestamp: The current date and time (updated every 5 minutes).
- Structure: Can be one of the following: APPL (domain), SYS (system), or WKLD (business driver).
Thread launcher: Name of the thread launcher. The name of the thread launcher has the following structure:
<part1>-<part2>, where:- <part1> can be var (variation), raw, st (store), wh (warehouse), red (reduce), or cs (custom stats).
- <part2> is the value of the Structure parameter, in lowercase, for example, wkld (workload).
Examples of valid names are "store-sys" or "ecs-wkld".
- Active threads: Number of threads concurrently running for the last sample.
- Queue length: Number of series still to be processed for the last sample.
- Estimated processing time: Estimated total time required in processing, with at least one active thread.
- Processing throughput: Number of processing per second; typically, the number of rows.
- Series throughput: Number of series processed per second.
- Prev. 7 days throughput: Number of series processed per second in last 7 days.
The Daily and monthly roll-up table acts as a historical log of all the batch processing and provides the following details:
- Timestamp: The starting time of the roll-up processing.
- Structure: Can be one of the following: APPL (domain), SYS (system), or WKLD (business driver).
- Status: Status of the queue.
- Aggregation level: Type of aggregation level used.
- Processed series: Total number of series processed.
- Processing time: Total time spent in processing, with at least one active thread.
- Series throughput: Number of series processed per second.
- Prev. 7 days throughput: Number of series processed per second in last 7 days.
Reservation service
Reservation Service API provides methods to manage the reservation workflows. The supported protocol for this backend service is the REST web interface. On the Active services table, click API Providers - Reservation service, to view the detail page and perform one of the following functions:
- Relocate: Can be used to relocate this backend service to another service container. For more information, see Relocating a backend service.
- Show log: Can be used to view the application log for this backend service.
Search service
The search service is used by the search functionality in TrueSight Capacity Optimization. The system task, called Search Index Updater updates the search index based on the new data coming in TrueSight Capacity Optimization by the ETL and based on the manual changes that you have performed. The search index might become out of sync with respect to the contents of TrueSight Capacity Optimization if you unschedule the updater task or perform some manual queries in the TrueSight Capacity Optimization schema to change bulk of data.
On the Active services table, clicking API Providers - Search service, displays the detail page for this backend service. On the detail page you can use the following options:
- Rebuild main index: Can be used to re-create the search index and ensure that it is correctly in sync with the contents of the TrueSight Capacity Optimization installation. The main index is used by the search function available at the top-right section of the screen.
- Rebuild tag index: Can be used while adding or editing tags on an sntity (for example, a system).
Time forecast model service
The time forecasting model service API provides methods to execute a time forecasting over the TrueSight Capacity Optimization data. The supported protocol for this backend service is the REST web interface. On the Active services table, click API Providers - Time forecast model service, to view the detail page and click Show log to see view the application log.