Creating Custom Reports

Provides information on creating custom reports.

Leave Feedback

Introduction

Using Custom Reports, you can:

  • Design spreadsheet-style reports for Inventory, Metrics, Alerts, and Cloud Cost.
  • Schedule reports at a specific time.
  • Share reports with others in the organization.
  • Organize reports easily within a folder.
  • Provide various graphical representations of the data.

Before you begin

Before you create a custom report, create a folder. You can store and organize your custom reports in a folder.

Step 1: Create a folder

To create a folder:

  1. From the left pane of Reports, click Custom > Created by me.
  2. Click +.
  3. Click Add Folder.
    Create New Folder screen appears.
  4. From Create New Folder, provide the desired name for the folder in the Name field and click Submit.
    A new folder is created under Created by me section.

After creating a folder, you can manage the folder by using the edit and delete options.

Step 2: Setup your rules

When creating a custom report, the folder and report type must be specifed.

Prerequisite: Create a folder to store the reports before creating a custom report.

To select the folder and resource type:

  1. Go to Reports > Custom, select a folder to store the reports.
  2. Click NEW. Custom Rules page is displayed.
  3. From the Custom Rules page, provide the following:
    • Name: (Required) Refers to a unique name for the current report.
    • Shared: Select the check-box if you want to share the folder information with other users.
    • Folder: (Required) Refers to the folder to store the report.
    • Report Type: Refers to the following schedule options to generate the report.
      • On Demand Only: A report is generated when you want.
      • On Demand and on Recurring Schedule:** OpsRamp generates a report immediately when you want and also according to the time schedule you define.
    • If you have selected On Demand and on Recurring Schedule, provide details for the following parameters:
      • Starts At (in Hours and Minutes):** Refers to the time in hours and minutes to schedule and generate the reports.
      • Repeats: Refers to one of the following three options to schedule recurring generation of reports:
        • Daily: Refers to generate a report after 24 hours.
        • Weekly – Refers to generate a report every week.
        • Monthly – Refers to generate a report once after a month.

Creating inventory reports

The inventory report displays the resource details (resource name, resource type, and so on) for any selected client.

After selecting the Folder and Report Type, provide details for the following parameters and click Save & Run.

  1. Go to Reports > Custom, select a folder to store the reports.
    Notes:
    • You can segregate the data for each type of report into sections in a single report.
    • Click + to add more sections.
  2. Click NEW, provide folder and report type.
  3. In the Sections area, provide details for the following parameters:
    • Name: (Required) Refers to the section name of the current report.
    • Report On: Select Inventory from the drop-down menu.
    • From the options in the drop-down menu, select a display format (list or break down).
      • List:  Refers to the details displayed in a spreadsheet as a list.
      • Break Down: Refers to the details displayed in a spreadsheet as a graphical format.
        Now, enter details for Filter Criteria.
        Note: You can filter the data displayed for each section in the report corresponding to the clients and devices in the Filter Criteria.
  4. From the Filter Criteria, provide details for the following parameters:
    1. For Clients (Required), click Add/Edit. Select Clients screen appears.
    2. From Select Clients, select the desired number of clients from the Available Clients section. The Assigned Clients section displays the selected clients.
    3. Click Submit. Assigned Clients appear in the Clients section.
    4. From the options in the Filters drop-down menu, select the filters.
      • Click  + to add more filters.
      • Click to remove filters. Now, you need to select a format.
        Note: You can select the format to display the contents in the report, corresponding to the data selected in Select Format.
  5. From the Select Format, provide details for the following step:
    1. If you have selected List as an option to view, from the Available section, select the available device properties.
      For example, if you select Web Services Type as attribute, then in generated report, when the Resource Type column displays Web Services, then the Web Services Type column displays the related Synthetic resource types (such as HTTP, URL, DNS, Eaiml, Imap, Ipop).
    2. If you have selected Break Down as an option to view, perform the following steps:
      • From the options in the Breakdown Column drop-down menu, select the desired device properties for a device.
      • From the Visualization section, select the graph to display the attributes selected in the Breakdown Column, in a report.
        Note: You can choose one of the following visualizations available for Inventory custom report:
        • Bar Chart with Table
        • Column Chart with Table
        • Table Only
        • Pie Chart with Table
