Skip to content

[ResponseOps][Reporting][9.1 & Serverless] Scheduled Exports External Docs #2118

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions explore-analyze/report-and-share.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,32 +83,32 @@ In the following dashboard, the shareable container is highlighted:
:::

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.
2. Choose a file type for the report.

* If you are creating dashboard PDFs, select **For printing** to create printer-friendly PDFs with multiple A4 portrait pages and two visualizations per page.
* {applies_to}`stack: ga 9.0` From the toolbar, click **Share** > **Export** tab, then choose a file type. Note that when you create a dashboard report that includes a data table or Discover session, the PDF includes only the visible data.
* {applies_to}`stack: ga 9.1` From the toolbar, click the **Export** icon, then choose a file type.

::::{note}
When you create a dashboard report that includes a data table or Discover session, the PDF includes only the visible data.
::::
::::{tip}

* If you are creating workpad PDFs, select **Full page layout** to create PDFs without margins that surround the workpad.
Tips for generating PDF reports:

3. Generate the report by clicking **Export file**, **Generate CSV**, or **Generate PDF**, depending on the object you want to export.
* If you are creating dashboard PDFs, select **For printing** to create printer-friendly with multiple A4 portrait pages and two visualizations per page.
* {applies_to}`stack: ga 9.0` If you are creating workpad PDFs, select **Full page layout** to create PDFs without margins that surround the workpad.

::::

::::{note}
You can use the **Copy POST URL** option instead to generate the report from outside Kibana or from Watcher.
::::
3. Click the button that generates or exports the report. A message appears, indicating that the report is in the export queue.

4. A message appears, indicating that the report is in the export queue.
::::{note}
To generate the report from outside of {{kib}} or from {{watcher}}, use the POST URL, then submit an HTTP `POST` request using a script or {{watcher}}. In {{stack}} 9.1, you can schedule a recurring task in {{kib}} that generates reports on a repeating basis. Refer to [Automatically generate reports](report-and-share/automating-report-generation.md) to learn more.
::::

You can then download it from that message, or go to the **Stack Management > Reporting** page to view and access all of your reports.
Go to the **Reporting** page to access all of your reports. To find the page, navigate to **Stack Management > Alerts and Insights > Reporting** in the main menu, or use the [global search field](find-and-organize/find-apps-and-objects.md).

::::{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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,34 @@ products:

# Automatically generate reports [automating-report-generation]

To automatically generate PDF and CSV reports, generate a POST URL, then submit the HTTP `POST` request using {{watcher}} or a script.
To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {{watcher}} or a script. In {{stack}} 9.1, you schedule a recurring task in {{kib}} that generates PDF and PNG reports on a repeating basis. With email notifications configured, you can also automatically share your reports outside of {{kib}}.


## Create a POST URL [create-a-post-url]

Create the POST URL that triggers a report to generate PDF and CSV reports.

### PDF reports

To create the POST URL for PDF reports:

1. Go to **Dashboards**, **Visualize Library**, or **Canvas**.
2. Open the dashboard, visualization, or **Canvas** workpad you want to view as a report.
2. Open the dashboard, visualization, or **Canvas** workpad you want to view as a report. From the toolbar, do one of the following:

* If you are using **Dashboard** or **Visualize Library**, from the toolbar, click **Share > Export**, select the PDF option then click **Copy POST URL**.
* If you are using **Canvas**, from the toolbar, click **Share > PDF Reports**, then click **Advanced options > Copy POST URL**.
* {applies_to}`stack: ga 9.0` If you are using **Dashboard** or **Visualize Library**, click **Share > Export**, select the PDF option then click **Copy POST URL**.
* {applies_to}`stack: ga 9.0` If you are using **Canvas**, click **Share > PDF Reports**, then click **Advanced options > Copy POST URL**.
* {applies_to}`stack: ga 9.0` Click the **Export** icon, then **PDF**. In the export flyout, copy the POST URL.

### CSV reports

To create the POST URL for CSV reports:

1. Go to **Discover**.
2. Open the saved Discover session you want to share.
3. In the toolbar, click **Share > Export > Copy POST URL**.
3. In the toolbar, do one of the following:

* {applies_to}`stack: ga 9.0` Click **Share > Export > Copy POST URL**.
* {applies_to}`stack: ga 9.1` Click the **Export** icon, then **CSV**. In the export flyout, copy the POST URL.


## Use Watcher [use-watcher]
Expand Down Expand Up @@ -159,3 +166,35 @@ If you experience issues with the deprecated report URLs after you upgrade {{kib
:::{important}
In earlier {{kib}} versions, you could use the `&sync` parameter to append to report URLs that held the request open until the document was fully generated. The `&sync` parameter is now unsupported. If you use the `&sync` parameter in Watcher, you must update the parameter.
:::

## Schedule reports in {{kib}} [schedule-report-generation]

```{applies_to}
stack: preview 9.1
```

% In the tip, need to add info for configuring email notifications in Serverless, Cloud, and self-hosted. Also following up on the sub-steps under step 4.

Save time by creating a recurring {{kib}} task that takes a snapshot of your Discover session, dashboard, or visualization and generates a PDF or PNG report on your chosen schedule. With email notifications configured, you can also automatically share reports outside of {{kib}}.

::::{tip}
To configure email notifications...
::::

1. Open the saved Discover session, dashboard, or visualization you want to share.
2. Click the **Export** icon, then **Schedule export**.
3. Enter the requested details, and (optional) enable **Print format** to generate the report in a printer-friendly format.
4. Set a schedule for generating the report.

* **Date**: Choose when you want {{kib}} to start generating the report.
* **Timezone**: Choose the timezone of your data.
* **Repeat**: Specify when and how often you want to {{kib}} to generate the report.

5. (Optional) Enable **Send by email** to specify a list of email addresses to share the report with. When {{kib}} generates the report, it will attach it to an email and send it on the schedule that you specified. The email will also include a link to download the report.
6. Click **Schedule exports** to save the schedule.

A message appears, indicating that the schedule is available on the **Reporting** page. From the **Reporting** page, click on the **Schedules** tab to view details for the newly-created schedule, find other existing schedules, and more.

::::{important}
If you disable a schedule, _you cannot re-enable it_. If you want to continue generating reports, you must create a new schedule.
::::
Loading