Skip to content

Commit 8b1036b

Browse files
20 first lines complete check on reporting folder, unedited
1 parent 7a0d1dd commit 8b1036b

File tree

4 files changed

+55
-21
lines changed

4 files changed

+55
-21
lines changed

explore-analyze/report-and-share/automating-report-generation.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
description: Generate reports automatically using {{watcher}}, scripts, or scheduled tasks. Configure recurring exports and share PDF, PNG, or CSV reports by email.
23
mapped_pages:
34
- https://www.elastic.co/guide/en/kibana/current/automating-report-generation.html
45
applies_to:
@@ -10,11 +11,23 @@ products:
1011

1112
# Automatically generate reports [automating-report-generation]
1213

13-
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.
14+
Automate report generation to share dashboards, visualizations, and data exports on a regular schedule. You can use {{watcher}} or scripts to trigger report generation through a POST URL, or set up recurring schedules directly in {{kib}} to generate and email reports automatically.
15+
16+
Three approaches are available for automating reports:
17+
18+
* **{{watcher}}**: Configure watches that generate and email reports based on schedules or conditions
19+
* **Scripts**: Use HTTP POST requests to programmatically generate reports on demand
20+
* **Scheduled exports**: {applies_to}`stack: preview 9.1, serverless: preview` Set up recurring tasks in {{kib}} that automatically generate and share reports by email
21+
22+
**Prerequisites:**
23+
24+
* Appropriate {{kib}} privileges to create reports
25+
* {applies_to}`stack: ga` API key or user credentials with reporting permissions
26+
* {applies_to}`stack: preview 9.1, serverless: preview` For scheduled email sharing, a configured email connector
1427