Inventory Report

Inventory Report

Creating metrics reports

The metrics report displays the available and applied metrics for any device depending on the resource name and device type. At the same time, you can view the recent data posted by a device for a particular metric.

After selecting the Folder and Report Type, provide details for the following parameters and click Save & Run.

  1. Go to Reports > Custom, select a folder to store the reports.
    Notes:
    • You can segregate the data for each type of report into sections in a single report.
    • Click + to add more sections.
  2. Click NEW, provide folder and report type and in the Sections area, provide the following:
    • Name: (Required) Refers to the section name of the current report.
    • Report On: Select Metric from the drop-down menu.
    • From the options in the drop-down menu, select one of the desired options:
      • Metric Values only:  Displays details in a spreadsheet as a list.
      • Graphical report with metric values: Displays details in a spreadsheet as a graphical format.
  3. After providing the details in the Sections, navigate to Filter Criteria.

    Notes:
    •  You can filter the data displayed for each section of the report corresponding to the clients and resource types in Filter Criteria.
    • The options displayed in Filter Criteria varies with respect to the option selected to display the details in the spreadsheet.
  4. From Filter Criteria, provide details for the following parameters:
    1. From the options in Clients drop-down menu, select the desired client.
    2. From the options displayed, select one of the following options:
      • By Resources
      • By Filters
    3. If you have selected By Resources, provide details for the following parameters:
      1. From the options in the Resource Type drop-down menu, select one of the following options:
        • Device Type: Refers to the available device types.
        • Resource Groups: Refers to the list of available resource groups.
        • Site: Refers to the list of devices configured in the Site section.
      2. From the Devices section, select Available Resources.
    4. If you have selected By Filters, provide the filter details.
      Notes:
      • Click + to add more filters.
      • Click to remove filters.
  5. After providing the details in the Filter Criteria, navigate to Select Format.
  6. From Select Format, select LineSeries Chart with Table in Visualization.
  7. After providing details in Select Format, navigate to Select Metrics.
  8. From Select Metrics, provide details for the following parameters:
    Notes:
    • If you have selected Metric Values only, you can select up to five Template, Monitor and Metric values.
    • If you have selected Graphical Report with metric values, you can select only one Template, one Monitor and one Metric.
    1. From the options in the Report On the drop-down menu, select one of the following options:
      • Monitoring Templates
      • Monitors
      • Web Services
    2. If you have selected Monitoring Templates, provide details for the following parameters:
      • Templates: Displays the list of templates corresponding to the selected client.
      • Monitors: Displays the list of monitors corresponding to the selected Templates.
      • Metrics: Displays the metrics corresponding to the selected monitors.
    3. If you have selected Monitors, provide details for the following parameters:
      • Monitors: Displays the list of monitors applied on the devices.
      • Metrics: Displays the metrics corresponding to the selected monitors.
    4. If you have selected Web Services, provide details for the following parameters:
      • Monitors: Displays the list of monitors applied to web services.
      • Metrics: Displays the metrics corresponding to the selected web service monitors.
  9. After selecting the attributes in Select Metrics, navigate to Select Duration.
  10. From Select Duration, select one of the desired options:
    1. Last Days – Enter a value between 1 and 180. You can generate a report according to the value mentioned in the Last Days.
    2. From and To – You can generate a report within a time frame after specifying the From and To date and time.
Metrics Report

Metrics Report

Creating alerts reports

The alerts report displays the details regarding the alerts generated in the application.

