Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Creating custom reports using the Analyzer detail view Report Builder

The Ops Center Analyzer detail view Report Builder enables you to create your own queries and generate reports. The Report Builder provides a comprehensive, extensible and reusable reporting infrastructure that is based on a regex-based query language (MQL) that retrieves and filters the data in the Analyzer detail view database. MQL allows complex analysis in real time with constant run-time. MQL syntax makes it possible to traverse relations, identify patterns in the data, and establish a correlation.

Using Report Builder, you can create a report of resources and associated metrics that you want to monitor closely. You can also extend the Analyzer detail view built-in reports.

The first step is determining the resource and metrics that you want to analyze. You can identify this by using the UI reports or the one you want to monitor closely, and then create the custom report using one of the following methods:

  • Build a query using the UI: Use the Create Using Query Builder option to build a query for creating a report.
  • Write a query: Use the Create Using MQL option to write a query for creating a report.

To access the Report Builder, go to the Analyzer detail view UI and from the left pane, click Reports > Build.

Creating a report using Query Builder

The Query Builder helps you generate reports with a simple UI. It allows you to select the resource and apply filters. For example, you can run a simple query that shows the list of LDEVs across the same resource (such as, Hitachi Enterprise storage system).

The query is built on the following:

  • Resource group: Resource groups are the types of targets that are monitored using the Analyzer probe. For example, if you want to troubleshoot an Hitachi Enterprise storage system, you must select the Hitachi Enterprise Storage resource group.
  • Resource: There can be multiple resources associated with a resource group. For example, the pool, LDEV, and MPB are resources associated with Hitachi Enterprise Storage resource group.
  • Filter: Use the filter to select the metrics associated with a resource. For example, if you select the Pool resource, the pool ID and total IOPS are available as filters. In a query, you can add multiple filters for a resource.

Procedure

  1. In the Analyzer detail view left pane, select Reports > Build.

    The Build window opens.
  2. Click Create Using Query Builder.

  3. In the Create Using Query Builder window, use the Select Resource box to start building a query.

    GUID-B1C6C807-44C9-4646-B8D8-FE242A47609E-low.png

  4. Let's assume you want to build a query that shows the total IOPS of the LDEVs associated with Hitachi Enterprise Storage system serial number 421358.

    1. Select the Resource Group and Resource that you want to query.

      In this example, we will select the Hitachi Enterprise Storage resource group and the Storage System resource.

      After selecting the resource group and resource, the Resource and Filter options are enabled and a message to drag and drop the Filter or Resource is displayed.

    2. To add the filter, drag the Filter icon as follows:

      GUID-FD2AB60F-3E83-4D3B-A463-E323828BE278-low.png

      The Enter Filter Details box is added next to the Select Resource box.

    3. Select the Filter. Metrics corresponding to resource are listed. After you select the metric, you have the option of drilling down your query by applying filters:

      • If a configuration metric is selected, you can enter a string in the like box. You can also enter a regular expression.
      • If a performance metric is selected, you can apply the conditions like (Any, between, less than, or more than) for (at least, at most, or exactly) samples.

      To query storage system serial number 421358, we will select the Serial No. metric and then enter 421358 in the like box.

    4. To query the total IOPS of LDEVs, you must add the LDEV resource. Drag the Resource icon as follows:

      GUID-8FB613FD-654B-4199-A553-CEF54FF4A8A5-low.png

    5. Select the Hitachi Enterprise Storage resource group and LDEV resource.

      GUID-663D7865-4A1F-47BD-8605-6E8AF8B2DDB0-low.png

    6. Drag the Filter icon and select the Total IOPS filter (apply other filters as required). For creating the sample report, make sure that you have created the query as shown in the following example.

      GUID-473CEDDB-6CEB-4E0E-8FFC-EFCCC81CE0A9-low.png

    7. In Duration, select the length of time to run the query (maximum 7 days).

    8. Click View Result.

      The View Result window opens. See Viewing reports in Report Builder for more details.

      GUID-A3DA036F-ECE9-4C67-ACA2-8E30947B1A65-low.png

      Note
      • An asterisk (*) in the breadcrumb indicates that the query is not yet saved. If you want to make any changes, you can use the breadcrumb to return to Create Using Query Builder window.
      • You can drill down by applying multiple filters for resources as shown in the following example.

        GUID-55F4B593-0397-49B6-BCDE-35D9BFFE5C6E-low.png

      • You can add multiple resources as shown below. A maximum of two resources can be viewed in the report. For example, if three resources are added in a query, then the top 1 resource will be excluded in the report. In the following example, the Storage System resource is excluded and not be shown in the report.

        GUID-B36D3A1A-015A-484D-9194-3167271389EB-low.png

        If you delete any resource from the query, the resource will be enabled in reverse order.

      • You can exclude resources from the report using the GUID-6EC438C2-F0B6-4C29-9CE7-265AB728596D-low.png icon in the Select Resource box.
  5. In the View Result window, click Save Query and enter the query name.

  6. Click Save. The query is saved and listed in the Build window.

