livepeer/go-livepeer

Register gRPC health check server when running gRPC server as an O

Open

#2,076 opened on Oct 28, 2021

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Go (223 forks)auto 404
area: orchestrator QoLgood first issuetype: feature

Repository metrics

Stars
 (583 stars)
PR merge metrics
 (PR metrics pending)

Description

At the moment, the easiest way to run a health check for an O is to query the CLI server that O starts i.e. curl localhost:7935/status. However, this just tells us if the CLI server is up. It'd be nice to have a health check that can tell us if the gRPC server for the O is up as well. This can be done using gRPC health checking. We just need to register the health server with the gRPC server as an O. Then, you could use a gRPC health probe to check on the health of the gRPC server.

See this example of registering the health server for livepeer_router.

Contributor guide

Research direction
Inspect the existing health check registration in server/router.go (https://github.com/livepeer/go livepeer/blob/f59cbd572c428a6d259d462f55eb758dffccec92/server/router.go#L53) and follow the same pattern to register a gRPC health server for the O's gRPC server. Then, test using a gRPC health probe.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GogRPCGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75