Performing system maintenance tasks

Use the Maintenance page in the TrueSight Capacity Optimization console to perform system maintenance tasks, such as collecting logs, installing out-of-the-box views, installing additional packages, updating public cloud catalogs, and so on.

To access the Maintenance page, in the TrueSight Capacity Optimization console, select Administration >System > Maintenance


Collecting logs

To collect logs from the Maintenance page, perform the following steps:

  1. Click Administration > System > Maintenance and click Collect logs.
  2. In the Collect logs page, make the appropriate selections:
    1. Platform logs: Select yes for Collect all platforms logs? to enable collection of platform logs. Select no, if you do not want TrueSight Capacity Optimization to collect platform logs.
    2. ETL or System Task logs: Select yes for Collect ETL or System task logs? to enable collection of ETL or System task logs. Select no, if you do not want TrueSight Capacity Optimization to collect ETL or System task logs.
      1. yes: Select ETLs or System tasks from the All ETL/System tasks selection list and click  to move it to the ETL/System tasks to collect list .
      2. Collect the logs for the last: Select the number of days for which you want to collect the logs.
  3. Click Collect logs.
  4. In the Collect Logs details page, click Download all log files to download all log files at once, or click  under the Log files column of the List of log files being collected table to download individual logs.

Info

If the log is stored in a multi-file archive, you must download all the files, and then open the first file to view and extract log files from the archive.

Log Collection overview

The task log collection mechanism enables you to download all log files for a specific ETL/System task with a single click, and also includes hierarchy rule logs.

Collected logs include a variety of additional information, such as:

  • Application Version
  • Component and Host status
  • Warehouse status
  • List of installed patches and addons
  • Count of systems and business drivers by type
The execution of the logGrabber can be described as:
  • An ad-hoc workflow executes the logGrabber and waits for log collection results
  • It splits big log files in chunks and provides you with a Download all button
  • Collect logs link that is present in several pages allows you to seamlessly access logs from anywhere in the console. Note that this link is visible to administrators only.
  • You can select specific logs to collect.
  • The Error page collects logs related to the error displayed
  • The task log page in ETL and System tasks collects all the logs for the current task
  • Platform alerts collect all the logs related to all the errors displayed
  • Login page: If TrueSight Capacity Optimization is not able to communicate with the database, the command-line logGrabber is executed on the Application Server.

Installing additional packages

The Additional Packages table lists all the available additional packages, like Views, integrations, extensions for distributed systems and so on, that can be installed on TrueSight Capacity Optimization, including the following details:

  • Item: Name of the package.
  • Vendor: Name of the vendor that is providing the package.
  • Execution date (if available): The date on which the package was deployed.
  • Component version: The current version of the package that is available by the vendor.
  • Installed version (if applicable): The version currently deployed in TrueSight Capacity Optimization.
  • Status: The current status of the package, for example, INSTALLED, ENDED, NOT INSTALLED.

To install a component, click  at the end of the corresponding package name row. If a component is already installed and a new version is available, click  to upgrade it.

To view the installation log (if available), click .

Performing maintenance activities

The Maintenance Activities table provides access to tasks that can be useful when managing a TrueSight Capacity Optimization installation. The table itself provides information on the tasks, including:

  • The name and description of the task
  • The date when the task was last executed
  • The status of the executed task

The Maintenance Activities table


You can run a task by clicking  at the end of the corresponding row, and view the task execution logs by clicking .

Running the domain extractor

The Domain Extractor option extracts data from another instance of TrueSight Capacity Optimization, making a copy that you can use on your installation; for example, it can be used to move data from a demo environment to a production server.

To run the domain extractor:

  1. Run the domain extractor by clicking  in the corresponding row.
  2. Click Next.
  3. Provide the following details:
    1. Domain: Select the domain from which you want to extract data into the file that you want to use for a further upload to another TrueSight Capacity Optimization instance.
    2. Extraction start time: Specify the extraction start time.
    3. Extraction end time: Specify the extraction end time.
    4. Resolution: Specify whether the data must be summarized hourly, daily, or monthly by selecting HourDay, or Month respectively. You can by selecting Detail if you want to summarize all the data currently available.
  4. Select the appropriate host and click Proceed.
  5. Click  to view the the deployment log.
    The page displays a list of the previous run of the domain extractors. 

  6. To download the out_app-extractor_*.datpkg  data file to the local downloads directory, click the Download icon.
    The downloaded data can be imported into the Capacity Optimization database by using the domain extractor importer ETL. For more information, see Generic - Domain extractor importer.

Running the log grabber

The Log Grabber option retrieves the log files of all TrueSight Capacity Optimization components and is useful for support purposes.

To run a log grabber:

  1. Run the log grabber by clicking  in the corresponding row.
  2. Click Next.
  3. Select the appropriate host for this operation and click Proceed.
  4. Click  to view the the deployment log.

Clearing the system cache

TrueSight Capacity Optimization caches the content of the most frequently used database tables to improve speed and performances. If any database tables were modified by external components through direct database queries, it is necessary to run Clear cache to notify TrueSight Capacity Optimization of the changes.

Clear cache clears cached data and reloads information from the database, allowing you to immediately see any changes, for example after applying a patch.

To clear the system cache, navigate to the Maintenance Activities tab under Administration > System > Maintenance and click the  (execute clear cache) button.

Managing patches

