@grpc/grpc-js-xds
v1.12.0
Published
Plugin for @grpc/grpc-js. Adds the xds:// URL scheme and associated features.
Downloads
4,717
Keywords
Readme
@grpc/grpc-js xDS plugin
This package provides support for the xds://
URL scheme to the @grpc/grpc-js
library. The latest version of this package is compatible with @grpc/grpc-js
version 1.10.x.
Installation
npm install @grpc/grpc-js-xds
Usage
import * as grpcJsXds from '@grpc/grpc-js-xds';
grpcJsXds.register();
// ...get a @grpc/grpc-js Client class as usual
const client = new MyServiceClient('xds:///example.com:123');
Supported Features
- xDS-Based Global Load Balancing
- xDS traffic splitting and routing
- xDS v3 API
- xDS Timeouts
- xDS Circuit Breaking
- xDS Client-Side Fault Injection
- Client Status Discovery Service
- Outlier Detection
- xDS Retry Support
- xDS Aggregate and Logical DNS Clusters
- xDS Federation (Currently experimental, enabled by environment variable
GRPC_EXPERIMENTAL_XDS_FEDERATION
) - xDS Custom Load Balancer Configuration (Custom load balancer registration not currently supported)
- xDS Ring Hash LB Policy
pick_first
via xDS (Currently experimental, enabled by environment variableGRPC_EXPERIMENTAL_PICKFIRST_LB_CONFIG
)- xDS-Enabled Servers