From 42adace750e61178003f2127bf195020bfebab1b Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Sat, 12 Jul 2025 19:36:49 -0400 Subject: [PATCH 01/27] First draft --- explore-analyze/report-and-share.md | 28 +++++------ .../automating-report-generation.md | 49 +++++++++++++++++-- 2 files changed, 58 insertions(+), 19 deletions(-) diff --git a/explore-analyze/report-and-share.md b/explore-analyze/report-and-share.md index c2001de024..f784633834 100644 --- a/explore-analyze/report-and-share.md +++ b/explore-analyze/report-and-share.md @@ -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](explore-analyze/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](explore-analyze/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: diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index a156cb35c5..12b658c425 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -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] @@ -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. +:::: \ No newline at end of file From 238132af969d3cd7929b288b7267c3308623dffc Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Sat, 12 Jul 2025 19:58:34 -0400 Subject: [PATCH 02/27] Fix links --- explore-analyze/report-and-share.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/explore-analyze/report-and-share.md b/explore-analyze/report-and-share.md index f784633834..0c5f810506 100644 --- a/explore-analyze/report-and-share.md +++ b/explore-analyze/report-and-share.md @@ -100,10 +100,10 @@ In the following dashboard, the shareable container is highlighted: 3. Click the button that generates or exports the report. 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](explore-analyze/report-and-share/automating-report-generation.md) to learn more. + 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. :::: -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](explore-analyze/find-and-organize/find-apps-and-objects.md). +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). From c52ef2621a457c0e2a0c9ef1c3b92c6f5e53883e Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 11:24:10 -0400 Subject: [PATCH 03/27] Adds pre-reqs --- .../automating-report-generation.md | 58 +++++++++++++------ 1 file changed, 41 insertions(+), 17 deletions(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 12b658c425..d1f1810dc5 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -10,8 +10,7 @@ products: # Automatically generate reports [automating-report-generation] -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}}. - +To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {{watcher}} or a script. In 9.1.0 and Serverless, you can use {{kiba}} to generate reports on a recurring schedule and share them outside of {{kib}} with a list of emails that you specify. ## Create a POST URL [create-a-post-url] @@ -167,34 +166,59 @@ If you experience issues with the deprecated report URLs after you upgrade {{kib 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] +## Schedule and share reports [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... -:::: +Save time by setting up a recurring task that automatically generates reports and shares them on a schedule that you choose. + +### Requirements [scheduled-reports-reqs] + +* To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access) +* (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. +* Sharing reports outside of {{kib}} requires a default preconfigured email connector. + + * **{{ech}} or {{serverless-short}} users**: You do not need to set up a default preconfigured email connector. Kibana provides you with a preconfigured email connector that uses the SMTP protocol to send mail messages. To view it, go to the **Connectors** page and find the Elastic-Cloud-SMTP connector. + * **Self-managed users**: You must set up a default preconfigured email connector by defining it in your `kibana.yml` file. To do this: + + 1. Open your `kibana.yml` file. and add a new section for the [`xpack.actions.preconfigured`](kibana://reference/connectors-kibana/pre-configured-connectors.md) setting. + 2. Under the `xpack.actions.preconfigured setting`, define the email connector for example: + + ```` + xpack.actions.preconfigured: + my-email: + name: preconfigured-email-connector-type + actionTypeId: .email + config: + service: other + from: testsender@test.com + host: validhostname + port: 8080 + secure: false + hasAuth: true + secrets: + user: testuser + password: passwordkeystorevalue + ````` + +### Create a schedule [create-scheduled-report] 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. +4. Set up 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. + * **Date**: Choose when to start generating reports. + * **Timezone**: Specify a timezone for the schedule. + * **Repeat**: Choose how often you want to generate reports. -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. +5. (Optional) To share generated reports outside of Kibana, enable **Send by email** and enter a list of email addresses. Recipients will receive emails with the generated reports attached and on the schedule that you specified. 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. +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. ::::{important} -If you disable a schedule, _you cannot re-enable it_. If you want to continue generating reports, you must create a new schedule. +Note that you cannot edit or delete a schedule after you create it. To stop the schedule from running, you must disable it. Disabling a schedule permanently stops it from running. To restart it, you must create a new schedule. :::: \ No newline at end of file From 1eaa7ffff6f5248cf5480e92330602b1c22edece Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 11:26:44 -0400 Subject: [PATCH 04/27] Fix attribute --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index d1f1810dc5..519dc15cfb 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -10,7 +10,7 @@ products: # Automatically generate reports [automating-report-generation] -To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {{watcher}} or a script. In 9.1.0 and Serverless, you can use {{kiba}} to generate reports on a recurring schedule and share them outside of {{kib}} with a list of emails that you specify. +To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {{watcher}} or a script. In 9.1.0 and Serverless, you can use {{kib}} to generate reports on a recurring schedule and share them with a list of emails that you specify. ## Create a POST URL [create-a-post-url] From 528c7c55a2d7953f8c81668b3ff5ff17ceb6af5f Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 11:47:57 -0400 Subject: [PATCH 05/27] More links and changes --- .../report-and-share/automating-report-generation.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 519dc15cfb..714235625f 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -180,10 +180,10 @@ Save time by setting up a recurring task that automatically generates reports an * (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. * Sharing reports outside of {{kib}} requires a default preconfigured email connector. - * **{{ech}} or {{serverless-short}} users**: You do not need to set up a default preconfigured email connector. Kibana provides you with a preconfigured email connector that uses the SMTP protocol to send mail messages. To view it, go to the **Connectors** page and find the Elastic-Cloud-SMTP connector. - * **Self-managed users**: You must set up a default preconfigured email connector by defining it in your `kibana.yml` file. To do this: + * **{{ech}} or {{serverless-short}} users**: You do not need to set up a default preconfigured email connector. Kibana provides you with a built-in preconfigured email connector that uses the SMTP protocol to send emails. To view it, go to the **Connectors** page and find the Elastic-Cloud-SMTP connector. + * **Self-managed users**: You must set up a default preconfigured email connector to send notifications outside of {{kib}}. To do this: - 1. Open your `kibana.yml` file. and add a new section for the [`xpack.actions.preconfigured`](kibana://reference/connectors-kibana/pre-configured-connectors.md) setting. + 1. Open your `kibana.yml` file. and add a new section for the `xpack.actions.preconfigured` setting. This setting specifies configuration details that are specific to the type of preconfigured connector you're defining. 2. Under the `xpack.actions.preconfigured setting`, define the email connector for example: ```` @@ -203,6 +203,10 @@ Save time by setting up a recurring task that automatically generates reports an password: passwordkeystorevalue ````` + :::{tip} + Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirmements for different email services and providers. + ::: + ### Create a schedule [create-scheduled-report] 1. Open the saved Discover session, dashboard, or visualization you want to share. @@ -217,7 +221,7 @@ Save time by setting up a recurring task that automatically generates reports an 5. (Optional) To share generated reports outside of Kibana, enable **Send by email** and enter a list of email addresses. Recipients will receive emails with the generated reports attached and on the schedule that you specified. 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. +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. ::::{important} Note that you cannot edit or delete a schedule after you create it. To stop the schedule from running, you must disable it. Disabling a schedule permanently stops it from running. To restart it, you must create a new schedule. From fae4692418a3ff4c96c3eb4df63c28b1ca2b1943 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 11:54:36 -0400 Subject: [PATCH 06/27] typo --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 714235625f..a9067c9280 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -204,7 +204,7 @@ Save time by setting up a recurring task that automatically generates reports an ````` :::{tip} - Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirmements for different email services and providers. + Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirements for different email services and providers. ::: ### Create a schedule [create-scheduled-report] From 104ed7ae2bf121927cba459a5074989869b868bd Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Tue, 15 Jul 2025 12:16:09 -0400 Subject: [PATCH 07/27] Update explore-analyze/report-and-share/automating-report-generation.md Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index a9067c9280..7cdbe857a1 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -184,7 +184,7 @@ Save time by setting up a recurring task that automatically generates reports an * **Self-managed users**: You must set up a default preconfigured email connector to send notifications outside of {{kib}}. To do this: 1. Open your `kibana.yml` file. and add a new section for the `xpack.actions.preconfigured` setting. This setting specifies configuration details that are specific to the type of preconfigured connector you're defining. - 2. Under the `xpack.actions.preconfigured setting`, define the email connector for example: + 2. Under the `xpack.actions.preconfigured setting`, define the email connector. For example: ```` xpack.actions.preconfigured: From bf3ac84a15f3efc5157a33b5df1754370e87a7eb Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Tue, 15 Jul 2025 12:16:18 -0400 Subject: [PATCH 08/27] Update explore-analyze/report-and-share/automating-report-generation.md Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 7cdbe857a1..6be6e9167d 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -176,7 +176,7 @@ Save time by setting up a recurring task that automatically generates reports an ### Requirements [scheduled-reports-reqs] -* To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access) +* To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access). * (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. * Sharing reports outside of {{kib}} requires a default preconfigured email connector. From 8097d1d97189fbecc9148f5985cbba2e10d4175b Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Tue, 15 Jul 2025 12:16:30 -0400 Subject: [PATCH 09/27] Update explore-analyze/report-and-share.md Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- explore-analyze/report-and-share.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share.md b/explore-analyze/report-and-share.md index 0c5f810506..4d78905624 100644 --- a/explore-analyze/report-and-share.md +++ b/explore-analyze/report-and-share.md @@ -92,7 +92,7 @@ In the following dashboard, the shareable container is highlighted: Tips for generating PDF reports: - * If you are creating dashboard PDFs, select **For printing** to create printer-friendly 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. * {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. :::: From 33cbf30cd3a25a7cf8acac33e3bda509ae750c45 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Tue, 15 Jul 2025 12:16:38 -0400 Subject: [PATCH 10/27] Update explore-analyze/report-and-share/automating-report-generation.md Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 6be6e9167d..fe5426827d 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -183,7 +183,7 @@ Save time by setting up a recurring task that automatically generates reports an * **{{ech}} or {{serverless-short}} users**: You do not need to set up a default preconfigured email connector. Kibana provides you with a built-in preconfigured email connector that uses the SMTP protocol to send emails. To view it, go to the **Connectors** page and find the Elastic-Cloud-SMTP connector. * **Self-managed users**: You must set up a default preconfigured email connector to send notifications outside of {{kib}}. To do this: - 1. Open your `kibana.yml` file. and add a new section for the `xpack.actions.preconfigured` setting. This setting specifies configuration details that are specific to the type of preconfigured connector you're defining. + 1. Open your `kibana.yml` file and add a new section for the `xpack.actions.preconfigured` setting. This setting specifies configuration details that are specific to the type of preconfigured connector you're defining. 2. Under the `xpack.actions.preconfigured setting`, define the email connector. For example: ```` From 6b4437439e87f659906d7a3cb8690e107ac93f65 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Tue, 15 Jul 2025 12:47:11 -0400 Subject: [PATCH 11/27] Update explore-analyze/report-and-share/automating-report-generation.md --- explore-analyze/report-and-share/automating-report-generation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index fe5426827d..7e307f3c3f 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -170,6 +170,7 @@ In earlier {{kib}} versions, you could use the `&sync` parameter to append to re ```{applies_to} stack: preview 9.1 +serverless: preview ``` Save time by setting up a recurring task that automatically generates reports and shares them on a schedule that you choose. From c7e576f9c7b37c8cbe8cbfa140ca33ebed3cc42d Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 15:58:23 -0400 Subject: [PATCH 12/27] Ying's input round 1 --- .../automating-report-generation.md | 52 ++++++++++++------- 1 file changed, 32 insertions(+), 20 deletions(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 7e307f3c3f..7cad5ed752 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -178,36 +178,43 @@ Save time by setting up a recurring task that automatically generates reports an ### Requirements [scheduled-reports-reqs] * To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access). -* (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. +* (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only share reports with yourself. * Sharing reports outside of {{kib}} requires a default preconfigured email connector. * **{{ech}} or {{serverless-short}} users**: You do not need to set up a default preconfigured email connector. Kibana provides you with a built-in preconfigured email connector that uses the SMTP protocol to send emails. To view it, go to the **Connectors** page and find the Elastic-Cloud-SMTP connector. * **Self-managed users**: You must set up a default preconfigured email connector to send notifications outside of {{kib}}. To do this: - 1. Open your `kibana.yml` file and add a new section for the `xpack.actions.preconfigured` setting. This setting specifies configuration details that are specific to the type of preconfigured connector you're defining. - 2. Under the `xpack.actions.preconfigured setting`, define the email connector. For example: - - ```` - xpack.actions.preconfigured: - my-email: - name: preconfigured-email-connector-type - actionTypeId: .email - config: - service: other - from: testsender@test.com - host: validhostname - port: 8080 - secure: false - hasAuth: true - secrets: - user: testuser - password: passwordkeystorevalue - ````` + 1. Open your `kibana.yml` file. + 2. Add the `xpack.actions.preconfigured` {{kib}} setting. This setting specifies configuration details for the preconfigured connector that you're defining. + 2. Under the `xpack.actions.preconfigured setting`, define the email connector. You must define these details in the `kibana.yml` file. You cannot create a preconfigured email connector from the {{kib}} UI. :::{tip} Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirements for different email services and providers. ::: + 3. Add the `notifications.connectors.default.email` {{kib}} setting, and provide the name of your email connector. This setting specifies the default email connector to use when sending notifications. This is especially useful if you have multiple email connectos and want to specify a default one. + + The following example shows a `kibana.yml` file with a preconfigured email connector set as the default connector for email notifications: + + ``` + xpack.actions.preconfigured: + my-email: + name: preconfigured-email-connector-type + actionTypeId: .email + config: + service: other + from: testsender@test.com + host: validhostname + port: 8080 + secure: false + hasAuth: true + secrets: + user: testuser + password: passwordkeystorevalue + + notifications.connectors.default.email: my-email + ``` + ### Create a schedule [create-scheduled-report] 1. Open the saved Discover session, dashboard, or visualization you want to share. @@ -220,6 +227,11 @@ Save time by setting up a recurring task that automatically generates reports an * **Repeat**: Choose how often you want to generate reports. 5. (Optional) To share generated reports outside of Kibana, enable **Send by email** and enter a list of email addresses. Recipients will receive emails with the generated reports attached and on the schedule that you specified. + + ::::{note} + If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only send reports to yourself. + :::: + 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. From 9eb7de3a04d6168938523cede2645e7ebf8a3c42 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 16:00:24 -0400 Subject: [PATCH 13/27] Fixed code block --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 7cad5ed752..a4c0c89e22 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -213,7 +213,7 @@ Save time by setting up a recurring task that automatically generates reports an password: passwordkeystorevalue notifications.connectors.default.email: my-email - ``` + ``` ### Create a schedule [create-scheduled-report] From a9cca7dfe01619431625db3cf41a41aeefbc809d Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Tue, 15 Jul 2025 16:18:21 -0400 Subject: [PATCH 14/27] Update explore-analyze/report-and-share/automating-report-generation.md --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index a4c0c89e22..e602669387 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -178,7 +178,7 @@ Save time by setting up a recurring task that automatically generates reports an ### Requirements [scheduled-reports-reqs] * To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access). -* (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only share reports with yourself. +* (Optional) To view and manage other user's reports and schedules, and to share reports with others using email, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only share reports with yourself. * Sharing reports outside of {{kib}} requires a default preconfigured email connector. * **{{ech}} or {{serverless-short}} users**: You do not need to set up a default preconfigured email connector. Kibana provides you with a built-in preconfigured email connector that uses the SMTP protocol to send emails. To view it, go to the **Connectors** page and find the Elastic-Cloud-SMTP connector. From 684b38c52898764e229d9b44b6a0fe2f2cad312d Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 16:21:21 -0400 Subject: [PATCH 15/27] clarifying workpad --- explore-analyze/report-and-share.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share.md b/explore-analyze/report-and-share.md index 4d78905624..b534c8c18c 100644 --- a/explore-analyze/report-and-share.md +++ b/explore-analyze/report-and-share.md @@ -82,7 +82,7 @@ In the following dashboard, the shareable container is highlighted: :screenshot: ::: -1. Open the saved Discover session, dashboard, visualization, or workpad you want to share. +1. Open the saved Discover session, dashboard, visualization, or **Canvas** workpad you want to share. 2. Choose a file type for the report. * {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. From 4669b5837841ce065a328bf4113a54c968df93a4 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 16:42:58 -0400 Subject: [PATCH 16/27] Tia's suggestions --- .../report-and-share/automating-report-generation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index e602669387..fd3bf88086 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -178,7 +178,7 @@ Save time by setting up a recurring task that automatically generates reports an ### Requirements [scheduled-reports-reqs] * To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access). -* (Optional) To view and manage other user's reports and schedules, and to share reports with others using email, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only share reports with yourself. +* (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only share reports with yourself. * Sharing reports outside of {{kib}} requires a default preconfigured email connector. * **{{ech}} or {{serverless-short}} users**: You do not need to set up a default preconfigured email connector. Kibana provides you with a built-in preconfigured email connector that uses the SMTP protocol to send emails. To view it, go to the **Connectors** page and find the Elastic-Cloud-SMTP connector. @@ -192,7 +192,7 @@ Save time by setting up a recurring task that automatically generates reports an Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirements for different email services and providers. ::: - 3. Add the `notifications.connectors.default.email` {{kib}} setting, and provide the name of your email connector. This setting specifies the default email connector to use when sending notifications. This is especially useful if you have multiple email connectos and want to specify a default one. + 3. Add the `notifications.connectors.default.email` {{kib}} setting, and provide the name of your email connector. This setting specifies the default email connector to use when sending notifications. This is especially useful if you have multiple email connectors and want to specify a default one. The following example shows a `kibana.yml` file with a preconfigured email connector set as the default connector for email notifications: From e6eb734382ddc7030437114191febc82a5d0788e Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 16:45:31 -0400 Subject: [PATCH 17/27] Adding resource req for reporting --- explore-analyze/report-and-share/automating-report-generation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index fd3bf88086..a7a4748364 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -177,6 +177,7 @@ Save time by setting up a recurring task that automatically generates reports an ### Requirements [scheduled-reports-reqs] +* To use reporting, your {{kib}} instance must have a minimum of 2GB of RAM. * To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access). * (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only share reports with yourself. * Sharing reports outside of {{kib}} requires a default preconfigured email connector. From eeba5a4f16230ebaf950557f1d53e34862d660d4 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 17:53:06 -0400 Subject: [PATCH 18/27] moved info in reqs --- .../report-and-share/automating-report-generation.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index a7a4748364..c0d932ea08 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -187,15 +187,15 @@ Save time by setting up a recurring task that automatically generates reports an 1. Open your `kibana.yml` file. 2. Add the `xpack.actions.preconfigured` {{kib}} setting. This setting specifies configuration details for the preconfigured connector that you're defining. - 2. Under the `xpack.actions.preconfigured setting`, define the email connector. You must define these details in the `kibana.yml` file. You cannot create a preconfigured email connector from the {{kib}} UI. + 2. Under the `xpack.actions.preconfigured` setting, define the email connector. Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirements for different email services and providers. - :::{tip} - Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirements for different email services and providers. + :::{note} + You must define preconfigured email connector details in the `kibana.yml` file. You cannot create a preconfigured email connector from the {{kib}} UI. ::: - 3. Add the `notifications.connectors.default.email` {{kib}} setting, and provide the name of your email connector. This setting specifies the default email connector to use when sending notifications. This is especially useful if you have multiple email connectors and want to specify a default one. - - The following example shows a `kibana.yml` file with a preconfigured email connector set as the default connector for email notifications: + 3. Add the `notifications.connectors.default.email` {{kib}} setting, and provide the name of your email connector. The `notifications.connectors.default.email` setting specifies the default email connector to use when sending notifications. This is especially useful if you have multiple email connectors and want to set a default one. + + The following example shows a modified `kibana.yml` file with a preconfigured email connector that's set as the default connector for email notifications: ``` xpack.actions.preconfigured: From 54292fc6b2a89c7e1b253d81a6401853443f0ce9 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Tue, 15 Jul 2025 18:27:16 -0400 Subject: [PATCH 19/27] First draft of limitations section --- .../report-and-share/automating-report-generation.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index c0d932ea08..8bf0fa06cc 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -239,4 +239,13 @@ A message appears, indicating that the schedule is available on the **Reporting* ::::{important} Note that you cannot edit or delete a schedule after you create it. To stop the schedule from running, you must disable it. Disabling a schedule permanently stops it from running. To restart it, you must create a new schedule. -:::: \ No newline at end of file +:::: + +### Scheduled reports limitations [scheduled-reports-limitations] + +The feature enables analysis of data in external tools, but it is not intended for bulk export or to backup Elasticsearch data. Issues with report generation and sharing are likely to happen in the following scenarios: + +* {{kib}} might fail to attach reports that exceed the size limit for email attachments, which is... +* Scheduling too many reports at the same time might cause reports to be shared late or at an inconsistent schedule. {{kib}} Task Manager runs reporting tasks one at a time. +* If your cluster is running many tasks in general, reports may be delayed. +* Scheduling reports of Canvas workpads is not supported since Canvas workpads are in maintenance mode. \ No newline at end of file From 9228a1b6250b52d11774c3f7549696e62ee9ef8a Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Thu, 17 Jul 2025 13:44:24 -0400 Subject: [PATCH 20/27] Update explore-analyze/report-and-share/automating-report-generation.md --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 8bf0fa06cc..0e38548e11 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -25,7 +25,7 @@ To create the POST URL for PDF reports: * {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. + * {applies_to}`stack: ga 9.1` Click the **Export** icon, then **PDF**. In the export flyout, copy the POST URL. ### CSV reports From 006df70eab1ba3e54d62a1d1a40b34b9d4a2c7f9 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Thu, 17 Jul 2025 13:46:19 -0400 Subject: [PATCH 21/27] RAM reqs --- .../report-and-share/automating-report-generation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 8bf0fa06cc..02f0c6bec1 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -175,9 +175,9 @@ serverless: preview Save time by setting up a recurring task that automatically generates reports and shares them on a schedule that you choose. -### Requirements [scheduled-reports-reqs] +### Prerequisites [scheduled-reports-reqs] -* To use reporting, your {{kib}} instance must have a minimum of 2GB of RAM. +* To generate PDF and PNG reports, your {{kib}} instance needs a minimum of 2GB of RAM. There is no minimum requirement for CSV reports. * To use the scheduled reports feature, your role needs [access to reporting](../../deploy-manage/kibana-reporting-configuration.md#grant-user-access). * (Optional) To view and manage other users’ reports and schedules, your role needs `All` privileges for the **Manage Scheduled Reports** feature. You can set this by configuring your role's {{kib}} privileges. If your role doesn't have the **Manage Scheduled Reporting** feature privilege, you can only share reports with yourself. * Sharing reports outside of {{kib}} requires a default preconfigured email connector. @@ -245,7 +245,7 @@ Note that you cannot edit or delete a schedule after you create it. To stop the The feature enables analysis of data in external tools, but it is not intended for bulk export or to backup Elasticsearch data. Issues with report generation and sharing are likely to happen in the following scenarios: -* {{kib}} might fail to attach reports that exceed the size limit for email attachments, which is... +* The limit for email attachments is 10 MB. {{kib}} might fail to attach reports that are larger than this size. * Scheduling too many reports at the same time might cause reports to be shared late or at an inconsistent schedule. {{kib}} Task Manager runs reporting tasks one at a time. * If your cluster is running many tasks in general, reports may be delayed. * Scheduling reports of Canvas workpads is not supported since Canvas workpads are in maintenance mode. \ No newline at end of file From 1f917113260107485a458e0b8a595652b20c5aaf Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Thu, 17 Jul 2025 14:23:56 -0400 Subject: [PATCH 22/27] reqs and limits --- .../report-and-share/automating-report-generation.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 3b8f7088a8..c29c1fa3fd 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -216,6 +216,8 @@ Save time by setting up a recurring task that automatically generates reports an notifications.connectors.default.email: my-email ``` +* (Optional) To control who can receive email notifications from {{kib}}, add the [`xpack.actions.email.domain_allowlist` setting](kibana://reference/configuration-reference.alerting-settings.md) to your `kibana.yml` file. To learn more about configuring this setting, refer to [Notifications domain allowlist](../alerts-cases/alerts/notifications-domain-allowlist.md). + ### Create a schedule [create-scheduled-report] 1. Open the saved Discover session, dashboard, or visualization you want to share. @@ -248,4 +250,5 @@ The feature enables analysis of data in external tools, but it is not intended f * The limit for email attachments is 10 MB. {{kib}} might fail to attach reports that are larger than this size. * Scheduling too many reports at the same time might cause reports to be shared late or at an inconsistent schedule. {{kib}} Task Manager runs reporting tasks one at a time. * If your cluster is running many tasks in general, reports may be delayed. -* Scheduling reports of Canvas workpads is not supported since Canvas workpads are in maintenance mode. \ No newline at end of file +* Scheduling reports of Canvas workpads is not supported since Canvas workpads are in maintenance mode. +* Scheduling CSV reports of Lens visualizations is not supported. \ No newline at end of file From 6f2bde8a2fc4f913187c3cb9f963d077b3057f0e Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Thu, 17 Jul 2025 15:12:08 -0400 Subject: [PATCH 23/27] Update explore-analyze/report-and-share/automating-report-generation.md --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index c29c1fa3fd..94eb3763f0 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -216,7 +216,7 @@ Save time by setting up a recurring task that automatically generates reports an notifications.connectors.default.email: my-email ``` -* (Optional) To control who can receive email notifications from {{kib}}, add the [`xpack.actions.email.domain_allowlist` setting](kibana://reference/configuration-reference.alerting-settings.md) to your `kibana.yml` file. To learn more about configuring this setting, refer to [Notifications domain allowlist](../alerts-cases/alerts/notifications-domain-allowlist.md). +* (Optional) To control who can receive email notifications from {{kib}}, add the [`xpack.actions.email.domain_allowlist` setting](kibana://settings/alert-action-settings.asciidoc) to your `kibana.yml` file. To learn more about configuring this setting, refer to [Notifications domain allowlist](../alerts-cases/alerts/notifications-domain-allowlist.md). ### Create a schedule [create-scheduled-report] From f3338850a709a670eb0d8cbf385818466e330cd8 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Thu, 17 Jul 2025 15:18:22 -0400 Subject: [PATCH 24/27] Update explore-analyze/report-and-share/automating-report-generation.md --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 94eb3763f0..560b909f48 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -216,7 +216,7 @@ Save time by setting up a recurring task that automatically generates reports an notifications.connectors.default.email: my-email ``` -* (Optional) To control who can receive email notifications from {{kib}}, add the [`xpack.actions.email.domain_allowlist` setting](kibana://settings/alert-action-settings.asciidoc) to your `kibana.yml` file. To learn more about configuring this setting, refer to [Notifications domain allowlist](../alerts-cases/alerts/notifications-domain-allowlist.md). +* (Optional) To control who can receive email notifications from {{kib}}, add the [`xpack.actions.email.domain_allowlist` setting](kibana://reference/configuration-reference/alerting-settings.md) to your `kibana.yml` file. To learn more about configuring this setting, refer to [Notifications domain allowlist](../alerts-cases/alerts/notifications-domain-allowlist.md). ### Create a schedule [create-scheduled-report] From 840efd71753a05f8c735e1a89721ce86fedc4558 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon Date: Thu, 17 Jul 2025 15:44:28 -0400 Subject: [PATCH 25/27] smol fix --- .../report-and-share/automating-report-generation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 560b909f48..af48d96ebf 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -187,13 +187,13 @@ Save time by setting up a recurring task that automatically generates reports an 1. Open your `kibana.yml` file. 2. Add the `xpack.actions.preconfigured` {{kib}} setting. This setting specifies configuration details for the preconfigured connector that you're defining. - 2. Under the `xpack.actions.preconfigured` setting, define the email connector. Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirements for different email services and providers. + 3. Under the `xpack.actions.preconfigured` setting, define the email connector. Refer to [Email connectors](kibana://reference/connectors-kibana/pre-configured-connectors.md#preconfigured-email-configuration) to learn about requirements for different email services and providers. :::{note} You must define preconfigured email connector details in the `kibana.yml` file. You cannot create a preconfigured email connector from the {{kib}} UI. ::: - 3. Add the `notifications.connectors.default.email` {{kib}} setting, and provide the name of your email connector. The `notifications.connectors.default.email` setting specifies the default email connector to use when sending notifications. This is especially useful if you have multiple email connectors and want to set a default one. + 4. Add the `notifications.connectors.default.email` {{kib}} setting, and provide the name of your email connector. The `notifications.connectors.default.email` setting specifies the default email connector to use when sending notifications. This is especially useful if you have multiple email connectors and want to set a default one. The following example shows a modified `kibana.yml` file with a preconfigured email connector that's set as the default connector for email notifications: From 91c3842dd56e8220cbec3128ea6a4a683266bbc0 Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Thu, 17 Jul 2025 15:45:08 -0400 Subject: [PATCH 26/27] Update explore-analyze/report-and-share/automating-report-generation.md Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index af48d96ebf..52bfd907cd 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -10,7 +10,7 @@ products: # Automatically generate reports [automating-report-generation] -To automatically generate PDF and CSV reports, generate a POST URL, then submit an HTTP `POST` request using {{watcher}} or a script. In 9.1.0 and Serverless, you can use {{kib}} to generate reports on a recurring schedule and share them with a list of emails that you specify. +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 and Serverless, you can use {{kib}} to generate reports on a recurring schedule and share them with a list of emails that you specify. ## Create a POST URL [create-a-post-url] From e1dabde83ec81ebd265f7df12017e943c504c9bf Mon Sep 17 00:00:00 2001 From: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Date: Thu, 17 Jul 2025 15:45:19 -0400 Subject: [PATCH 27/27] Update explore-analyze/report-and-share/automating-report-generation.md Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> --- .../report-and-share/automating-report-generation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/report-and-share/automating-report-generation.md b/explore-analyze/report-and-share/automating-report-generation.md index 52bfd907cd..2ea500c6b8 100644 --- a/explore-analyze/report-and-share/automating-report-generation.md +++ b/explore-analyze/report-and-share/automating-report-generation.md @@ -23,7 +23,7 @@ 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. From the toolbar, do one of the following: - * {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 **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.1` Click the **Export** icon, then **PDF**. In the export flyout, copy the POST URL.