Creating a report using MQL

MQL is intended for more complex operations than the Query Builder. This includes operations such as interval rollup and resource rollup. Refer to the Hitachi Ops Center Analyzer Detail View Query Language User Guide for details. You can write a query from the scratch or you can extend the queries of built-in reports.

Procedure

  1. In the Analyzer detail view left pane, select Reports > Build.

    The Build window opens.
  2. Click Create Using MQL.

  3. Enter a query in the Enter MQL box:

    • Writing queries from the scratch: For example, the following query uses the interval rollup operation to aggregate data from a lower interval to a higher interval:
      raidPG[@utilization rx b .*]{intervalRollUpOp=AVG,outputIntervalInSec=3600}

      By default, the collection interval of utilization metric of the RAID PG group is 300 seconds. This example query uses 3600 seconds (outputIntervalInSec) query filter option.

    • Extending queries of built-in performance reports: To extend queries of existing reports, do the following:
      1. Go to resource tree node.
      2. In a chart report area, click the GUID-7DE11E95-F6C1-4B67-97E4-0232E5DA947D-low.png icon and select Options > Show Query and then copy the query.
      3. Go back to Reports > Build.
      4. Paste the query in the Enter MQL box.
      5. Edit the query as required.
  4. In the Duration box, select the length of time to run the query (maximum 7 days).

  5. Click View Result.

    The View Result window opens.
  6. In the View Result window, click Save Query and enter a name.

  7. Click Save. The query is saved and listed in the Build window.

Viewing reports in Report Builder

Based on the query, Report Builder generates configuration and performance reports. If a query contains performance metrics, both performance and configuration reports are generated. If a query contains only configuration metrics, only the configuration report is generated.

At the top of the View Result window, you can choose to view the configuration and performance report. You can also change the report duration.

Viewing a performace report

GUID-2016F604-52D3-4683-A5D8-EF4A8CC32503-low.png

ItemDescription
GUID-4117A1AD-32D1-49EC-8B9C-CDDE1D3B7B3B-low.png

List of primary and related resources: A primary resource is the first resource in your query. If you have queried the LDEV IOPS for a storage system, the storage system is the primary resource and the LDEV is related resource.

In this example, 421358 (storage system) is primary resource and 421358 – 00:00:05 (LDEV) is secondary resource.

Under View, five related resources are listed. You can view other related resources using the GUID-D6966D71-8CD9-44F9-B66E-C69FFCB4872B-low.png or GUID-88368D55-7B7B-4886-BC86-DE7AE5314FFA-low.png icons.
GUID-8F52FBAF-8E6E-471C-B4C1-8438E3E039CD-low.pngChart report: By default, the primary resource metric is displayed on the left axis and the related resource metric is displayed on the right. If a query contains only one resource, a default of ten primary resources are displayed. If a query contains two resources with filters on both resources, 6 resources (1 primary and 5 related resources) are displayed.
GUID-AE7FDFBD-9CCC-4620-8B4F-7974FC1A3691-low.png and GUID-8A4D2C22-BD77-4DCB-AC7A-8529310C6F87-low.pngSee Pinning a resource in chart report for more information.
GUID-7DE11E95-F6C1-4B67-97E4-0232E5DA947D-low.pngChart settings: By default, all the chart reports are plotted in line (plot type) with linear scale. When you click this icon, the Chart Settings window is displayed. You can define the following chart settings:
  • Left and right axis scale:
    • Linear
    • Logarithmic
  • Left and right axis plot type:
    • Area
    • Line
    • Line interpolate
    • Scatter
    • Stack
  • Metrics on left and right axis
