feat: define basic structures and implement TimeFilter #5086

waynexia · 2024-12-03T08:15:13Z

Signed-off-by: Ruihang Xia [email protected]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?

Define some basic log query structures

Checklist

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

Signed-off-by: Ruihang Xia <[email protected]>

coderabbitai · 2024-12-03T08:15:20Z

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.

Copilot reviewed 6 out of 6 changed files in this pull request and generated no suggestions.

codecov · 2024-12-03T08:38:30Z

Codecov Report

Attention: Patch coverage is 78.98089% with 33 lines in your changes missing coverage. Please review.

Project coverage is 83.78%. Comparing base (bcadce3) to head (ce4c706).
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5086      +/-   ##
==========================================
- Coverage   84.02%   83.78%   -0.24%     
==========================================
  Files        1157     1159       +2     
  Lines      216415   216721     +306     
==========================================
- Hits       181836   181589     -247     
- Misses      34579    35132     +553

src/log-query/src/log_query.rs

Signed-off-by: Ruihang Xia <[email protected]>

src/log-query/src/log_query.rs

paomian

REST LGTM

zyy17

Mostly LGTM

shuiyisong

Rest LGTM

shuiyisong · 2024-12-04T04:16:13Z

src/log-query/src/log_query.rs

+    /// Maximum number of logs to return. If not provided, it will return all matched logs.
+    pub limit: Option<usize>,


Maybe we should set the default to 1000 lines or so. It's easy to write a careless query and result in huge returning lines during debugging. Also, it seems a common way to do it (with default limits).
Explicitly set to 0 to return all lines.

Good suggestion 👍 The default behavior is not going to be placed in the query definition. I'll set one on executing

shuiyisong · 2024-12-04T04:18:20Z

src/log-query/src/log_query.rs

+    }
+
+    /// Util function returns a start and optional end DateTime
+    fn parse_datetime(s: &str) -> Result<(DateTime<Utc>, Option<DateTime<Utc>>)> {


It looks like a very generic parse function, should it be moved to common-time?
Same as parse_span below.

parse_datetime is not that generic for now as here is the first and only place that accepts both date and timestamp. I'd do a refactor afterward for parse_span to combine the same piece of logic in the plan rewriter.

* feat: define basic structures and implement TimeFilter Signed-off-by: Ruihang Xia <[email protected]> * document column filter Signed-off-by: Ruihang Xia <[email protected]> * define context Signed-off-by: Ruihang Xia <[email protected]> * change variable name to avoid typo checker Signed-off-by: Ruihang Xia <[email protected]> * change error referring style Signed-off-by: Ruihang Xia <[email protected]> * refine context definition Signed-off-by: Ruihang Xia <[email protected]> --------- Signed-off-by: Ruihang Xia <[email protected]>

waynexia added 5 commits December 3, 2024 15:48

feat: define basic structures and implement TimeFilter

bef2c94

Signed-off-by: Ruihang Xia <[email protected]>

document column filter

68d1669

Signed-off-by: Ruihang Xia <[email protected]>

define context

2164a1d

Signed-off-by: Ruihang Xia <[email protected]>

change variable name to avoid typo checker

9139a6b

Signed-off-by: Ruihang Xia <[email protected]>

change error referring style

96d58e6

Signed-off-by: Ruihang Xia <[email protected]>

waynexia requested a review from a team as a code owner December 3, 2024 08:15

waynexia requested review from paomian, shuiyisong and Copilot December 3, 2024 08:15

Copilot AI reviewed Dec 3, 2024

View reviewed changes

github-actions bot added the docs-not-required This change does not impact docs. label Dec 3, 2024

zyy17 reviewed Dec 3, 2024

View reviewed changes

src/log-query/src/log_query.rs Show resolved Hide resolved

refine context definition

ce4c706

Signed-off-by: Ruihang Xia <[email protected]>

paomian reviewed Dec 4, 2024

View reviewed changes

src/log-query/src/log_query.rs Show resolved Hide resolved

paomian approved these changes Dec 4, 2024

View reviewed changes

zyy17 approved these changes Dec 4, 2024

View reviewed changes

shuiyisong approved these changes Dec 4, 2024

View reviewed changes

waynexia added this pull request to the merge queue Dec 4, 2024

Merged via the queue into GreptimeTeam:main with commit 5092f5f Dec 4, 2024
36 checks passed

waynexia deleted the log-query-init branch December 4, 2024 07:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: define basic structures and implement TimeFilter #5086

feat: define basic structures and implement TimeFilter #5086

waynexia commented Dec 3, 2024

coderabbitai bot commented Dec 3, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Dec 3, 2024 •

edited

Loading

paomian left a comment

zyy17 left a comment

shuiyisong left a comment

shuiyisong Dec 4, 2024

waynexia Dec 4, 2024

shuiyisong Dec 4, 2024

waynexia Dec 4, 2024

		/// Maximum number of logs to return. If not provided, it will return all matched logs.
		pub limit: Option<usize>,

feat: define basic structures and implement TimeFilter #5086

feat: define basic structures and implement TimeFilter #5086

Conversation

waynexia commented Dec 3, 2024

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

coderabbitai bot commented Dec 3, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Choose a reason for hiding this comment

codecov bot commented Dec 3, 2024 • edited Loading

Codecov Report

paomian left a comment

Choose a reason for hiding this comment

zyy17 left a comment

Choose a reason for hiding this comment

shuiyisong left a comment

Choose a reason for hiding this comment

shuiyisong Dec 4, 2024

Choose a reason for hiding this comment

waynexia Dec 4, 2024

Choose a reason for hiding this comment

shuiyisong Dec 4, 2024

Choose a reason for hiding this comment

waynexia Dec 4, 2024

Choose a reason for hiding this comment

codecov bot commented Dec 3, 2024 •

edited

Loading