forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Currently, Opensearch returns a 200 OK response code for a Bulk API call, even though there can be partial/complete failures within the request E2E. Tracking these failures requires client to parse the response on their side and make sense of them. But, a general idea around trend in growth of different rest status codes at item level can provide insights on how indexing engine is performing. Signed-off-by: Rohit Ashiwal <rashiwal@amazon.com>
- Loading branch information
Showing
16 changed files
with
823 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
275 changes: 275 additions & 0 deletions
275
server/src/internalClusterTest/java/org/opensearch/nodestats/NodeStatsIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,275 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.nodestats; | ||
|
|
||
| import org.opensearch.ExceptionsHelper; | ||
| import org.opensearch.action.DocWriteResponse; | ||
| import org.opensearch.action.bulk.BulkItemResponse; | ||
| import org.opensearch.action.bulk.BulkRequest; | ||
| import org.opensearch.action.bulk.BulkResponse; | ||
| import org.opensearch.action.delete.DeleteRequest; | ||
| import org.opensearch.action.delete.DeleteResponse; | ||
| import org.opensearch.action.index.IndexRequest; | ||
| import org.opensearch.action.index.IndexResponse; | ||
| import org.opensearch.action.update.UpdateRequest; | ||
| import org.opensearch.action.update.UpdateResponse; | ||
| import org.opensearch.index.IndexNotFoundException; | ||
| import org.opensearch.index.engine.DocumentMissingException; | ||
| import org.opensearch.index.engine.VersionConflictEngineException; | ||
| import org.opensearch.index.shard.IndexingStats.Stats.DocStatusStats; | ||
| import org.opensearch.test.OpenSearchIntegTestCase; | ||
| import org.opensearch.test.OpenSearchIntegTestCase.ClusterScope; | ||
| import org.opensearch.test.OpenSearchIntegTestCase.Scope; | ||
| import org.hamcrest.MatcherAssert; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import static java.util.Collections.singletonMap; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
| import static org.hamcrest.Matchers.greaterThanOrEqualTo; | ||
|
|
||
| @ClusterScope(scope = Scope.SUITE, numDataNodes = 1, numClientNodes = 0, supportsDedicatedMasters = false) | ||
| public class NodeStatsIT extends OpenSearchIntegTestCase { | ||
|
|
||
| private static final DocStatusStats expectedDocStatusStats = new DocStatusStats(); | ||
| private static final String FIELD = "dummy_field"; | ||
| private static final String VALUE = "dummy_value"; | ||
| private static final Map<String, Object> SOURCE = singletonMap(FIELD, VALUE); | ||
|
|
||
| public void testNodeIndicesStatsDocStatusStatsBulk() { | ||
| final String INDEX = "bulk_index"; | ||
|
|
||
| int sizeOfIndexRequests = scaledRandomIntBetween(10, 20); | ||
| int sizeOfDeleteRequests = scaledRandomIntBetween(5, sizeOfIndexRequests); | ||
| int sizeOfNotFoundRequests = scaledRandomIntBetween(5, sizeOfIndexRequests); | ||
|
|
||
| BulkRequest bulkRequest = new BulkRequest(); | ||
|
|
||
| for (int i = 0; i < sizeOfIndexRequests; ++i) { | ||
| bulkRequest.add(new IndexRequest(INDEX).id(String.valueOf(i)).source(SOURCE)); | ||
| } | ||
|
|
||
| BulkResponse response = client().bulk(bulkRequest).actionGet(); | ||
|
|
||
| MatcherAssert.assertThat(response.hasFailures(), equalTo(false)); | ||
| MatcherAssert.assertThat(response.getItems().length, equalTo(sizeOfIndexRequests)); | ||
|
|
||
| for (BulkItemResponse itemResponse : response.getItems()) { | ||
| updateExpectedDocStatusCounter(itemResponse.getResponse()); | ||
| } | ||
|
|
||
| refresh(INDEX); | ||
| bulkRequest.requests().clear(); | ||
|
|
||
| for (int i = 0; i < sizeOfDeleteRequests; ++i) { | ||
| bulkRequest.add(new DeleteRequest(INDEX, String.valueOf(i))); | ||
| } | ||
| for (int i = 0; i < sizeOfNotFoundRequests; ++i) { | ||
| bulkRequest.add(new DeleteRequest(INDEX, String.valueOf(25 + i))); | ||
| } | ||
|
|
||
| response = client().bulk(bulkRequest).actionGet(); | ||
|
|
||
| MatcherAssert.assertThat(response.hasFailures(), equalTo(false)); | ||
| MatcherAssert.assertThat(response.getItems().length, equalTo(sizeOfDeleteRequests + sizeOfNotFoundRequests)); | ||
|
|
||
| for (BulkItemResponse itemResponse : response.getItems()) { | ||
| updateExpectedDocStatusCounter(itemResponse.getResponse()); | ||
| } | ||
|
|
||
| refresh(INDEX); | ||
| assertDocStatusStats(); | ||
| } | ||
|
|
||
| public void testNodeIndicesStatsDocStatusStatsIndex() { | ||
| final String INDEX = "test_index"; | ||
| final String ID = "id"; | ||
| { | ||
| // Testing Normal Index | ||
| IndexResponse response = client().index(new IndexRequest(INDEX).id(ID).source(SOURCE)).actionGet(); | ||
| updateExpectedDocStatusCounter(response); | ||
|
|
||
| MatcherAssert.assertThat(response.getResult(), equalTo(DocWriteResponse.Result.CREATED)); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Missing Alias | ||
| updateExpectedDocStatusCounter( | ||
| expectThrows( | ||
| IndexNotFoundException.class, | ||
| () -> client().index(new IndexRequest(INDEX).id("missing_alias").setRequireAlias(true).source(SOURCE)).actionGet() | ||
| ) | ||
| ); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Test Missing Pipeline: Ingestion failure, not Indexing failure | ||
| expectThrows( | ||
| IllegalArgumentException.class, | ||
| () -> client().index(new IndexRequest(INDEX).id("missing_pipeline").setPipeline("missing").source(SOURCE)).actionGet() | ||
| ); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Version Conflict | ||
| final String docId = "version_conflict"; | ||
|
|
||
| updateExpectedDocStatusCounter(client().index(new IndexRequest(INDEX).id(docId).source(SOURCE)).actionGet()); | ||
| updateExpectedDocStatusCounter( | ||
| expectThrows( | ||
| VersionConflictEngineException.class, | ||
| () -> client().index(new IndexRequest(INDEX).id(docId).source(SOURCE).setIfSeqNo(1L).setIfPrimaryTerm(99L)).actionGet() | ||
| ) | ||
| ); | ||
| assertDocStatusStats(); | ||
| } | ||
| } | ||
|
|
||
| public void testNodeIndicesStatsDocStatusStatsCreate() { | ||
| final String INDEX = "create_index"; | ||
| final String ID = "id"; | ||
| { | ||
| // Testing Creation | ||
| IndexResponse response = client().index(new IndexRequest(INDEX).id(ID).source(SOURCE).create(true)).actionGet(); | ||
| updateExpectedDocStatusCounter(response); | ||
|
|
||
| MatcherAssert.assertThat(response.getResult(), equalTo(DocWriteResponse.Result.CREATED)); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Version Conflict | ||
| final String docId = "version_conflict"; | ||
|
|
||
| updateExpectedDocStatusCounter(client().index(new IndexRequest(INDEX).id(docId).source(SOURCE)).actionGet()); | ||
| updateExpectedDocStatusCounter( | ||
| expectThrows( | ||
| VersionConflictEngineException.class, | ||
| () -> client().index(new IndexRequest(INDEX).id(docId).source(SOURCE).create(true)).actionGet() | ||
| ) | ||
| ); | ||
| assertDocStatusStats(); | ||
| } | ||
| } | ||
|
|
||
| public void testNodeIndicesStatsDocStatusStatsDelete() { | ||
| final String INDEX = "delete_index"; | ||
| final String ID = "id"; | ||
| { | ||
| // Testing Deletion | ||
| IndexResponse response = client().index(new IndexRequest(INDEX).id(ID).source(SOURCE)).actionGet(); | ||
| updateExpectedDocStatusCounter(response); | ||
|
|
||
| DeleteResponse deleteResponse = client().delete(new DeleteRequest(INDEX, ID)).actionGet(); | ||
| updateExpectedDocStatusCounter(deleteResponse); | ||
|
|
||
| MatcherAssert.assertThat(response.getSeqNo(), greaterThanOrEqualTo(0L)); | ||
| MatcherAssert.assertThat(deleteResponse.getResult(), equalTo(DocWriteResponse.Result.DELETED)); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Non-Existing Doc | ||
| updateExpectedDocStatusCounter(client().delete(new DeleteRequest(INDEX, "does_not_exist")).actionGet()); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Version Conflict | ||
| final String docId = "version_conflict"; | ||
|
|
||
| updateExpectedDocStatusCounter(client().index(new IndexRequest(INDEX).id(docId).source(SOURCE)).actionGet()); | ||
| updateExpectedDocStatusCounter( | ||
| expectThrows( | ||
| VersionConflictEngineException.class, | ||
| () -> client().delete(new DeleteRequest(INDEX, docId).setIfSeqNo(2L).setIfPrimaryTerm(99L)).actionGet() | ||
| ) | ||
| ); | ||
|
|
||
| assertDocStatusStats(); | ||
| } | ||
| } | ||
|
|
||
| public void testNodeIndicesStatsDocStatusStatsUpdate() { | ||
| final String INDEX = "update_index"; | ||
| final String ID = "id"; | ||
| { | ||
| // Testing Not Found | ||
| updateExpectedDocStatusCounter( | ||
| expectThrows(DocumentMissingException.class, () -> client().update(new UpdateRequest(INDEX, ID).doc(SOURCE)).actionGet()) | ||
| ); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing NoOp Update | ||
| updateExpectedDocStatusCounter(client().index(new IndexRequest(INDEX).id(ID).source(SOURCE)).actionGet()); | ||
|
|
||
| UpdateResponse response = client().update(new UpdateRequest(INDEX, ID).doc(SOURCE)).actionGet(); | ||
| updateExpectedDocStatusCounter(response); | ||
|
|
||
| MatcherAssert.assertThat(response.getResult(), equalTo(DocWriteResponse.Result.NOOP)); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Update | ||
| final String UPDATED_VALUE = "updated_value"; | ||
| UpdateResponse response = client().update(new UpdateRequest(INDEX, ID).doc(singletonMap(FIELD, UPDATED_VALUE))).actionGet(); | ||
| updateExpectedDocStatusCounter(response); | ||
|
|
||
| MatcherAssert.assertThat(response.getResult(), equalTo(DocWriteResponse.Result.UPDATED)); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Missing Alias | ||
| updateExpectedDocStatusCounter( | ||
| expectThrows( | ||
| IndexNotFoundException.class, | ||
| () -> client().update(new UpdateRequest(INDEX, ID).setRequireAlias(true).doc(new IndexRequest().source(SOURCE))) | ||
| .actionGet() | ||
| ) | ||
| ); | ||
| assertDocStatusStats(); | ||
| } | ||
| { | ||
| // Testing Version Conflict | ||
| final String docId = "version_conflict"; | ||
|
|
||
| updateExpectedDocStatusCounter(client().index(new IndexRequest(INDEX).id(docId).source(SOURCE)).actionGet()); | ||
| updateExpectedDocStatusCounter( | ||
| expectThrows( | ||
| VersionConflictEngineException.class, | ||
| () -> client().update(new UpdateRequest(INDEX, docId).doc(SOURCE).setIfSeqNo(2L).setIfPrimaryTerm(99L)).actionGet() | ||
| ) | ||
| ); | ||
| assertDocStatusStats(); | ||
| } | ||
| } | ||
|
|
||
| private void assertDocStatusStats() { | ||
| DocStatusStats docStatusStats = client().admin() | ||
| .cluster() | ||
| .prepareNodesStats() | ||
| .execute() | ||
| .actionGet() | ||
| .getNodes() | ||
| .get(0) | ||
| .getIndices() | ||
| .getIndexing() | ||
| .getTotal() | ||
| .getDocStatusStats(); | ||
|
|
||
| MatcherAssert.assertThat(docStatusStats, equalTo(expectedDocStatusStats)); | ||
| } | ||
|
|
||
| private void updateExpectedDocStatusCounter(DocWriteResponse r) { | ||
| expectedDocStatusStats.inc(r.status()); | ||
| } | ||
|
|
||
| private void updateExpectedDocStatusCounter(Exception e) { | ||
| expectedDocStatusStats.inc(ExceptionsHelper.status(e)); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.