Skip to content

Confusing health checking docs and samples #1409

@ziriax

Description

@ziriax

I noticed that the documentation about health checking and the samples given here:

https://grpc.io/docs/guides/health-checking/

are not in sync, the samples use explicit health checking code, while the docs explain that the client can configure this using just the channel JSON options.

I made the following repository to confirm this:

https://github.com/ziriax/grpc-healthy-ping-pong

Waiting for a channel to be ready, and health checking all seem to be integrated in the framework, no extra code needs to be written, besides the JSON config?

I noticed that most public code is doing it like the samples are doing, and also GPT O3 is trained incorrectly at the time of writing, using explicit code.

It would be nice to update the samples to show both the explicit code, and the JSON channel configuration one, which is more declarative and modern?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions