« Troubleshoot Maps Automatically generate reports »
Elastic Docs ›Kibana Guide [8.16]

Reporting and sharing

edit

Reporting and sharing

edit

Kibana provides you with several options to share Discover saved searches, dashboards, Visualize Library visualizations, and Canvas workpads. These sharing options are available from the Share menu in the toolbar.

Share with a direct link

edit

You can share direct links to saved searches, dashboards, and visualizations. When clicking Share, look for the Links tab to get the shareable link and copy it.

When sharing an object with unsaved changes, you get a temporary link that might break in the future, for example in case of upgrade. Save the object to get a permanent link instead.

To access the object shared with the link, users need to authenticate.

Anonymous users can also access the link if you have configured Anonymous authentication and your anonymous service account has privileges to access what you want to share.

getting a shareable link for a dashboard

Export as a file

edit

For more information on how to configure reporting in Kibana, refer to Configure reporting in Kibana

Create and download PDF, PNG, or CSV reports of saved searches, dashboards, visualizations, and workpads.

  • PDF — Generate and download PDF files of dashboards, visualizations, and Canvas workpads. PDF reports are a subscription feature.
  • PNG — Generate and download PNG files of dashboards and visualizations. PNG reports are a subscription feature.
  • CSV Reports — Generate CSV reports of saved searches. Certain limitations apply.
  • CSV Download — Generate and download CSV files of Lens visualizations.
  • Download as JSON — Generate and download JSON files of Canvas workpads.

The layout and size of the report depends on what you are sharing. For saved searches, dashboards, and visualizations, the layout depends on the size of the panels. For workpads, the layout depends on the size of the worksheet dimensions.

To change the output size, change the size of the browser, which resizes the shareable container before the report generates. It might take some trial and error before you’re satisfied.

In the following dashboard, the shareable container is highlighted:

Shareable Container
  1. Open the saved search, dashboard, visualization, or workpad you want to share.

  2. From the toolbar, click Share, then select the report option.

    • If you are creating dashboard PDFs, select For printing to create printer-friendly PDFs with multiple A4 portrait pages and two visualizations per page.

      When you create a dashboard report that includes a data table or saved search, the PDF includes only the visible data.

    • If you are creating workpad PDFs, select Full page layout to create PDFs without margins that surround the workpad.

  3. Generate the report by clicking Export file, Generate CSV, or Generate PDF, depending on the object you want to export.

    You can use the Copy POST URL option instead to generate the report from outside Kibana or from Watcher.

  4. A message appears, indicating that the report is in the export queue.

You can then download it from that message, or go to the Stack Management > Reporting page to view and access all of your reports.

In "stateful" deployments, reports are stored in Elasticsearch and managed by the kibana-reporting index lifecycle management (ILM) policy. By default, the policy stores reports forever. To learn more about ILM policies, refer to the Elasticsearch ILM documentation.

CSV report limitations

edit

We recommend using CSV reports to export moderate amounts of data only. The feature enables analysis of data in external tools, but it is not intended for bulk export or to backup Elasticsearch data. Report timeout and incomplete data issues are likely if you are exporting data where:

  • More than 250 MB of data is being exported
  • Data is stored on slow storage tiers
  • Any shard needed for the search is unavailable
  • Network latency between nodes is high
  • Cross-cluster search is used
  • ES|QL is used and result row count exceeds the limits of ES|QL queries

To work around the limitations, use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs.

For more information on using Elasticsearch APIs directly, see Scroll API, Point in time API, ES|QL or SQL with CSV response data format. We recommend that you use an official Elastic language client: details for each programming language library that Elastic provides are in the Elasticsearch Client documentation.

Reporting parameters can be adjusted to overcome some of these limiting scenarios. Results are dependent on data size, availability, and latency factors and are not guaranteed.

PNG/PDF report limitations

edit

We recommend using PNG/PDF reports to export moderate amounts of data only. The feature enables a high-level export capability, but it’s not intended for bulk export. If you need to export several pages of image data, consider using multiple report jobs to export a small number of pages at a time. If the screenshot of exported dashboard contains a large number of pixels, consider splitting the large dashboard into smaller artifacts to use less memory and CPU resources.

For the most reliable configuration of PDF/PNG reporting features, consider installing Kibana using Docker or using Elastic Cloud.

Create JSON files

edit

Create and share JSON files for workpads.

  1. Go to Canvas.
  2. Open the workpad you want to share.
  3. From the toolbar, click Share, then select Download as JSON.

Embed outside of Kibana

edit
  • [beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. Share on a website — Download and securely share Canvas workpads on any website.
  • Embed code — Embed fully interactive dashboards as an iframe on web pages.

For Elastic Cloud deployments, Kibana instances require a minimum of 2GB RAM to generate PDF or PNG reports. To change Kibana sizing, edit the deployment.

Share workpads on a website

edit

[beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. Create and securely share static Canvas workpads on a website. To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.

  1. Go to Canvas.
  2. Open the workpad you want to share.
  3. Click Share > Share on a website.

  4. To customize the workpad behavior to autoplay the pages or hide the toolbar, use the inline parameters.

    To make sure that your data remains secure, the data in the JSON file is not connected to Kibana. Canvas does not display elements that manipulate the data on the workpad.

    Shareable workpads encode the current state of the workpad in a JSON file. When you make changes to the workpad, the changes do not appear in the shareable workpad on your website.

  5. To change the settings, click the settings icon, then choose the settings you want to use.

Embed code

edit

Display your dashboards on an internal company website or personal web page with an iframe. To embed other Kibana objects, manually create the HTML code.

For information about granting access to embedded dashboards, refer to Authentication.

  1. Open the dashboard you want to share.
  2. Click Share > Embed code.
  3. Specify which parts of the dashboard you want to include: Top menu, query, time filter, and filter bar.
  4. Click Copy embed code.
« Troubleshoot Maps Automatically generate reports »