Skip to content

[DOCS] Skip synced flush doc tests #49986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 9, 2019
Merged

[DOCS] Skip synced flush doc tests #49986

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions docs/reference/indices/synced-flush.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Performs a synced flush on one or more indices.
--------------------------------------------------
POST /twitter/_flush/synced
--------------------------------------------------
// TEST[setup:twitter]
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]


[[synced-flush-api-request]]
Expand Down Expand Up @@ -80,7 +80,7 @@ section of the shard stats returned by the <<indices-stats,indices stats>> API:
--------------------------------------------------
GET /twitter/_stats?filter_path=**.commit&level=shards <1>
--------------------------------------------------
// TEST[s/^/PUT twitter\nPOST twitter\/_flush\/synced\n/]
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]

<1> `filter_path` is used to reduce the verbosity of the response, but is entirely optional

Expand Down Expand Up @@ -116,10 +116,7 @@ The API returns the following response:
}
}
--------------------------------------------------
// TESTRESPONSE[s/"id" : "3M3zkw2GHMo2Y4h4\/KFKCg=="/"id": $body.indices.twitter.shards.0.0.commit.id/]
// TESTRESPONSE[s/"translog_uuid" : "hnOG3xFcTDeoI_kvvvOdNA"/"translog_uuid": $body.indices.twitter.shards.0.0.commit.user_data.translog_uuid/]
// TESTRESPONSE[s/"history_uuid" : "XP7KDJGiS1a2fHYiFL5TXQ"/"history_uuid": $body.indices.twitter.shards.0.0.commit.user_data.history_uuid/]
// TESTRESPONSE[s/"sync_id" : "AVvFY-071siAOuFGEO9P"/"sync_id": $body.indices.twitter.shards.0.0.commit.user_data.sync_id/]
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]
<1> the `sync id` marker

NOTE: The `sync_id` marker is removed as soon as the shard is flushed again, and
Expand Down Expand Up @@ -172,7 +169,7 @@ A replica shard failed to sync-flush.
----
POST /kimchy/_flush/synced
----
// TEST[s/^/PUT kimchy\n/]
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]


[[synced-flush-api-multi-ex]]
Expand All @@ -182,8 +179,7 @@ POST /kimchy/_flush/synced
--------------------------------------------------
POST /kimchy,elasticsearch/_flush/synced
--------------------------------------------------
// TEST[s/^/PUT elasticsearch\n/]
// TEST[continued]
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]


[[synced-flush-api-all-ex]]
Expand All @@ -193,7 +189,7 @@ POST /kimchy,elasticsearch/_flush/synced
--------------------------------------------------
POST /_flush/synced
--------------------------------------------------
// TEST[setup:twitter]
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]

The response contains details about how many shards were successfully
sync-flushed and information about any failure.
Expand All @@ -217,12 +213,12 @@ successfully sync-flushed:
}
}
--------------------------------------------------
// TESTRESPONSE[s/"successful": 2/"successful": 1/]
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]

The following response indicates one shard group failed
due to pending operations:

[source,js]
[source,console-result]
--------------------------------------------------
{
"_shards": {
Expand All @@ -243,13 +239,13 @@ due to pending operations:
}
}
--------------------------------------------------
// NOTCONSOLE
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]

Sometimes the failures are specific to a shard replica. The copies that failed
will not be eligible for fast recovery but those that succeeded still will be.
This case is reported as follows:

[source,js]
[source,console-result]
--------------------------------------------------
{
"_shards": {
Expand Down Expand Up @@ -278,4 +274,4 @@ This case is reported as follows:
}
}
--------------------------------------------------
// NOTCONSOLE
// TEST[skip: Synced flush can conflict with scheduled flushes in doc tests]