From c49f3a82165fa55a1cf27b0a3372a0ee211c8928 Mon Sep 17 00:00:00 2001 From: Timothy Sullivan Date: Tue, 15 Jun 2021 15:42:08 -0700 Subject: [PATCH 1/3] [Reporting/Docs] Add section to troubleshooting guide to explain the StatusCodeError logs --- .../reporting-troubleshooting.asciidoc | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/user/reporting/reporting-troubleshooting.asciidoc b/docs/user/reporting/reporting-troubleshooting.asciidoc index 4305b39653f8dc..0a4df9b0bd3d7f 100644 --- a/docs/user/reporting/reporting-troubleshooting.asciidoc +++ b/docs/user/reporting/reporting-troubleshooting.asciidoc @@ -92,6 +92,31 @@ the first time Kibana starts when verbose logging is enabled. Whenever possible, a Reporting error message tries to be as self-explanatory as possible. Here are some error messages you might encounter, along with the solution. +[float] +==== `StatusCodeError: [version_conflict_engine_exception]` +If you are running multiple instances of Kibana in a cluster, they 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: + +``` +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: From fb9ff89b4d2198b80b816e24b956b46e29678945 Mon Sep 17 00:00:00 2001 From: Tim Sullivan Date: Wed, 16 Jun 2021 12:25:32 -0700 Subject: [PATCH 2/3] Update docs/user/reporting/reporting-troubleshooting.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> --- docs/user/reporting/reporting-troubleshooting.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/reporting/reporting-troubleshooting.asciidoc b/docs/user/reporting/reporting-troubleshooting.asciidoc index 0a4df9b0bd3d7f..a3cee8434078fb 100644 --- a/docs/user/reporting/reporting-troubleshooting.asciidoc +++ b/docs/user/reporting/reporting-troubleshooting.asciidoc @@ -94,7 +94,7 @@ along with the solution. [float] ==== `StatusCodeError: [version_conflict_engine_exception]` -If you are running multiple instances of Kibana in a cluster, they share the work of executing report jobs to evenly distribute +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 From 18e36d88217270a9a7b428d7be02e4fd2b683036 Mon Sep 17 00:00:00 2001 From: Timothy Sullivan Date: Wed, 16 Jun 2021 12:27:54 -0700 Subject: [PATCH 3/3] use script formatting around error message block --- docs/user/reporting/reporting-troubleshooting.asciidoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/user/reporting/reporting-troubleshooting.asciidoc b/docs/user/reporting/reporting-troubleshooting.asciidoc index a3cee8434078fb..d6d6190c8504b9 100644 --- a/docs/user/reporting/reporting-troubleshooting.asciidoc +++ b/docs/user/reporting/reporting-troubleshooting.asciidoc @@ -100,7 +100,8 @@ multiple instances to find the same job in these searches. Only the instance tha "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', @@ -113,8 +114,8 @@ StatusCodeError: [version_conflict_engine_exception] [...]: version conflict, re }, statusCode: 409 } +-------------------------------------------------------------------------------- -``` These messages alone don't indicate a problem. They show normal events that happen in a healthy system. [float]