Configuring TrueSight Operations Management Report Engine

Perform the following procedures to configure TrueSight Operations Management Report Engine:

Configuring TrueSight Operations Management Report Engine for performance reports

Perform the following configurations for proper operation of the performance reports.

Creating an External Report attribute set

An External Report attribute set enables the following:

  • Filtering capabilities — performance data is transferred from TrueSight Infrastructure Management Server to the report engine, and performance reports are generated only on those attributes you have selected.
  • Normalization of attributes across platforms — you can group similar attributes across platforms in one attribute set. For example, the "% CPU Utilization In System Mode (%)" attribute is used for UNIX, while the "System CPU Utilization (%)" is used for Windows monitors. You can group both attributes under one "CPU" attribute and generate performance reports using the "CPU" attribute set.

A non-super admin user can create External Report attribute sets. To do this, the non-super admin user must have the following TrueSight Infrastructure Management permissions:

  • Allow manage External Reports attribute set used in transferring data to external reporting DB - attribute set option locked
  • Allow manage reports

For more information, see the following documentation:

  • For TrueSight Presentation Server version 11.3.04, see  Permissions reference Open link
  • For TrueSight Presentation Server versions 11.3.01 through 11.3.03, see  Permissions reference Open link

To create an External Report attribute set:

  1. Log on to TrueSight console, and go to Configuration > Attribute Set.
  2. Perform one of the following actions:
    • Click Create Attribute Set.
    • Click the action menu  next to Attribute Sets and click Create Attribute Set.
  3. On the Create Attribute Set screen, in the Name field, enter a name for the attribute set.
    In the Infrastructure Management Server field, the TrueSight Infrastructure Management servers that are upgraded to 11.3.04 or later and are connected are available. If no TrueSight Infrastructure Management are connected or are not upgraded to 11.3.04 or later, you are redirected to the Configuration > Attribute Set page.
  4. If required, from the Infrastructure Management Server field, select the TrueSight Infrastructure Management server for which you want to create the attribute set.
    In the Type field, the External Report option is displayed and selected.
  5. In the Monitor Types field, select the monitor types whose attributes you want to include in the attribute set.
    Use the Shift and Ctrl keys to make multiple selections. To locate a specific attribute, use the Looking for box. 
    When you select a monitor type, the attributes present in it are displayed in the Attributes field.
  6. In the Attributes field, select the attributes that would form the attribute set.
  7. Click Save.
  1. On the TrueSight Infrastructure Management operator console, go to Options > Administration > Attribute Sets > Edit.
  2. Click the relevant option:
    • For a new Attribute Set, click Add in the AttributeSet Administration screen.
    • To edit an existing Attribute Set, click Edit. Click Add Attributes to add more attributes.
  3. On the Add Attribute Set screen, select the Attribute Set type External Report.
  4. Select the Monitor Type. Select all monitor types corresponding to the attributes to be grouped.
    Use the Shift and Ctrl keys to make multiple selections. To locate a specific monitor, use the Search For field.
  5. Click Next.
  6. Select the attributes to be grouped from under each of the monitor types in the Attributes section.
    Use the Shift and Ctrl keys to make multiple selections. To locate a specific attribute, use the Search For field.
  7. Click Next.
  8. Specify a name for the attribute set.
  9. Select the attributes to be included by selecting the corresponding check boxes in the Select column.
  10. Click Finish. The new External Report attribute set is available for use.

Configuring the Report Engine properties 

Changing the report engine properties is not required. If you must change the report engine properties, the properties are located in the perfsladatatransfer.properties file, located in the appropriate directory for your operating system:

  • For Windows: reportEngineInstallDirectory\ReportEngine\conf\properties
    \perfsladatatransfer
  • For Linux: ReportEngine/conf/properties/perfsladatatransfer

