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 StatementStatistics for slow query logging implementation #4719

Merged
merged 8 commits into from
Sep 30, 2024

Conversation

zyy17
Copy link
Collaborator

@zyy17 zyy17 commented Sep 10, 2024

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Resolve #4450

The PR introduces the new struct StatementStatistics for implementing statistics of query statements. For now, it's used for slow query logging.

Checklist

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

@zyy17 zyy17 requested a review from a team as a code owner September 10, 2024 13:19
Copy link
Contributor

coderabbitai bot commented Sep 10, 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 Sep 10, 2024
@zyy17 zyy17 force-pushed the feat/slow-query-logs branch 4 times, most recently from b6c5e14 to b5a69c9 Compare September 11, 2024 10:38
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

Attention: Patch coverage is 26.43678% with 64 lines in your changes missing coverage. Please review.

Project coverage is 84.18%. Comparing base (50cb595) to head (f858d75).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4719      +/-   ##
==========================================
- Coverage   84.46%   84.18%   -0.28%     
==========================================
  Files        1118     1120       +2     
  Lines      203127   203454     +327     
==========================================
- Hits       171577   171285     -292     
- Misses      31550    32169     +619     

@zyy17 zyy17 requested review from sunng87, MichaelScofield, evenyag and waynexia and removed request for a team September 11, 2024 11:03
@zyy17 zyy17 changed the title feat: add slow query logs feat: add slow query logs for SQL Sep 11, 2024
@zyy17 zyy17 changed the title feat: add slow query logs for SQL feat: add slow query logs Sep 11, 2024
@zyy17 zyy17 changed the title feat: add slow query logs feat: add slow query logs for SQL Sep 11, 2024
@sunng87
Copy link
Member

sunng87 commented Sep 11, 2024

Is there any chance we can put this at instance level, say SqlQueryHandler and PrometheusHandler? so we don't need to configure it for each protocol.

@zyy17
Copy link
Collaborator Author

zyy17 commented Sep 12, 2024

Is there any chance we can put this at instance level, say SqlQueryHandler and PrometheusHandler? so we don't need to configure it for each protocol.

Good idea. Let me try to do that.

Copy link
Contributor

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

Good job! Another suggestion is that maybe we can record all the slow queries into a table like information_schema.slow_queries like that. Which is a append-only tables with TTL setting.

config/config.md Show resolved Hide resolved
src/common/telemetry/src/logging.rs Outdated Show resolved Hide resolved
src/servers/src/http/handler.rs Outdated Show resolved Hide resolved
@zyy17
Copy link
Collaborator Author

zyy17 commented Sep 26, 2024

Good job! Another suggestion is that maybe we can record all the slow queries into a table like information_schema.slow_queries like that. Which is a append-only tables with TTL setting.

Good job! Another suggestion is that maybe we can record all the slow queries into a table like information_schema.slow_queries like that. Which is a append-only tables with TTL setting.

I can take it as the next PR. Let me learn how to implement it.

@zyy17 zyy17 changed the title feat: add slow query logs for SQL feat: add StatementStatistics for slow query logging implementation Sep 29, 2024
Copy link
Contributor

@killme2008 killme2008 left a comment

Choose a reason for hiding this comment

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

LGTM

@v0y4g3r
Copy link
Contributor

v0y4g3r commented Sep 29, 2024

Is it possible that we may print sensitive data into slow log file? Like copy from/to statements usually take a long time, while bearing AK/SK info.

Copy link
Collaborator

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@zyy17
Copy link
Collaborator Author

zyy17 commented Sep 30, 2024

Is it possible that we may print sensitive data into slow log file? Like copy from/to statements usually take a long time, while bearing AK/SK info.

You're right. Let me check it.

@zyy17
Copy link
Collaborator Author

zyy17 commented Sep 30, 2024

Is it possible that we may print sensitive data into slow log file? Like copy from/to statements usually take a long time, while bearing AK/SK info.

We already use https://github.com/GreptimeTeam/greptimedb/blob/main/src/sql/src/statements/option_map.rs#L27 for sensitive data. If we use Display, it will print **** for sensitive data.

@zyy17 zyy17 added this pull request to the merge queue Sep 30, 2024
Merged via the queue into GreptimeTeam:main with commit e39a9e6 Sep 30, 2024
44 checks passed
@zyy17 zyy17 deleted the feat/slow-query-logs branch September 30, 2024 03:43
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.

Add the slow operation logging
5 participants