-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[Docs] Update Sharing docs #190318
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Update Sharing docs #190318
Changes from 8 commits
18b83ee
5266d52
8c28332
57b1fab
c402b43
295e68c
af11e25
fe09ea5
e985283
4106806
c174a82
d43d686
a5655e4
c8e0570
73e1975
2bfa8c9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,37 +7,38 @@ | |
| :frontmatter-description: {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads with others, or on a website. | ||
| :frontmatter-tags-products: [kibana] | ||
|
|
||
| {kib} provides you with several options to share *Discover* saved searches, dashboards, *Visualize Library* visualizations, and *Canvas* workpads. | ||
| {kib} 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. | ||
|
|
||
| You access the options from the *Share* menu in the toolbar. The sharing options include the following: | ||
| [float] | ||
| [[share-a-direct-link]] | ||
| == Share with a direct link | ||
|
|
||
| * *PDF Reports* — Generate and download PDF files of dashboards, visualizations, and *Canvas* workpads. PDF reports are a link:https://www.elastic.co/subscriptions[subscription feature]. | ||
| 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're getting a temporary link that might break in the future for example in case of upgrade. Save the object to get a permanent link instead. | ||
|
|
||
| * *PNG Reports* — Generate and download PNG files of dashboards and visualizations. PNG reports are a link:https://www.elastic.co/subscriptions[subscription feature]. | ||
| To access the object shared with the link, users need to authenticate. | ||
|
|
||
| * *CSV Reports* — Generate CSV reports of saved searches. <<csv-limitations,Certain limitations apply>>. | ||
| TIP: Anonymous users can also access the link if you have configured <<anonymous-authentication,Anonymous authentication>> and your anonymous service account has privileges to access what you want to share. | ||
|
florent-leborgne marked this conversation as resolved.
Outdated
|
||
|
|
||
| * *CSV Download* — Generate and download CSV files of *Lens* visualizations. | ||
| image::https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt49f2b5a80ec89a34/66b9e919af508f4ac182c194/share-dashboard.gif[getting a shareable link for a dashboard] | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this a temporary image URL?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, it's a link to a gif hosted on our asset service (contentstack). We put gifs there to avoid adding too heavy assets to the repo. |
||
|
|
||
| * *Get links* — Share direct links to saved searches, dashboards, and visualizations. | ||
| [float] | ||
| [[manually-generate-reports]] | ||
| == Export as a file | ||
|
|
||
| * *Download as JSON* — Generate and download JSON files of *Canvas* workpads. | ||
| NOTE: For more information on how to configure reporting in {kib}, refer to <<secure-reporting,Configure reporting in {kib}>> | ||
|
|
||
| * beta[] *Share on a website* — Download and securely share *Canvas* workpads on any website. | ||
| Create and download PDF, PNG, or CSV reports of saved searches, dashboards, visualizations, and workpads. | ||
|
|
||
| * *Embed code* — Embed fully interactive dashboards as an iframe on web pages. | ||
| * *PDF* — Generate and download PDF files of dashboards, visualizations, and *Canvas* workpads. PDF reports are a link:https://www.elastic.co/subscriptions[subscription feature]. | ||
|
|
||
| [[reporting-on-cloud-resource-requirements]] | ||
| NOTE: For Elastic Cloud deployments, {kib} instances require a minimum of 2GB RAM to generate PDF or PNG reports. To | ||
| change {kib} sizing, {ess-console}[edit the deployment]. | ||
| * *PNG* — Generate and download PNG files of dashboards and visualizations. PNG reports are a link:https://www.elastic.co/subscriptions[subscription feature]. | ||
|
|
||
| For more information on how to configure reporting in {kib}, refer to <<secure-reporting,Configure reporting in {kib}>> | ||
| * *CSV Reports* — Generate CSV reports of saved searches. <<csv-limitations,Certain limitations apply>>. | ||
|
|
||
| [float] | ||
| [[manually-generate-reports]] | ||
| == Create reports | ||
| * *CSV Download* — Generate and download CSV files of *Lens* visualizations. | ||
|
|
||
| * *Download as JSON* — Generate and download JSON files of *Canvas* workpads. | ||
|
|
||
| Create and download PDF, PNG, or CSV reports of saved searches, dashboards, visualizations, and workpads. | ||
|
|
||
| [[reporting-layout-sizing]] | ||
| The layout and size of the report depends on what you are sharing. | ||
|
|
@@ -55,17 +56,19 @@ image::user/reporting/images/shareable-container.png["Shareable Container"] | |
|
|
||
| . From the toolbar, click *Share*, then select the report option. | ||
|
|
||
| * If you are creating dashboard PDFs, select *Optimize for printing* to create printer-friendly PDFs with multiple A4 portrait pages and two visualizations per page. | ||
| * 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 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. | ||
|
|
||
| . Generate the report. | ||
| . 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. | ||
|
|
||
| . When the report generates, a message appears. On the message, click **Download report**. | ||
| . A message appears, indicating that the report is in the export queue. | ||
|
|
||
| . To view and manage reports, open the main menu, then click *Stack Management > Reporting*. | ||
| 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 "stateful" 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 | ||
|
|
@@ -83,33 +86,6 @@ include::reporting-csv-limitations.asciidoc[] | |
|
|
||
| include::reporting-pdf-limitations.asciidoc[] | ||
|
|
||
| [float] | ||
| [[share-a-direct-link]] | ||
| == Share direct links | ||
|
|
||
| Create and share direct links to saved searches, dashboards, and visualizations. To access the shared object, authentication is required. | ||
|
|
||
| . Open the main menu, then open the saved search, dashboard, or visualization you want to share. | ||
|
|
||
| . From the toolbar, click *Share*, then select *Get links*. | ||
|
|
||
| . Specify how you want to generate the link: | ||
|
|
||
| * To display only the current state of the object, select *Snapshot*. | ||
|
|
||
| * To display up-to-date changes, select *Saved object*. | ||
|
|
||
| * To generate a shortened link, select *Short URL*. | ||
|
|
||
| * To automatically log in anonymous users when you have multiple authentication providers enabled, select *Public URL*. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/permalink-public-url.png[Permalink share menu with Public URL option highlighted] | ||
| + | ||
| NOTE: *Public URL* is available only when anonymous access is configured and your anonymous service account has privileges to access what you want to share. For more information, refer to <<anonymous-authentication,Anonymous authentication>>. | ||
|
|
||
| . Click *Copy link*. | ||
|
|
||
| [float] | ||
| [[download-as-json]] | ||
| == Create JSON files | ||
|
|
@@ -122,6 +98,18 @@ Create and share JSON files for workpads. | |
|
|
||
| . From the toolbar, click *Share*, then select *Download as JSON*. | ||
|
|
||
| [float] | ||
| == 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. | ||
|
|
||
| [[reporting-on-cloud-resource-requirements]] | ||
| NOTE: For Elastic Cloud deployments, {kib} instances require a minimum of 2GB RAM to generate PDF or PNG reports. To | ||
| change {kib} sizing, {ess-console}[edit the deployment]. | ||
|
|
||
|
|
||
| [float] | ||
| [[add-workpad-website]] | ||
| == Share workpads on a website | ||
|
|
@@ -154,24 +142,15 @@ For information about granting access to embedded dashboards, refer to <<kibana- | |
|
|
||
| . Click *Share > Embed code*. | ||
|
|
||
| . Specify how you want to generate the code: | ||
|
|
||
| * To display the current state, select *Snapshot*. | ||
|
|
||
| * To display up-to-date changes, select *Saved object*. | ||
| . Specify which parts of the dashboard you want to include: Top menu, query, time filter, and filter bar. | ||
|
|
||
| * Select the dashboard components you want to share. | ||
| . Click *Copy embed code*. | ||
|
|
||
| * To generate a shortened link, select *Short URL*. | ||
| //* To automatically log in anonymous users when you have multiple authentication providers enabled, select *Public URL*. | ||
| //+ | ||
| //NOTE: *Public URL* is available only when anonymous access is configured and your anonymous service account has privileges to access what you want to embed. For more information, refer to <<anonymous-authentication,Anonymous authentication>>. | ||
|
florent-leborgne marked this conversation as resolved.
Outdated
|
||
|
|
||
| * To automatically log in anonymous users when you have multiple authentication providers enabled, select *Public URL*. | ||
| + | ||
| [role="screenshot"] | ||
| image::images/embed-code-public-url.png[Embed code share menu with Public URL option highlighted] | ||
| + | ||
| NOTE: *Public URL* is available only when anonymous access is configured and your anonymous service account has privileges to access what you want to embed. For more information, refer to <<anonymous-authentication,Anonymous authentication>>. | ||
|
|
||
| . Click *Copy iFrame code*. | ||
|
|
||
| -- | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.