Reporting

You can generate a report that contains a Kibana dashboard, visualization, saved search, or Canvas workpad. Depending on the object type, you can export the data as a PDF, PNG, or CSV document, which you can keep for yourself, or share with others.

Reporting is available from the Share menu in Discover, Visualize, Dashboard, and Canvas.

Share

Setup

The reporting features are automatically enabled in Kibana. The first time Kibana runs, it extracts a custom build for the Chromium web browser, which runs on the server in headless mode to load Kibana and capture the rendered Kibana charts as images.

Chromium is an open-source project not related to Elastic, but the Chromium binary for Kibana has been custom-built by Elastic to ensure it works with minimal setup. However, the Kibana server OS might still require additional dependencies for Chromium. See the Reporting troubleshooting section for more information about the system dependencies for different operating systems.

Roles and privileges

To generate a report, you must have the reporting_user role. You also need the appropriate Kibana privileges to access the objects that you want to report on and the Elasticsearch indices. See Reporting and security for an example.

Generate a report manually

  1. Open the dashboard, visualization, Canvas workpad, or saved search that you want to include in the report.
  2. In the Kibana toolbar, click Share. If you are working in Canvas, click the share icon Canvas Share button.
  3. Select the option appropriate for your object. You can export:

    • A dashboard or visualization as either a PNG or PDF document
    • A Canvas workpad as a PDF document
    • A saved search as a CSV document
  4. Generate the report.

    A notification appears when the report is complete.

Layout and sizing

The layout and size of the PDF or PNG image depends on the Kibana app with which the Reporting plugin is integrated. For Canvas, the worksheet dimensions determine the size for Reporting. In other apps, the dimensions are taken on the fly by looking at the size of the visualization elements or panels on the page.

The size dimensions are part of the reporting job parameters. Therefore, to make the report output larger or smaller, you can change the size of the browser. This resizes the shareable container before generating the report, so the desired dimensions are passed in the job parameters.

In the following Kibana dashboard, the shareable container is highlighted. The shareable container is captured when you click the Generate or Copy POST URL button. It might take some trial and error before you’re satisfied with the layout and dimensions in the resulting PNG or PDF image.

Shareable Container

Optimize PDF for print—dashboard only

To create a printer-friendly PDF with multiple A4 portrait pages and two visualizations per page, turn on Optimize for printing.

Share

View and manage report history

For a list of your reports, open the menu, then go to Stack Management > Kibana > Reporting. From this view, you can monitor the generation of a report and download reports that you previously generated.

Automatically generate a report

To automatically generate a report from a script or with Watcher, see Automating report generation.