doc: Add Metrics section to the user-guide
#18216
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
Jefffrey
approved these changes
Oct 22, 2025
|
|
||
| | Metric | Description | | ||
| | --------------- | ------------------------------------------------------ | | ||
| | elapsed_compute | CPU time the operator actively spends processing work. | |
There was a problem hiding this comment.
Is there a specific unit for this metric?
There was a problem hiding this comment.
Unit will be displayed like ...elapsed_compute=4.043955ms..., so I think we don't have to doc here
|
Also I guess having a metrics doc page should allow us to close #1578 as well; since we can easily search for this metrics page in documentation which then redirects us to explain analyze page in the introduction |
xudong963
reviewed
Oct 22, 2025
|
|
||
| ## Operator-specific Metrics | ||
|
|
||
| TODO |
There was a problem hiding this comment.
We may split it into small good first issues.
There was a problem hiding this comment.
I agree. I'll do an example PR and open issues.
xudong963
approved these changes
Oct 22, 2025
tobixdev
pushed a commit
to tobixdev/datafusion
that referenced
this pull request
Nov 2, 2025
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes apache#123` indicates that this PR will close issue apache#123. --> - Part of apache#16602 ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> Now we have to search in the code comment (or even implementation) to find the documentation of certain metrics, it would be better to open a page in the `user-guide` for metrics. The doc has to be manually updated, the metrics construction is scattered in the codebase, so it's hard to make it auto-generated. This PR only includes 2 common metrics, I plan to add more operator-specific metrics while working on apache#18116 ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
Now we have to search in the code comment (or even implementation) to find the documentation of certain metrics, it would be better to open a page in the
user-guidefor metrics.The doc has to be manually updated, the metrics construction is scattered in the codebase, so it's hard to make it auto-generated.
This PR only includes 2 common metrics, I plan to add more operator-specific metrics while working on #18116
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?