OpenSearch/client/client-benchmark-noop-api-plugin/README.md

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