[Reporting/Docs] Add section to troubleshooting guide to explain the StatusCodeError logs (#102278) (#102423)

* [Reporting/Docs] Add section to troubleshooting guide to explain the StatusCodeError logs

* Update docs/user/reporting/reporting-troubleshooting.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* use script formatting around error message block

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
# Conflicts:
#	docs/user/reporting/reporting-troubleshooting.asciidoc
This commit is contained in:
Tim Sullivan 2021-06-16 17:47:26 -07:00 committed by GitHub
parent f019904766
commit 745dcf50f7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -73,7 +73,33 @@ Whenever possible, a Reporting error message tries to be as self-explanatory as
along with the solution.
[float]
==== "Max attempts reached"
==== `StatusCodeError: [version_conflict_engine_exception]`
If you are running multiple instances of {kib} in a cluster, the instances share the work of executing report jobs to evenly distribute
the work load. Each instance searches the reporting index for "pending" jobs that the user has requested. It is possible for
multiple instances to find the same job in these searches. Only the instance that successfully updated the job status to
"processing" will actually execute the report job. The other instances that unsuccessfully tried to make the same update will log
something similar to this:
[source]
--------------------------------------------------------------------------------
StatusCodeError: [version_conflict_engine_exception] [...]: version conflict, required seqNo [6124], primary term [1]. current document has seqNo [6125] and primary term [1], with { ... }
status: 409,
displayName: 'Conflict',
path: '/.reporting-...',
body: {
error: {
type: 'version_conflict_engine_exception',
reason: '[...]: version conflict, required seqNo [6124], primary term [1]. current document has seqNo [6125] and primary term [1]',
},
},
statusCode: 409
}
--------------------------------------------------------------------------------
These messages alone don't indicate a problem. They show normal events that happen in a healthy system.
[float]
==== Max attempts reached
There are two primary causes of this error:
. You're creating a PDF of a visualization or dashboard that spans a large amount of data and Kibana is hitting the `xpack.reporting.queue.timeout`