client.health.isHealthy() needs documentation on how to use and would expect this to have retries
- Dominant language
- JavaScript
- Stars
- 217
- Forks
- 104
- PR merge metrics
- No merged PRs in 30d
Description
The SDKs have sidecar health status APIs
- Python is here https://v1-13.docs.dapr.io/developing-applications/sdks/python/python-client/#health-timeout (this an upmerge for current docs)
- Java is here https://v1-13.docs.dapr.io/developing-applications/sdks/java/java-client/#wait-for-sidecar
- .NET here https://v1-13.docs.dapr.io/developing-applications/sdks/dotnet/dotnet-client/#wait-for-sidecar
Note: It would be great if the SDK maintainers could agree on names for API
## Expected Behavior
1) The `client.health.isHealthy() has no documentation on how to use this API. Add to the docs here https://v1-13.docs.dapr.io/developing-applications/sdks/js/js-client/
2) There are no retries on this API as far as I can tell, which does not make it useful. I would either have the Python approach which hides the API on client start (it checks for health) or have a retry like Java and .NET
3) Also this does not see to check the healthx/outbound endpoint, instead does something different on the metadata endpoint. This should be consistent with the other APIs, including ideally in the name.
## Actual Behavior
1) No docs
2)No retries to API
3) Different impl from other SDKs
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.