GUID-80931710-DAAB-4335-BE97-811C17BB8CDD-low.pngIndicates that the performance data is not available for the resource.
GUID-8BC7705B-9CE4-4642-A2A1-5269E55DF31A-low.pngUse this icon to view the details of an individual resource:
  • Configuration
  • Related resources
  • Configuration changes
  • Relation changes
GUID-2890A72A-51BE-4EC5-9ADB-B655F29CF2D6-low.pngHide or show the chart legends.
GUID-A6033706-1B0D-43E5-9BBE-59414EB171EA-low.pngYou can choose to hide the metrics on chart. Also, when you hover over the metric name, the data collection interval for the metric is displayed.

Pinning a resource in chart report

The pin (GUID-AE7FDFBD-9CCC-4620-8B4F-7974FC1A3691-low.png) icon allows you to create a group of resources that you want to view in one chart report. You can compare the pinned resource with other resources across all the pages.

As shown in the following example, resources 1-5 are listed. If you want to compare the 421358-00:00:09 resource with other resources (for example 6-10) on other pages, you must pin this resource.

GUID-A16F3D2A-A68D-456B-AEE3-DBAE982F54D2-low.png

When you pin a resource, the number of pinned resources is shown as follows:

GUID-A2914D9B-880E-4051-8AA2-C81296250763-low.png

When you view another set of resources, the performance chart of the pinned resource is plotted. In the following example, the pinned resource (421358-00:00:09) is displayed along with resources 6-10. Also, the number of resources is increased to 7 in the chart report (5 related resources + 1 pinned resource + 1 primary resource).

GUID-86071D78-6F5A-4F25-8148-54AE57E0B0BC-low.png

Viewing a configuration report

Click the Configuration tab to view the configuration report for a resource.

GUID-D947730A-EF51-4FBE-84EE-473D1587B1E3-low.png

In this example:

  • The configuration report is displayed for resource VSPG200 along with its serial number 421358 and other details such as name and model name. This is the primary resource. If you want to see more details, click GUID-8BC7705B-9CE4-4642-A2A1-5269E55DF31A-low.png.
  • To view related resources, click the resource (VSPG200 in this example). The list of all related resources is displayed.

Exporting reports

You can export a report by clicking the GUID-3CC6188C-B550-46A4-B50B-D2369D95CC2B-low.png icon in the View Result window to export the report. A zip file is generated containing separate folders for configuration and performance reports. (For reports that include just configuration metrics, only the conf folder is included in the zip file.)

Using a saved query

Saved queries are displayed in the Saved Queries section in Report Builder. You can view, edit, clone, and delete saved queries.

GUID-EC67F6CD-0B5C-4F84-AD35-0228C92B3B12-low.png

Viewing or editing a query

You can view a saved query to see its details, such as resources and filters. You can also edit the saved query to add or remove resources and filters.

Procedure

  1. In the Build window, in Saved Queries section, click GUID-6EC438C2-F0B6-4C29-9CE7-265AB728596D-low.png in the Action column.

    The query details are displayed. You can add, remove, edit, or hide the resources and filters.
  2. If you edited the query, click View Result and then click Save Query.

Cloning a query

Cloning a query is useful to extend existing queries and save as a new query.

NoteYou can clone the queries that are created using the Query Builder option.

Procedure

  1. In the Build window, in Saved Queries section, click GUID-6EC438C2-F0B6-4C29-9CE7-265AB728596D-low.png in the Action column.

    The query details are displayed.
  2. Click Clone Query.

    The Clone Query window opens.
  3. In the Query Name box, enter a new name.

  4. Click Clone.

    The confirmation message is displayed.
  5. Make the desired changes.

  6. Click View Result.

    The View Result window opens.
  7. Click Save Query and then click Save.

Deleting a query

You can delete saved queries.

Procedure

  1. In the Build window, go to the Saved Queries section and click GUID-0F2C386B-C612-4DD7-BBB1-2499C0413FC0-low.png in the Action column.

    A confirmation message is displayed.
  2. Click Delete.

    The query is removed from the Saved Query section.

 

  • Was this article helpful?