Reporting using OpenSearch Dashboards

You can use OpenSearch Dashboards to create PNG, PDF, and CSV reports. To create reports, you must have the correct permissions. For a summary of the predefined roles and the permissions they grant, see the Security plugin.

Reporting uses two concepts:

• A report definition is a saved configuration that specifies which dashboard, visualization, or saved search to capture, the file format (PDF, PNG, or CSV), the time range, and an optional schedule. You can reuse a report definition to generate reports on demand or on a recurring schedule.
• A report is the generated output file (PDF, PNG, or CSV) produced from a report definition or a one-time download.

CSV reports have a non-configurable 10,000-row limit in OpenSearch version 2.16 and earlier. As of version 2.17, this limit can be configured when setting up a report. While reports have no explicit size limit (for example, MB), extremely large documents could cause report generation to fail with an out-of-memory error from the V8 JavaScript engine.

Generating reports

To generate a report from the interface:

1. From the navigation panel, choose Reporting.
2. For dashboards, visualizations, or notebooks, choose Download PDF or Download PNG. If you’re creating a report from the Discover page, choose Generate CSV.

Reports generate asynchronously in the background and might take a few minutes, depending on the size of the report. A notification appears when your report is ready to download.

1. To create a schedule-based report, choose Create report definition. Then proceed to Create reports using a definition. This option pre-fills many of the fields for you based on the visualization, dashboard, or data you were viewing.

Creating reports using a definition

Definitions let you generate reports on a periodic schedule.

1. From the navigation panel, choose Reporting.
2. Choose Create.
3. Under Report settings, enter a name and optional description for your report.
4. Choose the Report source (i.e. the page from which the report is generated). You can generate reports from the Dashboard, Visualize, Discover (saved search), or Notebooks pages.
5. Select your dashboard, visualization, saved search, or notebook. Then choose a time range for the report.
6. Choose an appropriate file format for the report.
7. (Optional) Add a header or footer to the report. Headers and footers are only available for dashboard, visualization, and notebook reports.

8. Under Report trigger, choose either On demand or Schedule.

   For scheduled reports, select either Recurring or Cron based. You can receive reports daily or at some other time interval, and Cron expressions give you more flexibility. See Cron expression reference for more information.

9. Choose Create.

Deleting report definitions

You can delete report definitions from OpenSearch Dashboards or by using the API. Deleting a report definition does not delete previously generated reports.

Generated reports cannot be deleted individually.

Deleting from OpenSearch Dashboards

To delete a report definition, follow these steps:

1. From the navigation panel, choose Reporting.
2. In the Report definitions section, select the name of the report definition you want to delete.
3. On the report definition details page, choose Delete.
4. In the confirmation dialog, choose Delete.

Deleting using the API

To delete a report definition, send the following request:

DELETE _plugins/_reports/definition/{report_definition_id}

To find the report definition ID, list all definitions:

GET _plugins/_reports/definitions

Troubleshooting

You can use the following topics to troubleshoot and resolve issues with reporting.

Chromium fails to launch with OpenSearch Dashboards

While creating a report for dashboards or visualizations, you might see a the following error:

This problem can occur for two reasons:

• You don’t have the correct version of headless-chrome to match the operating system on which OpenSearch Dashboards is running. Download the correct version.

• You’re missing additional dependencies. Install the required dependencies for your operating system from the additional libraries section.

Characters not loading in reports

You might encounter an issue where UTF-8 encoded characters look fine in your browser, but they don’t load in your generated reports because you’re missing the required font dependencies. Install the font dependencies, and then generate your reports again.