File: README.md

package info (click to toggle)
opensearch 2.4.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 109,808 kB
  • sloc: java: 1,199,376; sh: 963; xml: 379; python: 73; perl: 66; makefile: 11
file content (23 lines) | stat: -rw-r--r-- 1,014 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
### 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

Build the plugin with `gradle :client:client-benchmark-noop-api-plugin:assemble` from the OpenSearch root project directory.

### Installation Instructions

After, the binary has been built, install it with `bin/opensearch-plugin install file:///full/path/to/noop-plugin.zip`.

### 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:

* `org.opensearch.plugin.noop.action.bulk.TransportNoopBulkAction`
* `org.opensearch.plugin.noop.action.search.TransportNoopSearchAction`