To change the Report Engine properties:

  1. Open the perfsladatatransfer.properties file using a text editor. The following properties are included in the file:

    Property type

    Parameter

    Description

    Data transfer schedule

    reportengine.datatransfer.
    schedule.interval

    Schedule interval in seconds of the performance data transfer job. Valid values are positive whole numbers.
    Default value (recommended): 3600

    reportengine.configjob
    .schedule.interval

    Schedule interval in seconds for configuration job which transfers configuration data. Valid values are positive whole numbers.
    Default value (recommended): 3600
    BMC recommends to set config job schedule to be equal or in multiple of the main data transfer job.

    reportengine.deleteconfigjob
    .schedule.interval

    Schedule interval for Delete job.
    Default value (recommended): 3.00 AM UTC/GMT

    reportengine.datagapfillerjob
    .schedule.interval

    Schedule interval for Delete job.
    Default value (recommended): 1.00 AM UTC/GMT

    reportengine.datatransfer.
    pentaho.job.thread.count

    Defines the number of threads to read data from the TrueSight Infrastructure Management database. Default value (recommended): 10

    Maximum history

    reportengine.datatransfer.
    maxhistoryretrieval.statdata.days

    Maximum stats history data in days to be transferred from TrueSight Infrastructure Management server to report engine.
    Valid values are positive whole numbers.
    Default value (recommended): 0

    reportengine.datatransfer
    .maxhistoryretrieval.ratedata.days

    Maximum rate history data in days to be transferred from TrueSight Infrastructure Management server to report engine.
    Valid values are positive whole numbers.
    Default value (recommended): 90

    Chunk size

    reportengine.datatransfer
    .ratestat.chunksize

    Stats and rate data in hours that is transferred in one data transfer job cycle. To collect history, the chunk size must be greater than the job schedule interval. Valid values are positive whole numbers.
    Default value (recommended): 3

    CSV file generationreportengine.csvfilegeneration
    .enable

    Generates .csv files in case of a data gap. If you do not want the Report Engine to generate .csv files during a data gap, set this parameter to false.
    Default value: true

    Collection of rate datareportengine.ratedatatransfer
    .enable
    Collects the rate data. If you want the Report Engine to collect rate data, set this parameter to true.
    Default value: false
    Boolean

    reportengine.pentaho.logging.level

    Indicates the value for default logging for performance data transfer in reportengine.log file. Default is ERROR. Recommended value is ERROR. If this is upgraded setup, change the value to ERROR


    Note

    To change the Retention Age property, use the ConfigureRetention CLI command.

  2. Save the perfsladatatransfer.properties file.
  3. Restart the TrueSight Operations Management Report Engine service. See, Starting and Stopping the Report Engine service.

Configuring maximum history of performance data

This section describes the configuration for transferring performance data from TrueSight Infrastructure Management database to reporting engine database. Reporting Engine can be configured to transfer history data present in TrueSight Infrastructure Management Server before it has been registered with reporting engine.

You can configure the maximum history of performance data to be retrieved from TrueSight Infrastructure Management server over multiple cycles by modifying the following parameters.

reportengine.datatransfer.maxhistoryretention.statdata.days=0
   reportengine.datatransfer.maxhistoryretention.ratedata.days=90

Maximum history is relative to current time. Default is set to 30 days.

Configuring TrueSight Operations Management Report Engine for Oracle Real Application Cluster

Note

If you are using Oracle RAC and have a SCAN IP address, you do not need to complete this procedure. This information is already configured during the Report Engine installation. For more information, see Installing TrueSight Operations Management Report Engine with the Oracle database.

After the Report Engine installation is finished, complete the following procedure to update the Oracle Real Application Cluster (RAC) JDBC URL:

  1. In a text editor, create a URL based on the number of host names and instances.
    The syntax is:

    jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=fullyQua
    lifiedHostName1)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=
    fullyQualifiedHostName2)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=
    fullyQualifiedHostName3)(PORT=1521))(LOAD_BALANCE=OFF)(FAILOVER=ON)(
    CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=serviceName)(FAILOVER_M
    ODE=(TYPE=SELECT)(METHOD=BASIC)(RETRIES=10)(DELAY=10))))

    where, 
    fullyQualifiedHostName1 is the full name of node1 in the Oracle RAC.
    fullyQualifiedHostName2 is the full name of node2 in the Oracle RAC.
    fullyQualifiedHostName3 is the full name of node3 in the Oracle RAC.
    serviceName is the connector to one or more instances.

    Note

    The URL must be a single string and should not contain any new line characters in between the URL. The number of node entries can be modified based on the number of nodes in the RAC.

    You can also provide virtual IP in the RAC URL.

    Example:

    (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=rac112-scan1.bmc.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=ORA95NEW)))

    where, rac112-scan1.bmc.com is the virtual IP.

  2. Stop the TrueSight Operations Management Report Engine service. For details, see Starting/Stopping of the BMC TrueSight Operations Management Report Engine service.
  3. Create a backup of the database_config.xml file located at ReportEngineInstallDir\ReportEngine\bin\reportsCL.

    Note

    If you create the backup file in the same directory, ensure the backup file does not have the .xml extension. Create the back up outside the BMC_PROACTIVENET_REPORTENGINE_HOME directory.

  4. Using a text editor, open database_config.xml, and search for the <url> tag.
  5. Update the following value with the URL that you created.

    jdbc:oracle:thin:@hostName:1521:instanceName
  6. Save and close the file.
  7. Start the TrueSight Operations Management Report Engine service. For details, see Stopping and starting the Report Engine Service

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

Comments