apache/pinot

Documentation/tool improvements

Open

#5,588 opened on Jun 18, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1,234 forks)batch import
good first issuehelp wanted

Repository metrics

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

Description

  • Document the Realtime provisioning helper better.
  • Include the arguments, assumptions (be it default or deductions from table config) in the output of the tool. For example, if we assume that this is a hybrid table (table-config indicates daily push) then print that out.
  • Clarify that the tool is estimating resident memory, not mapped memory. If possible, estimate mapped memory and print that out as well.
  • Change offheap allocation for consuming segments to be mmap by default (need to evaluate whether this is a good default for all use cases)

Contributor guide

Research direction
Examine the Realtime provisioning helper tool's source code and documentation, identify current behavior for offheap allocation and output messages, and propose changes to improve clarity and default settings.
Tech stack
java
Domain
backenddatabase
Issue type
Documentation
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.
Mostly clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60