diff --git a/explore-analyze/report-and-share.md b/explore-analyze/report-and-share.md index a2134ab874..a8eef07cc6 100644 --- a/explore-analyze/report-and-share.md +++ b/explore-analyze/report-and-share.md @@ -1,10 +1,9 @@ --- mapped_urls: - https://www.elastic.co/guide/en/kibana/current/reporting-getting-started.html - - https://www.elastic.co/guide/en/kibana/current/secure-reporting.html --- -# Reporting and sharing +# Reporting and sharing [reporting-getting-started] % What needs to be done: Refine @@ -13,8 +12,6 @@ mapped_urls: % Use migrated content from existing pages that map to this page: % - [ ] ./raw-migrated-files/kibana/kibana/reporting-getting-started.md -% - [ ] ./raw-migrated-files/kibana/kibana/secure-reporting.md -% Notes: (as prereqs?) % Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc): @@ -36,4 +33,159 @@ $$$reporting-elasticsearch-configuration$$$ $$$reporting-roles-user-api$$$ -$$$securing-reporting$$$ \ No newline at end of file +$$$securing-reporting$$$ + + +{{kib}} provides you with several options to share **Discover** sessions, dashboards, **Visualize Library** visualizations, and **Canvas** workpads. These sharing options are available from the **Share** menu in the toolbar. + +## Permissions + +To be able to share objects or generate reports, you must have a role that allows these actions on the specific {{es}} indices and {{kib}} applications containing the data that you want to share. Check [Configuring reporting](/deploy-manage/deploy/kibana-reporting-configuration.md) for more information. + +## Share with a direct link [share-a-direct-link] + +You can share direct links to saved Discover sessions, dashboards, and visualizations. When clicking **Share**, look for the **Links** tab to get the shareable link and copy it. + +::::{tip} +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](/deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md#anonymous-authentication) and your anonymous service account has privileges to access what you want to share. + +:::{image} https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt49f2b5a80ec89a34/66b9e919af508f4ac182c194/share-dashboard.gif +:alt: getting a shareable link for a dashboard +::: + + +## Export as a file [manually-generate-reports] + +::::{note} +For more information on how to configure reporting in {{kib}}, refer to [Configure reporting in {{kib}}](/explore-analyze/report-and-share.md) +:::: + + +Create and download PDF, PNG, or CSV reports of saved Discover sessions, dashboards, visualizations, and workpads. + +* **PDF** — Generate and download PDF files of dashboards, visualizations, and **Canvas** workpads. PDF reports are a [subscription feature](https://www.elastic.co/subscriptions). +* **PNG** — Generate and download PNG files of dashboards and visualizations. PNG reports are a [subscription feature](https://www.elastic.co/subscriptions). +* **CSV Reports** — Generate CSV reports of saved Discover sessions. [Certain limitations apply](/explore-analyze/report-and-share.md#csv-limitations). +* **CSV Download** — Generate and download CSV files of **Lens** visualizations. +* **Download as JSON** — Generate and download JSON files of **Canvas** workpads. + +$$$reporting-layout-sizing$$$ +The layout and size of the report depends on what you are sharing. For saved Discover sessions, 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: + +:::{image} ../images/kibana-shareable-container.png +:alt: Shareable Container +:class: screenshot +::: + +1. Open the saved Discover session, 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. + + ::::{note} + When you create a dashboard report that includes a data table or Discover session, 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. + + ::::{note} + 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. + +::::{note} +In self-managed and Cloud hosted deployments, reports are stored in {{es}} and managed by the `kibana-reporting` {{ilm}} ({{ilm-init}}) policy. By default, the policy stores reports forever. To learn more about {{ilm-init}} policies, refer to the {{es}} [{{ilm-init}} documentation](/manage-data/lifecycle/index-lifecycle-management.md). +:::: + + + +### CSV report limitations [csv-limitations] + +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](https://www.elastic.co/guide/en/elasticsearch/reference/current/scroll-api.html), [Point in time API](https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html), [ES|QL](/explore-analyze/query-filter/languages/esql-rest.md) or [SQL](/explore-analyze/query-filter/languages/sql-rest-format.md#_csv) 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 [{{es}} Client documentation](https://www.elastic.co/guide/en/elasticsearch/client/index.html). + +[Reporting parameters](https://www.elastic.co/guide/en/kibana/current/reporting-settings-kb.html) 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 [pdf-limitations] + +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 {{report-features}}, consider installing {{kib}} using [Docker](/deploy-manage/deploy/self-managed/install-with-docker.md) or using [Elastic Cloud](/explore-analyze/overview/kibana-quickstart.md#set-up-on-cloud). + + +## Create JSON files [download-as-json] + +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 {{kib}} [_embed_outside_of_kib] + +* [beta] **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. + +::::{note} +:name: reporting-on-cloud-resource-requirements + +For Elastic Cloud hosted deployments, {{kib}} instances require a minimum of 2GB RAM to generate PDF or PNG reports. To change {{kib}} sizing, [edit the deployment](https://cloud.elastic.co?page=docs&placement=docs-body). +:::: + + + +## Share workpads on a website [add-workpad-website] + +[beta] 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 {{kib}}. **Canvas** does not display elements that manipulate the data on the workpad. + + ::::{note} + 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 [embed-code] + +Display your dashboards on an internal company website or personal web page with an iframe. To embed other {{kib}} objects, manually create the HTML code. + +For information about granting access to embedded dashboards, refer to [Authentication](/deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md). + +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**. diff --git a/raw-migrated-files/kibana/kibana/reporting-getting-started.md b/raw-migrated-files/kibana/kibana/reporting-getting-started.md deleted file mode 100644 index ad05e61a18..0000000000 --- a/raw-migrated-files/kibana/kibana/reporting-getting-started.md +++ /dev/null @@ -1,152 +0,0 @@ -# Reporting and sharing [reporting-getting-started] - -{{kib}} provides you with several options to share **Discover** sessions, dashboards, **Visualize Library** visualizations, and **Canvas** workpads. These sharing options are available from the **Share** menu in the toolbar. - - -## Share with a direct link [share-a-direct-link] - -You can share direct links to saved Discover sessions, dashboards, and visualizations. When clicking **Share***, look for the ***Links** tab to get the shareable link and copy it. - -::::{tip} -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](../../../deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md#anonymous-authentication) and your anonymous service account has privileges to access what you want to share. - -:::{image} https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt49f2b5a80ec89a34/66b9e919af508f4ac182c194/share-dashboard.gif -:alt: getting a shareable link for a dashboard -::: - - -## Export as a file [manually-generate-reports] - -::::{note} -For more information on how to configure reporting in {{kib}}, refer to [Configure reporting in {{kib}}](../../../explore-analyze/report-and-share.md) -:::: - - -Create and download PDF, PNG, or CSV reports of saved Discover sessions, dashboards, visualizations, and workpads. - -* **PDF** — Generate and download PDF files of dashboards, visualizations, and **Canvas** workpads. PDF reports are a [subscription feature](https://www.elastic.co/subscriptions). -* **PNG** — Generate and download PNG files of dashboards and visualizations. PNG reports are a [subscription feature](https://www.elastic.co/subscriptions). -* **CSV Reports** — Generate CSV reports of saved Discover sessions. [Certain limitations apply](../../../explore-analyze/report-and-share.md#csv-limitations). -* **CSV Download** — Generate and download CSV files of **Lens** visualizations. -* **Download as JSON** — Generate and download JSON files of **Canvas** workpads. - -$$$reporting-layout-sizing$$$ -The layout and size of the report depends on what you are sharing. For saved Discover sessions, 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: - -:::{image} ../../../images/kibana-shareable-container.png -:alt: Shareable Container -:class: screenshot -::: - -1. Open the saved Discover session, 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. - - ::::{note} - When you create a dashboard report that includes a data table or Discover session, 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. - - ::::{note} - 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. - -::::{note} -In self-managed and Cloud hosted deployments, reports are stored in {{es}} and managed by the `kibana-reporting` {{ilm}} ({{ilm-init}}) policy. By default, the policy stores reports forever. To learn more about {{ilm-init}} policies, refer to the {{es}} [{{ilm-init}} documentation](../../../manage-data/lifecycle/index-lifecycle-management.md). -:::: - - - -### CSV report limitations [csv-limitations] - -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](https://www.elastic.co/guide/en/elasticsearch/reference/current/scroll-api.html), [Point in time API](https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html), [ES|QL](../../../explore-analyze/query-filter/languages/esql-rest.md) or [SQL](../../../explore-analyze/query-filter/languages/sql-rest-format.md#_csv) 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 [{{es}} Client documentation](https://www.elastic.co/guide/en/elasticsearch/client/index.html). - -[Reporting parameters](https://www.elastic.co/guide/en/kibana/current/reporting-settings-kb.html) 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 [pdf-limitations] - -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 {{report-features}}, consider installing {{kib}} using [Docker](../../../deploy-manage/deploy/self-managed/install-with-docker.md) or using [Elastic Cloud](../../../explore-analyze/overview/kibana-quickstart.md#set-up-on-cloud). - - -## Create JSON files [download-as-json] - -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 {{kib}} [_embed_outside_of_kib] - -* [beta] **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. - -::::{note} -:name: reporting-on-cloud-resource-requirements - -For Elastic Cloud hosted deployments, {{kib}} instances require a minimum of 2GB RAM to generate PDF or PNG reports. To change {{kib}} sizing, [edit the deployment](https://cloud.elastic.co?page=docs&placement=docs-body). -:::: - - - -## Share workpads on a website [add-workpad-website] - -[beta] 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 {{kib}}. **Canvas** does not display elements that manipulate the data on the workpad. - - ::::{note} - 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 [embed-code] - -Display your dashboards on an internal company website or personal web page with an iframe. To embed other {{kib}} objects, manually create the HTML code. - -For information about granting access to embedded dashboards, refer to [Authentication](../../../deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md). - -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**. diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index b343862d64..d54db348e8 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -663,7 +663,6 @@ toc: - file: kibana/kibana/logging-settings.md - file: kibana/kibana/management.md - file: kibana/kibana/osquery.md - - file: kibana/kibana/reporting-getting-started.md - file: kibana/kibana/reporting-production-considerations.md - file: kibana/kibana/role-mappings.md - file: kibana/kibana/sample-data.md