Skip to main content
Pentaho Documentation

Monitor System Performance Using Pentaho Operations Mart

Overview

The Pentaho Operations Mart makes it easy for you to monitor system performance for information, such as how long it takes to run certain reports.

The Pentaho Operations Mart makes it easy for you to monitor system performance for information, such as how long it takes to run certain reports. We automatically set up a way for you to do this using the Operations Mart and Analyzer, Interactive Reports, Report Designer, and Dashboards. The Operation Mart aggregates data from the Pentaho Server log files into pre-built audit reports that provide information you might need. If these reports do not meet your needs, you can use Pentaho Data Integration Operations Mart to change them.

Download and Install BA Operations Mart Files

The Operation Mart files are stored in a pre-packaged .zip file.  You will need to stop the Pentaho Server, download the file and unpack it, then restart the Pentaho Server to import the the files.

  1. Stop the Pentaho Server.
  2. Download the pentaho-operations-mart-7.0.0.zip file from the Pentaho Customer Support Portal.
    1. On the Customer Portal home page, sign in using the Pentaho support user name and password provided in your Pentaho Welcome Packet.
    2. Click Downloads, then click Pentaho 7.0 GA Release in the 7.x list.
    3. On the bottom of the Pentaho 7.0 GA Release page, click the Operations Mart folder in the Box widget and download the pentaho-operations-mart-7.0.0.zip file.
  3. Unpack the file by running install.sh or install.bat.
  4. In the IZPack window read the license agreement, select I accept the terms of this license agreement, then click Next.
  5. In the Select the installation path text box, save the file in the pentaho/server/pentaho-server/pentaho-solutions/system/default-content directory, then click Next.
  6. A warning message appears.  Click Yes.
  7. When the installation finishes, click Quit.
  8. Go to the pentaho/server/pentaho-server/pentaho-solutions/system/default-content directory, then delete any files that you don't need for your repository's platform.  
If Your Pentaho Repository is On: Only Keep These Files:
PostgresSQL
  • pentaho-operations-mart-clean-7.0.0.zip *
  • pentaho-operations-mart-etl-7.0.0.zip
  • pentaho-operations-mart-operations-7.0.0.zip
MySQL
  • pentaho-operations-mart-clean-mysql5-7.0.0.zip *
  • pentaho-operations-mart-etl-mysql5-7.0.0.zip
  • pentaho-operations-mart-operations-mysql5-7.0.0.zip
Oracle
  • pentaho-operations-mart-clean-oracle10g-7.0.0.zip *
  • pentaho-operations-mart-etl-oracle10g-7.0.0.zip
  • pentaho-operations-mart-operations-oracle10g-7.0.0.zip
MS SQL Server
  • pentaho-operations-mart-clean-mssql-7.0.0.zip*
  • pentaho-operations-mart-etl-mssql-7.0.0.zip
  • pentaho-operations-mart-operations-mssql-7.0.0.zip

* Keep the pentaho-operations-mart-clean-<database>-7.0.0.zip file only if you want to Pentaho to automatically delete entries from the operations mart on a regular schedule.  For more information, see Clean Up Operations Mart for details.

  1. Restart the Pentaho Server.

  2. If you've deployed Pentaho on JBoss, after the server is started, update the JNDI name in the pentaho_operations_mart connection PDI_Operations_Mart to jboss/datasource/PDI_Operations_Mart.

  3. The Operations Mart tables and schemas are on the Pentaho Repository.  If you’ve deployed the Pentaho Repository on MySQL, MS SQL Server, or Oracle,  you'll need to update the pentaho_operations_mart data database connection information.
    1. Click the Manage Data Sources button in PUC and select pentaho_operations_mart.  
    2. Change the database connection information so that it reflects the information needed to connect to your Pentaho Repository.

The Operations Mart is ready to be used.

Choose a Pre-Built Operations Mart Report

We provide pre-built Interactive Reports and a data mart called the Pentaho Operations Mart. The Operations Mart contains all the data from system log files. This table shows the reports that we have pre-built for you. Choose the report that fits your needs and follow the instructions in View and Edit Operations Mart Reports.
Table 1. Pre-Built Audit Mart Reports
Information Shown Report Name
Amount of time it takes a report to run Content Duration
File names of all content failures within a defined length of time Content Failures
Compare login metrics for days within a specified month Content Request Day of Month
Compare login metrics for a days in a week within a specified year Day of Week Request and Login Metrics
List of content sorted by type, used within a defined length of time Content Type Usage
List of content usage within a defined length of time Content Usage
Compare login metrics by hour for a specified day Hours in Day Request and Login Metrics
Length of time for logins and the number of logins per user for specified length of time Session Duration Counts

View and Edit Operations Mart Reports

  1. Identify the report that you want to open from Choose a Pre-Built Operations Mart Report.
  2. Double-click Browse Files.
  3. Click on public > Pentaho Operations Mart > BA Audit Reports.
  4. Select the appropriate file and click Open. Your monitoring and logging data appears in the pre-built report.
  5. If you need to edit this report, you can do so from within the opening tool.

See Create Analysis, Interactive Reports, and Dashboards for more information about editing a report in Analyzer or Interactive Reporting.

See Design Print-Quality Reports for more information about editing a report using Report Designer.

Create Operations Mart Reports

If the reports we provide are not quite right for you, you can create your own reports.

  1. From within the User Console, select Create New and then choose the type or report you want to create.
  2. Select the data source that you need.
    Information Shown Data Source
    Detail information related to the execution of the.xactions. that run the reports on the Pentaho Server pentaho_operations_mart: BA Operations Mart - Component
    Information related to the execution of content , such as which tool or which user ran the content on the Pentaho Server pentaho_operations_mart: BA Operations Mart - Content
    Information for the Pentaho Server related to a user, such as number of sessions, how long, and what time pentaho_operations_mart: BA Operations Mart - User Session
    Information about individual job entry executions on the Pentaho Server pentaho_operations_mart: PDI Operations Mart - Job Entry
    Detailed performance information for the Pentaho Server pentaho_operations_mart: PDI Operations Mart - Performance
    Detailed information about individual step executions on the Pentaho Server pentaho_operations_mart: PDI Operations Mart - Step
    Information related to transformations and jobs run on the Pentaho Server pentaho_operations_mart: PDI_Operations_Mart
  3. Create a new report as described in the appropriate user section.

See Create Analysis, Interactive Reports, and Dashboards for more information about building a report in Analyzer or Interactive Reporting.

See Design Print-Quality Reports to build a report using Report Designer.

Update the Operations Mart

You may need to update the report date and time, or the data that is populated into the report itself.

  1. From within the User Console, select Browse Files > public > Pentaho Operations Mart > Update Audit Mart.
  2. Double-click either Update Operations Mart Date & Time or Update BA Operations Mart Data.
  3. View a report to confirm that the updates applied.

Clean Up Operations Mart

The operational data in Operations Mart tables are set to automatically remove entries older than 365 days.  If you want to change this schedule so that the operational data is deleted using a different time frame, you will need to add a variable, named ba.cleanup.max.age, in the kettle.properties file located in  {user.home}/.kettle directory. 
  1. Stop the Pentaho Server.
  2. Open the kettle.properties file in the administrative user's {user.home}/.kettle directory.  
  3. Add the ba.cleanup.max.age variable to indicate the age above which entries are deleted.  For example, if you want to delete entries that are older than 30 days, add this:
ba.cleanup.max.age=30
  1. Save and close the kettle.properties file.
  2. Restart your Pentaho Server for the setting to take effect.