prestodb/presto

Add developer documentation for adding new RuntimeStats

Open

#21514 opened on Dec 11, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (15,558 stars) (5,240 forks)batch import
docsfeature requestgood first issue

Description

RuntimeStats were added in 2021 as a way to quickly add new stats to the Presto codebase. It is currently only documented in this GDoc, which is not linked anywhere from the Presto documentation or our getting started guides. We should add this information to the developer documentation so that more people add RuntimeStats and to canonicalize this information.

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RuntimeStats conceptJavaPresto contribution guidelines
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the linked Google Doc to understand the RuntimeStats implementation and existing patterns. Locate the Presto developer documentation directory and determine where to add the new section. Ensure the documentation follows the project's style and format, and consider cross referencing from the getting started guides.