graphprotocol / graphprotocol/indexer

[FEATURE] healthy endpoint

Open
#1,030 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
262
Forks
148
PR merge metrics
No merged PRs in 30d

Description

When some pod has an issue to connect to the database or any other dependent service, it's still healthy for the loadbalancer which send traffic to it increasing the errors for the customers.

In order to reduce or completely remove the errors during these connection issues I'd like to propose to add a /healtz (yes it's written healthz instead of health to avoid overlapping with any other similar endpoint for the application and it's a common usage to name this one like that for the kubernetes) which will tell the loadbalancer that the pod is not healthy and to stop sending traffic to it. This endpoint will also help kubelet in kubernetes (or any other automated process) to restart that unhealthy pod before it's becoming critical to the whole system.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests; start by locating the service's HTTP entry point and checking how database and other dependent-service failures are represented. Determine which dependency failures should make /healthz report the pod as unhealthy for load-balancer and kubelet checks. Done means the endpoint is available and its healthy and failing cases are covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, typescript
Domain
api, backend, infrastructure
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.