github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.16] Update Reporting documentation: ES configuration, avoiding Token expiration (#208257) (#208714)

Browse source 
# Backport

This will backport the following commits from `main` to `8.16`:
- [Update Reporting documentation: ES configuration, avoiding Token
expiration (#208257)](https://github.com/elastic/kibana/pull/208257)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Tim
Sullivan","email":"tsullivan@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-01-29T10:54:09Z","message":"Update
Reporting documentation: ES configuration, avoiding Token expiration
(#208257)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/201281\r\nCloses
https://github.com/elastic/kibana/issues/200653\r\n\r\n---------\r\n\r\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"5f59395f185c855be3dff477e8f66d328e0b8073","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","v8.15.0","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"Update
Reporting documentation: ES configuration, avoiding Token
expiration","number":208257,"url":"https://github.com/elastic/kibana/pull/208257","mergeCommit":{"message":"Update
Reporting documentation: ES configuration, avoiding Token expiration
(#208257)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/201281\r\nCloses
https://github.com/elastic/kibana/issues/200653\r\n\r\n---------\r\n\r\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"5f59395f185c855be3dff477e8f66d328e0b8073"}},"sourceBranch":"main","suggestedTargetBranches":["8.15","8.16","8.17","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/208257","number":208257,"mergeCommit":{"message":"Update
Reporting documentation: ES configuration, avoiding Token expiration
(#208257)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/201281\r\nCloses
https://github.com/elastic/kibana/issues/200653\r\n\r\n---------\r\n\r\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"5f59395f185c855be3dff477e8f66d328e0b8073"}},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2025-01-29 22:25:12 +11:00 • committed by GitHub
parent 3512420dbf
commit a261ca1b09
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 23 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/setup/configuring-reporting.asciidoc
View file

@ -31,6 +31,7 @@ to enable the {kib} server to have screenshotting capabilities.
* <<securing-reporting>>
* <<install-reporting-packages>>
* <<set-reporting-server-host>>
* <<reporting-elasticsearch-configuration>>
[float]
[[grant-user-access]]
@ -260,3 +261,10 @@ PDF/PNG reporting to reach {kib} over a local interface, while also allowing the
outward-facing network interfaces, as it makes the {kib} server accessible from any network interface on the
machine. Make sure that no firewall rules or other routing rules prevent local services from accessing this
address.
[float]
[[reporting-elasticsearch-configuration]]
=== Ensure {es} allows built-in templates
Reporting relies on {es} to install a mapping template for the data stream that stores reports. Ensure that {es} allows built-in
templates to be installed by keeping the `stack.templates.enabled` setting at the default value of `true`. For more information, see
{ref}/index-management-settings.html#stack-templates-enabled[Index management settings].

17
docs/user/reporting/reporting-csv-troubleshooting.asciidoc
View file

@ -88,5 +88,18 @@ image::https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt4758e67aa
[[reporting-troubleshooting-csv-token-expired]]
=== Token expiration
To avoid token expirations, use a type of authentication that doesn't expire (such as Basic auth) or run the export using scripts that query Elasticsearch directly.
In a custom script, you have the ability to refresh the auth token as needed, such as once before each query.
A relatively common type of error seen for CSV exports is: `security_exception Root causes: security_exception: token expired`.
This error occurs in deployments that use token-based authentication (SAML tokens) when it takes too long to create the CSV report with the authentication cached in report job details.
This means that the deployment is stable, but the size of the requested report is too large to complete within the time allowed by the authentication token available to the Reporting task.
[float]
[[avoid-token-expiration]]
==== Avoiding token expiration
You can use the following workarounds for this error:
* Create smaller reports. Instead of creating one report that covers a large time range, create multiple reports that cover segmented time ranges.
* Increase `xpack.security.authc.token.timeout`, which is set to `20m` by default.
* To avoid token expirations completely, use a type of authentication that doesn't expire (such as Basic auth), or run the export using scripts that query {es} directly.