Skip to content

docs(native): Add runtime metrics documentation#27109

Merged
steveburnett merged 22 commits intoprestodb:masterfrom
garimauttam:docs/add-runtime-metrics-documentation
Feb 12, 2026
Merged

docs(native): Add runtime metrics documentation#27109
steveburnett merged 22 commits intoprestodb:masterfrom
garimauttam:docs/add-runtime-metrics-documentation

Conversation

@garimauttam
Copy link
Copy Markdown
Contributor

@garimauttam garimauttam commented Feb 9, 2026

Description

Adds comprehensive documentation for presto_cpp.worker_runtime_uptime_secs and all other undocumented runtime metrics.

Related Issue

Resolves #27007

Changes

  • Created new presto_cpp/metrics.rst documenting 60+ runtime metrics
  • Updated presto-cpp.rst to include metrics in table of contents
  • Updated features.rst to reference the comprehensive metrics docs
  • Organized metrics into categories (executor, HTTP, task, driver, OS, etc.)

Testing

  • Built documentation successfully with ./build
  • Verified all cross-references work correctly
  • Reviewed generated HTML output

Checklist

Summary by Sourcery

Document native runtime metrics for Presto C++ and integrate the new metrics reference into the existing documentation structure.

Documentation:

  • Add a new presto_cpp/metrics.rst page providing comprehensive documentation for Presto C++ runtime metrics, including uptime and other counters.
  • Update presto-cpp.rst to surface the new metrics documentation in the table of contents.
  • Update presto_cpp/features.rst to reference the consolidated runtime metrics documentation.

== NO RELEASE NOTE ==

Document presto_cpp.worker_runtime_uptime_secs and 60+ other
undocumented runtime metrics from Counters.h.

Resolves: #27007
@garimauttam garimauttam requested review from a team, elharo and steveburnett as code owners February 9, 2026 07:56
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Feb 9, 2026

🧙 Sourcery has finished reviewing your pull request!


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla bot commented Feb 9, 2026

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all of this! Just a nit of phrasing.

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to 🏗 In progress in Presto Documentation Feb 9, 2026
Copy link
Copy Markdown
Contributor Author

@garimauttam garimauttam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved comment.

Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! (docs)

Pull updated branch, new local doc build, looks good. Thanks!

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Presto Documentation Feb 9, 2026
@garimauttam
Copy link
Copy Markdown
Contributor Author

Thanks for the review!
The maven-checks failure seems unrelated to this change and likely due to recent master updates. I’ll re-run CI and update.

@github-actions github-actions bot removed the docs label Feb 10, 2026
@aditi-pandit
Copy link
Copy Markdown
Contributor

Thanks @garimauttam for this code.

There are several conflicts between this code and #26875 that was submit recently. Please can you rebase to help us continue the review more effectively.

@agrawalreetika

@garimauttam
Copy link
Copy Markdown
Contributor Author

Sure will rebase it.
Thanks

@garimauttam garimauttam reopened this Feb 11, 2026
@github-project-automation github-project-automation bot moved this from ✅ Done to 🆕 Unprioritized in Presto Documentation Feb 11, 2026
@github-actions github-actions bot added the docs label Feb 11, 2026
Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed a formatting nit throughout. Please address this when you can.

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to 🏗 In progress in Presto Documentation Feb 11, 2026
@garimauttam garimauttam force-pushed the docs/add-runtime-metrics-documentation branch from 9c432a7 to 1606534 Compare February 12, 2026 04:59
Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! (docs)

Pull updated branch, new local doc build, looks good. Thanks for the update!

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Presto Documentation Feb 12, 2026
@steveburnett steveburnett merged commit 223b0da into prestodb:master Feb 12, 2026
78 of 79 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

fix (docs): Add documentation for runtime metrics

3 participants