Skip to content

Commit

Permalink
[Reporting/Docs] Add section to troubleshooting guide to explain the …
Browse files Browse the repository at this point in the history
…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
  • Loading branch information
tsullivan committed Jun 17, 2021
1 parent f019904 commit 745dcf5
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion docs/user/reporting/reporting-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 745dcf5

Please sign in to comment.