Update Reporting documentation: ES configuration, avoiding Token expiration #208257
Conversation
tsullivan
added
release_note:skip
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
| Reporting relies on Elasticsearch to install a mapping template for the data stream that stores reports. Ensure that Elasticsearch 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]. | ||
|
|
There was a problem hiding this comment.
I'm not sure where is a great place to organize this information; it seems to minor to place at the top. I'm open to suggestions.
There was a problem hiding this comment.
I see what you mean. Maybe we could add it to the end? If you agree, you can commit my suggestion on line 34. It's an anchor link for this heading to match the rest of the headings
|
|
||
| * You can work around this error by creating smaller reports: instead of one report covering a large time range, create multiple reports that cover segmented time ranges. | ||
| * Another workaround would be to 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 Elasticsearch directly. |
There was a problem hiding this comment.
I copied this text directly from the GH issue, so the word choices are probably not the best in its first draft.
There was a problem hiding this comment.
Thanks Tim! I've suggested a few changes for readability
|
|
||
| The thing to note about this type of error is that the deployment is stable, it's just the size of a requested report is too large to complete within the time allowed by the authentication token available to the Reporting task. | ||
|
|
||
| ==== Avoiding token expiration |
There was a problem hiding this comment.
I think this heading is causing the build to fail. I've changed the heading level to see if it works.
tsullivan
added
v8.15.0
v8.16.0
backport:version
Co-authored-by: wajihaparvez <[email protected]>
|
|
||
| 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. | ||
|
|
||
| === Avoiding token expiration |
There was a problem hiding this comment.
@wajihaparvez this section should be a sub-section of Token expiration. When I tried using ==== to give it a level-4 heading, I encountered an asciidoctor error of WARNING: user/reporting/reporting-csv-troubleshooting.asciidoc: line 97: section title out of sequence: expected level 3, got level 4. What needs to be done here?
There was a problem hiding this comment.
I think you need a [float] before this section. I'll add one and we can wait to see if that fixes the build error
There was a problem hiding this comment.
Thanks! That did fix the problem for me locally
There was a problem hiding this comment.
Looks like it worked!
Summary
Closes #201281
Closes #200653