After selecting the Folder and Report Type, provide details for the following parameters and click Save & Run.

  1. Go to Reports > Custom, select a folder to store the reports.
    Notes:
    • You can segregate the data for each type of report into sections in a single report.
    • Click + to add more sections.
  2. Click NEW, provide folder and report type and in the Sections area, provide the following:
    • Name: (Required) Refers to the section name of the current report.
    • Report On: Select Alerts from the drop-down menu.
    • From the options in the drop-down menu, select one of the desired options:
      • Alerts List:  Refers to the lists all the details in an excel sheet.
      • Alerts Breakdown: Refers to the data displayed in a graphical format in an excel sheet. Note: You can determine the display format using the List and Break Down options.
  3. After providing the details in the Sections, navigate to Filter Criteria.

    Note: You can filter the data displayed for each section in the report corresponding to the clients, alerts, and devices in the Filter Criteria.
  4. From the Filter Criteria, provide details for the following parameters:
    1. For Clients (Required), click Add/Edit. Select Clients screen appears.
    2. From Select Clients screen, select desired clients from Available Clients section.
    3. Click Submit.
    4. From the options in Filters drop-down menu, select the filters.
      • Click + to add more filters.
      • Click to remove filters.
  5. After providing the details in the Filter Criteria, navigate to Select Format.

    Note: You can select the display format for the contents in the report corresponding to the data selected in Select Format.
  6. From Select Format, provide details for the following parameters:
    1. If you have selected Alerts List as an option to view, perform the following step:
      From the Available section, select the available alert properties. Selected attributes appear in the Selected section.
    2. If you have selected Alerts Breakdown as an option to view, perform the following step:
      From the options in the Breakdown Column drop-down menu, select the desired device properties for a device.
  7. After selecting attributes in Select Format, navigate to Select Duration.
  8. From Select Duration, select one of the desired options:
    • Last Days: Enter a value between 1 and 180. You can generate a report according to the value mentioned in the Last Days.
    • From and To: You can generate a report within a time frame after specifying the From and To date and time.
  9. From the Visualization section, select the graph to display the attributes selected in the Breakdown Column, in a report.

    Note: You can choose one of the following visualizations available for Alerts custom report:
    • Bar Chart with Table
    • Column Chart with Table
    • Table Only
    • Pie Chart with Table
Alerts Report

Alerts Report

Creating cloud cost reports

The Cloud cost report displays the details of the cost incurred for your usage of each cloud device and the trend of the cloud cost incurred.

After selecting the Folder and Report Type, provide details for the following parameters and click Save & Run.

  1. Go to Reports > Custom, select a folder to store the reports.
    Notes:
    • You can segregate the data for each type of report into sections in a single report.
    • Click + to add more sections.
  2. Click NEW, provide folder and report type and in the Sections area, provide the following:
    • Name: (Required) Enter the section name of the current report.
    • Report On: Select Cloud Cost from the drop-down menu.
    • From the options in the drop-down menu, select a cloud cost option.
      Note: Cloud Cost Insights and Cloud Cost Trend allow you to choose the time frame within which you want to display the contents in the report.
      • Cloud Cost Insights:  Lists all the details in an excel sheet.
      • Cloud Cost Trend: Displays data in a graphical format in an excel sheet.
  3. After providing the details in the Sections, navigate to Filter Criteria.

    Note: You can filter the data displayed for each section in the report corresponding to the Provider Type like Google, Azure, and AWS or Cloud Account.
  4. From the Filter Criteria, provide details for the following parameters:
    • From the options in the Clients (Required) drop-down menu, select the desired client.
    • From the options in the Filters drop-down menu, select the filters.
  5. After selecting the Filter Criteria, navigate to Select Format.

    Note: You can select the display format for the contents in the report, corresponding to the data selected in Filter Criteria and Select Format. From the Select Format, provide details for the Breakdown Column. Select the desired device properties for a device.
  6. If you have selected Cloud Cost Insights as an option to view, perform the following step: From the options in Custom Duration drop-down, select the desired time frame.
  7. If you have selected Cloud Cost Trend as an option to view, perform the following step:
    1. From the options in the View Type drop-down menu in View By section, select one of the following options.
      • Daily – View reports on a daily basis.
      • Monthly – View reports on a monthly basis.
      • Yearly – View reports on a yearly basis.
    2. From the options in the Duration menu, select one of the following options:
      • 7D – Displays details for the past seven days to date.
      • 14D – Displays details for the past 14 days to date.
  8. From the Visualization section, select the type of design to display the attributes selected in the Breakdown Column, in a report.

    Note: You can choose one of the following visualizations available for Cloud Cost custom report:
    • Bar Chart with Table
    • Column Chart with Table
Cloud Cost Report

Cloud Cost Report