1528
:::{note}
1629
:applies_to: {stack: ga, serverless: unavailable}
17-
API keys are used to authenticate requests to generate reports. If you have a cross-cluster search environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the leader index, instead of the remote. For more information and examples, refer to [Configure roles and users for remote clusters](../../deploy-manage/remote-clusters/remote-clusters-cert.md#remote-clusters-privileges-cert).
30+
{{api-keys-app}} are used to authenticate requests to generate reports. If you have a {{ccs}} environment and want to generate reports from remote clusters, you must have the appropriate cluster and index privileges on the remote cluster and local cluster. For example, if requests are authenticated with an API key, the API key requires certain privileges on the local cluster that contains the leader index, instead of the remote. For more information and examples, refer to [Configure roles and users for remote clusters](../../deploy-manage/remote-clusters/remote-clusters-cert.md#remote-clusters-privileges-cert).
1831
:::
1932

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

explore-analyze/report-and-share/reporting-troubleshooting-csv.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
description: Troubleshoot common CSV export issues including timeouts, socket errors, token expiration, and scroll API configuration.
23
navigation_title: CSV
34
mapped_pages:
45
- https://www.elastic.co/guide/en/kibana/current/reporting-troubleshooting-csv.html
@@ -13,31 +14,34 @@ products:
1314

1415
# CSV [reporting-troubleshooting-csv]
1516

17+
CSV export in {{kib}} queries {{es}} and formats the results as downloadable CSV files. While this works well for moderate data exports, issues can occur with large datasets, slow storage, network latency, or authentication timeouts. This page helps you diagnose and resolve common CSV export problems.
18+
19+
Common issues include:
20+
21+
* Report timeouts when exporting more than 250 MB of data
22+
* Incomplete data when shards are unavailable or using {{ccs}}
23+
* Socket hangup errors during long-running exports
24+
* Token expiration for SAML-authenticated deployments
25+
26+
For general troubleshooting guidance, refer to [Troubleshooting](reporting-troubleshooting.md).
1627

1728
::::{note}
18-
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:
29+
CSV export is designed for moderate data amounts only. It enables data analysis in external tools but is not intended for bulk export or {{es}} backups. Report timeout and incomplete data issues are likely when exporting data where:
1930

2031
* More than 250 MB of data is being exported
2132
* Data is stored on slow storage tiers
2233
* Any shard needed for the search is unavailable
2334
* Network latency between nodes is high
24-
* Cross-cluster search is used
25-
* ES|QL is used and result row count exceeds the limits of ES|QL queries
26-
27-
To work around the limitations, use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs.
35+
* {{ccs}} is used
36+
* {{esql}} is used and result row count exceeds the limits of {{esql}} queries
2837

29-
For more information on using Elasticsearch APIs directly, see [Scroll API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll), [Point in time API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time), [ES|QL](elasticsearch://reference/query-languages/esql/esql-rest.md) or [SQL](elasticsearch://reference/query-languages/sql/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](/reference/elasticsearch-clients/index.md).
38+
To work around these limitations, use filters to create multiple smaller reports, or extract data directly with {{es}} APIs. For information on using {{es}} APIs directly, refer to [Scroll API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll), [Point in time API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time), [{{esql}}](elasticsearch://reference/query-languages/esql/esql-rest.md), or [SQL](elasticsearch://reference/query-languages/sql/sql-rest-format.md#_csv) with CSV response data format. Consider using an official {{es}} client: refer to [{{es}} Client documentation](/reference/elasticsearch-clients/index.md).
3039

31-
[Reporting parameters](kibana://reference/configuration-reference/reporting-settings.md) can be adjusted to overcome some of these limiting scenarios. Results are dependent on data size, availability, and latency factors and are not guaranteed.
40+
You can adjust [Reporting parameters](kibana://reference/configuration-reference/reporting-settings.md) to overcome some limiting scenarios. Results depend on data size, availability, and latency factors and are not guaranteed.
3241

3342
::::
3443

3544

36-
The CSV export feature in Kibana makes queries to Elasticsearch and formats the results into CSV. This feature offers a solution that attempts to provide the most benefit to the most use cases. However, things could go wrong during export. Elasticsearch can stop responding, repeated querying can take so long that authentication tokens can time out, and the format of exported data can be too complex for spreadsheet applications to handle. Such situations are outside of the control of Kibana. If the use case becomes complex enough, it’s recommended that you create scripts that query Elasticsearch directly, using a scripting language like Python and the public {{es}} APIs.
37-
38-
For advice about common problems, refer to [Troubleshooting](reporting-troubleshooting.md).
39-
40-
4145
## Configuring CSV export to use the scroll API [reporting-troubleshooting-csv-configure-scan-api]
4246

4347
The Kibana CSV export feature collects all of the data from Elasticsearch by using multiple requests to page over all of the documents. Internally, the feature uses the [Point in time API and `search_after` parameters in the queries](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time) to do so. There are some limitations related to the point in time API:

explore-analyze/report-and-share/reporting-troubleshooting-pdf.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
description: Troubleshoot PDF and PNG export issues including browser dependencies, sandbox requirements, font rendering, connection errors, and system requirements.
23
navigation_title: PDF/PNG
34
mapped_pages:
45
- https://www.elastic.co/guide/en/kibana/current/reporting-troubleshooting-pdf.html
@@ -13,16 +14,26 @@ products:
1314

1415
# PDF/PNG [reporting-troubleshooting-pdf]
1516

17+
PDF and PNG reporting in {{kib}} uses a headless Chromium browser to capture screenshots of dashboards and visualizations. Issues can occur due to missing system dependencies, sandbox restrictions, font problems, or resource constraints. This page helps you diagnose and resolve common PDF and PNG export problems.
1618

17-
::::{note}
18-
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.
19+
Common issues include:
1920

20-
For the most reliable configuration of PDF/PNG {{report-features}}, consider installing {{kib}} using [Docker](../../deploy-manage/deploy/self-managed/install-kibana-with-docker.md) or using [Elastic Cloud](https://cloud.elastic.co).
21+
* Missing Network Security Service (NSS) libraries
22+
* Chromium sandbox requirements and user namespace restrictions
23+
* Text rendering incorrectly due to missing fonts
24+
* Connection refused errors with server host settings
25+
* Memory limitations causing page crashes
2126

22-
::::
27+
**Technical summary**: Use the built-in reporting diagnostics tool at **{{reports-app}} > Run reporting diagnostics** to identify common configuration issues. For Docker or {{ecloud}} deployments, most dependencies are preconfigured.
28+
29+
For general troubleshooting guidance, refer to [Troubleshooting](reporting-troubleshooting.md).
2330

31+
::::{note}
32+
PDF and PNG reports work best with moderate amounts of visual data. The feature provides high-level export capability but is not intended for bulk export. If you need to export several pages of image data, use multiple report jobs to export a small number of pages at a time. If exported dashboard screenshots contain a large number of pixels, split large dashboards into smaller artifacts to reduce memory and CPU usage.
33+
34+
For the most reliable configuration of PDF/PNG {{report-features}}, install {{kib}} using [Docker](../../deploy-manage/deploy/self-managed/install-kibana-with-docker.md) or use [{{ecloud}}](https://cloud.elastic.co).
2435

25-
For more advice about common problems, refer to [Troubleshooting](reporting-troubleshooting.md).
36+
::::
2637

2738

2839
## Reporting diagnostics [reporting-diagnostics]

explore-analyze/report-and-share/reporting-troubleshooting.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
description: Diagnose and resolve common reporting errors including version conflicts, max attempts reached, and timeout issues. Enable verbose logging for troubleshooting.
23
navigation_title: Troubleshoot reporting
34
mapped_pages:
45
- https://www.elastic.co/guide/en/kibana/current/reporting-troubleshooting.html
@@ -13,10 +14,15 @@ products:
1314

1415
# Troubleshoot report errors and logs in {{kib}} [reporting-troubleshooting]
1516

17+
{{report-features}} in {{kib}} are designed for simple data exports and visualizations, not bulk data export or large-scale operations. When you encounter issues generating reports, understanding common error messages and enabling verbose logging can help you diagnose and resolve problems quickly.
1618

17-
Kibana excels as a data visualization tool. The {{report-features}} exist to export data as simple reports, however Kibana is not a data export tool. To export data at a large scale, there are better ways and better architectures for exporting data at scale from Elasticsearch.
19+
Common issues include:
1820

19-
If you have trouble creating simple reports, there are some general solutions to common problems you might encounter while using {{report-features}}. For tips related to specific types of reports, refer to [CSV](reporting-troubleshooting-csv.md) and [PDF/PNG](reporting-troubleshooting-pdf.md).
21+
* Version conflict exceptions in clustered environments
22+
* "Max attempts reached" errors due to timeouts or configuration issues
23+
* Report failures with large datasets or complex visualizations
24+
25+
For issues specific to report formats, refer to [CSV troubleshooting](reporting-troubleshooting-csv.md) and [PDF/PNG troubleshooting](reporting-troubleshooting-pdf.md).
2026

2127

2228
## Error messages [reporting-troubleshooting-error-messages]

0 commit comments

Comments
 (0)