The Patches table lists all available patches, including:

  • The name of the patch
  • A description of the patch (if available)
  • The date when the patch was last executed
  • The patch version and currently installed version (if applicable)
  • The file name of the patch
  • The installation status of the patch

The Patches table


You can run a patch by clicking  at the end of the corresponding row, and view the deployment log by clicking . If a patch has already been applied, click the  button to execute the patch again.

In addition, you can rollback an installed patch by clicking . A Rollback: <patch name> page is displayed and lists all the hosts where rollback is possible. Select the appropriate hosts and click Rollback.

Viewing deployment logs

Click the  button, to view the Deployment logs table, a color-coded table that lists all deployment log messages for the selected task or patch, including:

  • Creation time: The execution date
  • Operation detail: Short description of the operation
  • Status: The final status of the operation, which can be one of the following:
    • ENDED: Successfully completed
    • WARNING: Partially completed due to errors (some of the required actions failed)
    • ERROR: Not completed due to errors (all the required actions failed)
    • RUNNING: Currently running

The  button at the end of each row allows you to download a detailed log for each operation. Logs may be requested by Customer Support for debugging, and can be useful to resolve issues.

Example of the Deployment Logs table

Click Back to return to the Maintenance page.

Re-installing views

After you deploy a service pack or patch to your existing TrueSight Capacity Optimization installation, you need to re-install (upgrade) all built-in views.

To do this, perform the following task:

  1. Navigate to the Additional packages tab under Administration > System > Maintenance.
  2. In the table that is displayed under Additional packages, click  (Upgrade view) for each built-in view to upgrade (and re-install) it to the current version of the product.

    At this point, the Maintenance page is refreshed, and the selected view is upgraded. Repeat this task for all built-in views. No further action is required.

Uploading a patch

The Upload patch file page enables you to upload a deployment file to TrueSight Capacity Optimization.

  1. Select Administration > System > Maintenance.
  2. In the Upload patch or additional package file area on the Maintenance page, click Browse to select the required patch file and click Upload.

    Note

    • The patch files usually contain an application server related .patch file and an ETL engine related .patch file. You must upload the application server related file before uploading the ETL engine related file.
    • You can upload only the file names that begin with a letter (upper/lowercase) or number, and have maximum 254 characters except '/', '\' or  ';'.
  3. On the Step 1 of 2: Overview page, click Next.
  4. On the Step 2 of 2: Hosts selection page select the required hosts to be updated.
  5. Click Proceed.
    The patch file is deployed automatically.

Updating catalogs of public cloud providers

This procedure is applicable only when TrueSight Cloud Cost Control is installed or the Amazon Web Services - AWS API Extractor is configured.

Before you install TrueSight Cloud Cost Control, see License entitlements for TrueSight Cloud Cost Control .

The Cloud Catalogs page provides information about the latest updates that are available for the catalogs of the public cloud providers. You must update these catalogs whenever you are notified about the availability of new updates. After you update the catalogs, TrueSight Cloud Cost Control will use the most up-to-date pricing information for cost computation.

Before you begin

Ensure that the Application Server is connected to the Internet so that the catalogs can be downloaded from the FTP server.


To update the public cloud catalogs, complete these steps:

  1. In the TrueSight Capacity Optimization console, expand Administration > SYSTEM and select Maintenance.
  2. Click the Software Updates tab.
    The Cloud Catalogs page displays the installed and available versions of catalogs and the date when they were last updated.


  3. Click Update Available.

    The Update Available button is visible only when the installed and available versions of the catalogs are different. If both the versions match, the "Catalogs are up to date." message is displayed and no action is required.

  4. On the Update Public Cloud Catalogs page, click Continue.
    The existing catalogs are updated to the latest versions.

    Information

    If the BCO_WEB_WARN305 message is displayed, verify your network connection, and then download the software updates. For more information about this message and the steps to resolve it, search for BCO_WEB_WARN305 in the Error codes topic.

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

Comments

  1. Javier Munoz

    Is there a way to install patches silently instead of via the Web? If so, please document the process

    Aug 23, 2018 04:51
    1. Bipin Inamdar

      Hi Javier,

      We checked with the SME. Currently, patches cannot be installed silently.

      Regards,

      Bipin Inamdar

      Aug 24, 2018 05:16
  2. Javier Munoz

    How can Additional Packages be completely removed (e.g., after not renewing maintenance for TSCO for Networks and removing all the imported entities)?

    Aug 23, 2018 04:53
    1. Bipin Inamdar

      Hi Javier,

      Thanks for sharing your queries. We have forwarded them to the appropriate SME. We will get back to you soon.

      Thanks and regards,

      Bipin Inamdar

      Aug 24, 2018 12:37
    1. Bipin Inamdar

      Hi Javier,

      It seems there is no option in the UI for removing additional packages. We will find out more about this and let you know.

      For removing imported entities, you can follow the entity removal process. For details, see Creating and viewing entities.

      Regards,

      Bipin Inamdar

      Aug 24, 2018 05:27
  3. Stefano Omini

    What about patching steps in case of HA configuration? How can I patch the passive nodes if no TSCO component is running and "listening" for patch deploy actions?

    Oct 17, 2018 03:16
    1. Bipin Inamdar

      Hi Stefano,

      Thanks for the feedback. We will check this with the SMEs and update the topic accordingly.

      Regards,

      Bipin Inamdar

      Oct 17, 2018 03:29