Link Search Menu Expand Document Documentation Menu
Documentation

gRPC APIs

Introduced 3.0

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.

The OpenSearch gRPC plugin provides an alternative, high-performance transport layer using gRPC for communication with OpenSearch. It uses protocol buffers over gRPC for lower overhead and faster serialization. This reduces overhead, speeds up serialization, and improves request-side latency, based on initial benchmarking results.

The primary goal of the gRPC plugin is to:

  • Offer a binary-encoded alternative to HTTP/REST-based communication.
  • Improve performance for bulk workloads and large-scale ingestion scenarios.
  • Enable more efficient client integrations across languages, like Java, Go, and Python, using native gRPC stubs.

Enabling the plugin

To enable the gRPC plugin (transport-grpc) in OpenSearch:

  1. Install the transport-grpc plugin. For more information, see Installing plugins.

  2. Add the following settings to opensearch.yml: 
     aux.transport.types: [experimental-transport-grpc]
 aux.transport.experimental-transport-grpc.port: '9400-9500' // optional

    Alternatively, configure a secure transport protocol using the following settings:

     aux.transport.types: [experimental-secure-transport-grpc]
 aux.transport.experimental-transport-grpc.port: '9400-9500' // optional

  3. Configure additional settings if needed (see Advanced gRPC settings): 
     grpc.host: localhost
 grpc.publish_host: 10.74.124.163
 grpc.bind_host: 0.0.0.0

Advanced gRPC settings

OpenSearch supports the following advanced network settings for gRPC communication:

  • grpc.host (Static, list): Sets the address of an OpenSearch node for gRPC communication. The grpc.host setting is a combination of grpc.bind_host and grpc.publish_host if they are the same value. An alternative to grpc.host is to configure grpc.bind_host and grpc.publish_host separately, as needed.

  • grpc.bind_host (Static, list): Specifies an address or addresses to which an OpenSearch node binds to listen for incoming gRPC connections.

  • grpc.publish_host (Static, list): Specifies an address or addresses that an OpenSearch node publishes to other nodes for gRPC communication.

These settings are similar to the HTTP Network settings.

Using gRPC APIs

To submit gRPC requests, you must have a set of protobufs on the client side. You can obtain the protobufs in the following ways:

Supported APIs

This feature is currently under development and supports the following APIs:

350 characters left

Have a question? .

Want to contribute? or .