2016-08-26 03:05:47 -04:00
### Purpose
This plugin provides empty REST and transport endpoints for bulk indexing and search. It is used to avoid accidental server-side bottlenecks in client-side benchmarking.
### Build Instructions
2021-03-20 03:26:48 -04:00
Build the plugin with `gradle :client:client-benchmark-noop-api-plugin:assemble` from the OpenSearch root project directory.
2016-08-26 03:05:47 -04:00
### Installation Instructions
2021-03-12 13:54:30 -05:00
After, the binary has been built, install it with `bin/opensearch-plugin install file:///full/path/to/noop-plugin.zip` .
2016-08-26 03:05:47 -04:00
### Usage
The plugin provides two REST endpoints:
* `/_noop_bulk` and all variations that the bulk endpoint provides (except that all no op endpoints are called `_noop_bulk` instead of `_bulk` )
* `_noop_search` and all variations that the search endpoint provides (except that all no op endpoints are called `_noop_search` instead of `_search` )
The corresponding transport actions are:
2021-03-12 13:54:30 -05:00
* `org.opensearch.plugin.noop.action.bulk.TransportNoopBulkAction`
* `org.opensearch.plugin.noop.action.search.TransportNoopSearchAction`
