Viewing backend services

The Backend Services page displays core services and APIs, allowing data interchange and integration. The integration APIs are completed by a standardized data format designed for data interchange. 

You can access the Backend Services page by navigating to Administration > Components > Backend Services.

For more information about the various services hosts and the tasks that you can perform, see:

Viewing the status of backend services

The Status page of the backend administration menu displays a list of all available services; the table is color coded to reflect the status of the services:

  • Green - The service is active.
  • Red - The service is inactive due to deployment errors.
  • White - The service has not been deployed.

The Backend Services page

Viewing the log

You can view the application log for a service clicking the icon at the end of the corresponding row.

As shown in the figure, the log table is color coded to reflect the type of message:

  • White - INFO
  • Yellow - WARN
  • Red - ERROR

Example: the Data service log

Depending on the log message, it may be possible to expand the description clicking on the icon highlighted in the figure.

Example: the Data service log (expanded view)

Viewing the summary status page for a service

Clicking on the name of a service in the Active services table, displays its detail page, that includes a toolbar with useful buttons to perform basic administration tasks. The available actions vary depending on the component.

Example: details for the Search service

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 Developing clients.

Capacity-Aware Placement Advice service

The Capacity-Aware Placement Advice service allows you to make choices for the placement and provisioning of virtual machines based on the available capacity.

Clicking on the name of the service in the Active services table, you can access its detail page where you can find placement advice statistics, that can help you troubleshoot the service.

Clicking Test placement triggers a test placement advice call and refreshes the Placement Advice Statistics table, to help you verify and troubleshoot the status of the service.

Clicking Show status refreshes the Placement Advice Statistics table.

By clicking Relocate you can relocate this backend service to another service container. For more information, see Relocating a backend service.

For more information on administering and troubleshooting the integration with BMC Cloud Lifecycle Management and the Capacity-Aware Placement Advice service, refer to Verifying and managing the Capacity-Aware Placement Advice integration.

Additional information

You can obtain all metrics for the service by examining the business driver "Placement Advice Service", which is automatically created in the administration domain called "Self Monitoring".

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.

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.

    If the data service is paused, the loading of data into the TrueSight Capacity Optimization database using the Data API will stop, and the data will be loaded when the data service is activated/run again.

  • 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.

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.

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.
  • Show log: Can be used to view the application log.

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.

Information

To use TrueSight Cloud Cost Control, you need the required license entitlement. For more information, see  License entitlements for TrueSight Cloud Cost Control .


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

In addition to starting and stopping the service by using the Run and Pause buttons, the following actions can be performed:

Icon

Button name

Action

Show queues status

Show the status of processing queues

Clear freshness

The Clear Freshness option resets the freshness timeout for all series. It is used in Development, Custom ETL development and Proof of Concept(poc) mode when reprocess data loaded by an ETL needs to quickly response.
For example, if you execute an ETL loading a specific set of series that is CPU_UTIL for two servers. Due to Clear freshness configuration, data warehouse do not reprocess series immediately which are recently imported.
If you want to perform series reprocessing before the timeout, click Clear Freshness button. You can also modify the default values Data Warehouse tab.

Clear blacklist

The Clear Blacklist option resets the blacklisted objects. When the objects or series of objects encounter three subsequent unmanaged errors, then they get marked as blacklisted objects. For reprocessing such series of blacklist objects, one has to execute Clear Blacklist. The Clear Blacklist also automatically gets perform after every hour. In case one or more series continue to get blacklisted and the blacklisting cause is not exogenous (for example, database connectivity or space saturation issues) you should investigate on data related problems and contact support for other cases.

Reload configuration

Reload the service's configuration

Show log

Show the application log

Pause

Pause the Near-real-time WareHouse service's

Run

Resumes the Near-real-time WareHouse service's

The Near-Real-Time Warehouse Queues 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 (*).
  • Active Threads: Number of threads concurrently running for the last sample.
  • Queue Length: Number of series still to be processed for the last sample.
  • Max Queue Age: Age of the oldest series still to be processes for the last sample.
  • Series Throughput: Number of series processed per second.
  • Processing Throughput: Number of processing per second; tipically, the number of rows.
  • Busy Percentage [%]: Percentage of time during which at least one thread is active.
  • Threads Busy Percentage [:%]: Sum of the processing times (in seconds) spent by each thread, divided by the duration of the sample. Note that this value can be greater than 100%; a value of 100% indicates an average of one active thread for the entire observation.
  • Thread Busy Factor: Sum of the processing times (in seconds) spent by each thread, divided by the total processing time.

(*) 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."

Remote scheduler supervisor service

This backend service is used to control the TrueSight Capacity Optimization schedulers. The most important function is to show the log, where some errors might be present and can be useful from a support perspective. On the Active services table, click Core Services - Remote scheduler supervisor, to perform one of the following functions:

  • Reload configuration: Useful in troubleshooting issues to manually force the scheduler supervisor service to re-load the monitored scheduler list.
  • Show log: Can be used to view the application log for this backend service.

Was this page helpful? Yes No Submitting... Thank you

Comments