Registry / devops / grpc-web-health-probe

grpc-web-health-probe

library1.0.4jsnpmunverified

Command-line tool for checking gRPC health of services via gRPC-Web protocol. Version 1.0.4 mimics the gRPC health probe protocol but works over HTTP/1.1 with gRPC-Web clients. Useful for Kubernetes liveness/readiness probes when standard gRPC health checks cannot be used due to gRPC-Web limitations. Single-purpose, no dependencies.

devops

npm install grpc-web-health-probe

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GRPC-WEB-HEALTH-PR

grpc-web-health-probe

devopsjavascriptv1.0.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Install globally and probe a gRPC-Web endpoint.

npm -g i grpc-web-health-probe grpc-web-health-probe --addr http://localhost:50051 # output: status: SERVING

Debug

Known issues

gotchaRequires the gRPC-Web server to support the health/v1 service (grpc.health.v1.Health/Check).

fix

Ensure target server implements the standard gRPC health proto and exposes it via gRPC-Web.

affects: >=0.0.0

gotchaOnly supports HTTP/1.1 + gRPC-Web. Not compatible with native gRPC (HTTP/2). Use standard grpc-health-probe for native gRPC.

fix

For native gRPC, use the official grpc-health-probe tool.

affects: >=0.0.0

gotchaCannot be used as a library; only CLI tool via global install.

fix

Use child_process.exec or similar to invoke the binary.

affects: >=0.0.0

gotchaOutput format is fixed 'status: SERVING/NOT_SERVING' — cannot be customized.

fix

Parse stdout programmatically if needed.

affects: >=0.0.0

gotchaOnly supports the Check RPC (unary), not the Watch RPC (server streaming).

fix

No workaround for Watch; implement custom streaming health check if required.

affects: >=0.0.0

Errors

Common errors & fixes

gRPC web health check failed: HTTP status 404

The server does not expose the health service or gRPC-Web is not configured.

fix

Ensure the server has a gRPC-Web proxy (e.g., Envoy) configured and health service is registered.

Error: connect ECONNREFUSED 127.0.0.1:50051

No server listening at the given address/port.

fix

Start the gRPC server and proxy before probing.

status: NOT_SERVING

The health service reports the service as not healthy.

fix

Check the server's health implementation (e.g., database connection, dependencies).

Upgrade

Version history

1.0.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/KamikazeZirou/grpc-web-health-probe ↗

packagegrpc-web-health-probe ↗

homepagehttps://github.com/KamikazeZirou/grpc-web-health-probe#readme ↗