Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add more spans to mito engine #4643

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Conversation

lyang24
Copy link
Collaborator

@lyang24 lyang24 commented Aug 29, 2024

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

#4480

What's changed and what's your intention?

This commit adds more spans into mito engine to give better insights on debugging slow queires.
For reads i enhanced spans on reader building time.

!!! DO NOT LEAVE THIS BLOCK EMPTY !!!

Please explain IN DETAIL what the changes are in this PR and why they are needed:

  • Summarize your change (mandatory)
  • How does this PR work? Need a brief introduction for the changed logic (optional)
  • Describe clearly one logical change and avoid lazy messages (optional)
  • Describe any limitations of the current code (optional)

Checklist

  • I have written the necessary rustdoc comments.
  • I have added the necessary unit tests and integration tests.
  • This PR requires documentation updates.

Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Aug 29, 2024
@lyang24 lyang24 force-pushed the mito_traces branch 2 times, most recently from 1131694 to f39529f Compare August 29, 2024 21:42
@lyang24 lyang24 changed the title feat: add more span on mito engine feat: add more spans to mito engine Aug 30, 2024
@lyang24 lyang24 marked this pull request as ready for review September 3, 2024 01:04
Copy link

codecov bot commented Sep 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.52%. Comparing base (5e4bac2) to head (da26259).
Report is 25 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4643      +/-   ##
==========================================
- Coverage   84.90%   84.52%   -0.39%     
==========================================
  Files        1105     1109       +4     
  Lines      198907   199499     +592     
==========================================
- Hits       168884   168621     -263     
- Misses      30023    30878     +855     

@WenyXu
Copy link
Member

WenyXu commented Sep 4, 2024

How about setting the tracing level to Debug? i.e., #[instrument(level = Level::DEBUG, ...)]

@lyang24
Copy link
Collaborator Author

lyang24 commented Sep 4, 2024

How about setting the tracing level to Debug? i.e., #[instrument(level = Level::DEBUG, ...)]

done

@WenyXu WenyXu requested a review from discord9 September 5, 2024 03:42
@discord9
Copy link
Contributor

discord9 commented Sep 5, 2024

Calls that occur very frequently and are typically not time-consuming, such as write_to_wal or next_batch, can be set to a tracing level of TRACE to avoid excessive verbosity during debug mode, or those traces could be completely removed to prevent pref regression(Removing might be unnecessary since tracing is essentially a comparison to an integer when not enabled, and branch prediction could minimize the time cost significantly, might only see 0.5%~1% regression in speed)

@lyang24
Copy link
Collaborator Author

lyang24 commented Sep 5, 2024

Calls that occur very frequently and are typically not time-consuming, such as write_to_wal or next_batch, can be set to a tracing level of TRACE to avoid excessive verbosity during debug mode, or those traces could be completely removed to prevent pref regression(Removing might be unnecessary since tracing is essentially a comparison to an integer when not enabled, and branch prediction could minimize the time cost significantly, might only see 0.5%~1% regression in speed)

thanks for the feedback i agree that adding spans on frequently called methods might not be very helpful and it could be verbose and leads to potential perf regression so i removed them. Please also let me know if there are places in mito2 engine that should be traced that i missed in this pr.

@WenyXu WenyXu added this pull request to the merge queue Sep 5, 2024
Merged via the queue into GreptimeTeam:main with commit 86cef64 Sep 5, 2024
32 checks passed
CookiePieWw pushed a commit to CookiePieWw/greptimedb that referenced this pull request Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants