apache/pinot

Introduce reason codes in server http requests to controller

Open

#12,055 opened on Nov 28, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (1,234 forks)batch import
cleanupgood first issue

Repository metrics

Stars
 (4,937 stars)
PR merge metrics
 (Avg merge 6d 7h) (186 merged PRs in 30d)

Description

pinot servers send HTTP requests to the controller for posting a completed realtime segment, posting an indication that realtime segments have stopped consuming, or that the consumer could never be created.

Currently there is a reason string that is included as an argument. This is error prone. A reason code makes it easier to incorporate code for appropriate action, given a particular reason.

The con side of a reason code is that it is a bit harder to evolve. We need to be careful writing code on the controller side, since servers may send unknown reason codes. As long as we follow some careful practices, introducing reason codes should get us to a better place.

Contributor guide

Research direction
Examine the current implementation of HTTP requests from Pinot server to controller for realtime segment completion and identify where the reason string is used. Propose a reason code enum and adapt the controller to handle unknown codes gracefully.
Tech stack
java
Domain
backenddatabasedistributed systems
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
JavaHTTPDistributed Systems
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60