feat: improve observability for procedure #4675

realtaobo · 2024-09-04T09:17:39Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

Resolve #3999

What's changed and what's your intention?

I'm working on resolving issue #3999, which includes the following main tasks:

Adding a new RPC interface to query all undeleted procedure metadata.
Introducing the information_schema.procedure_info table.

mysql> select * from information_schema.procedure_info \G
*************************** 1. row ***************************
  procedure_id: 140ae3dd-da22-4f5d-a447-debe55e6bbb1
procedure_type: metasrv-procedure::DropTable
    start_time: 2024-09-13 14:42:29.298000
      end_time: 2024-09-13 14:42:29.309000
        status: Done
     lock_keys: Share("__catalog_lock/greptime"),Share("__schema_lock/greptime.public"),Exclusive("__table_lock/1044")
*************************** 2. row ***************************
  procedure_id: 2a6d3155-b2c0-4503-81d7-a981393b08fb
procedure_type: metasrv-procedure::CreateTable
    start_time: 2024-09-13 14:42:33.490000
      end_time: 2024-09-13 14:42:33.498000
        status: Done
     lock_keys: Share("__catalog_lock/greptime"),Share("__schema_lock/greptime.public"),Exclusive("__table_name_lock/greptime.public.temperatures")
2 rows in set (0.01 sec)

Checklist

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

coderabbitai · 2024-09-04T09:18:12Z

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.

codecov · 2024-09-04T09:35:01Z

Codecov Report

Attention: Patch coverage is 21.89349% with 264 lines in your changes missing coverage. Please review.

Project coverage is 84.43%. Comparing base (36b1baf) to head (f410ee7).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4675      +/-   ##
==========================================
- Coverage   84.79%   84.43%   -0.36%     
==========================================
  Files        1115     1116       +1     
  Lines      201200   201543     +343     
==========================================
- Hits       170598   170167     -431     
- Misses      30602    31376     +774

src/catalog/src/system_schema/information_schema/procedure_info.rs

src/catalog/src/system_schema/utils.rs

src/common/procedure/src/local.rs

WenyXu · 2024-09-09T02:48:30Z

Does it print the lock_keys info?

WenyXu · 2024-09-09T03:00:38Z

     lock_keys: __catalog_lock/greptime,__schema_lock/greptime.public,__table_name_lock/greptime.public.temperatures

It's better to print the type of lock, like read lock, write lock.

lock_keys: Read(__catalog_lock/greptime),Read(__schema_lock/greptime.public),Write(__table_name_lock/greptime.public.temperatures)

MichaelScofield · 2024-09-09T06:23:30Z

@realtaobo please resolve the conflicts first

WenyXu

Nice work!

Some nitpicking:

Only expose methods that you need
Avoid redundant struct converting

src/catalog/src/system_schema/information_schema/procedure_info.rs

src/common/procedure/src/lib.rs

src/common/procedure/src/local.rs

MichaelScofield · 2024-09-10T03:27:38Z

src/catalog/src/system_schema/information_schema/procedure_info.rs

+            Mode::Standalone => {
+                if let Some(procedure_manager) = utils::procedure_manager(&self.catalog_manager)? {
+                    let procedures = procedure_manager
+                        .list_procedure()


Wondering if the list_procedure can be made into ProcedureExecutor. I think the codes can be more concise.

No, It's not easy in Standalone mode. Because KvBackendCatalogManager seems doesn't method to hold a DdlManager which impl ProcedureExecutor trait. Maybe it is possible, but is the cost too high.

greptimedb/src/cmd/src/standalone.rs

Lines 480 to 485 in 36b1baf

let catalog_manager = KvBackendCatalogManager::new(

dn_opts.mode,

None,

kv_backend.clone(),

layered_cache_registry.clone(),

);

killme2008

A great work! I think after this PR is merged, we can re-implement the procedure_state function by querying this table.

realtaobo · 2024-09-13T14:48:15Z

Hi, all, resolved all comment, please take a look :)
The latest information_schema.procedure_info schema has been updated in the description.

realtaobo requested review from MichaelScofield and a team as code owners September 4, 2024 09:17

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

realtaobo force-pushed the f-obs branch from ebbcba2 to 73f7e33 Compare September 4, 2024 09:19

realtaobo added 4 commits September 4, 2024 22:18

feat: improve observability for procedure

55452df

fix: test error

875b33b

test: add sqlness test for information_schema.procedure_info

4e1bcb7

fix: sqlness test error

a8e701c

realtaobo force-pushed the f-obs branch from 73f7e33 to a8e701c Compare September 4, 2024 15:03

MichaelScofield reviewed Sep 5, 2024

View reviewed changes

realtaobo added 2 commits September 5, 2024 17:53

fix: cr comment

75788e9

Merge branch 'main' into f-obs

ee0909d

realtaobo requested a review from MichaelScofield September 5, 2024 11:47

realtaobo mentioned this pull request Sep 6, 2024

feat: support for batch querying metadata information of procedure GreptimeTeam/greptime-proto#189

Open

2 tasks

Merge branch 'main' into f-obs

4cafa0e

fengjiachun requested review from fengjiachun, waynexia and WenyXu and removed request for waynexia September 6, 2024 09:26

realtaobo added 2 commits September 8, 2024 15:36

Merge branch 'main' into f-obs

4e85b95

chore: update proto version

c0e7ef1

This comment was marked as outdated.

Sign in to view

realtaobo added 3 commits September 9, 2024 16:40

Merge branch 'main' into f-obs

5cc8ac6

fix: apply cr comment

bab28d8

Merge branch 'main' into f-obs

e9b9b31

update version

dc402f4

WenyXu reviewed Sep 10, 2024

View reviewed changes

MichaelScofield reviewed Sep 10, 2024

View reviewed changes

killme2008 reviewed Sep 10, 2024

View reviewed changes

realtaobo added 3 commits September 13, 2024 21:59

fix: cr comment

ff83c68

Merge branch 'main' into f-obs

5fcd53c

optimize procedure type output format

f410ee7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: improve observability for procedure #4675

feat: improve observability for procedure #4675

realtaobo commented Sep 4, 2024 •

edited

Loading

coderabbitai bot commented Sep 4, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Sep 4, 2024 •

edited

Loading

WenyXu commented Sep 9, 2024

This comment was marked as outdated.

WenyXu commented Sep 9, 2024

MichaelScofield commented Sep 9, 2024

WenyXu left a comment

MichaelScofield Sep 10, 2024

realtaobo Sep 13, 2024

killme2008 left a comment

realtaobo commented Sep 13, 2024 •

edited

Loading

	let catalog_manager = KvBackendCatalogManager::new(
	dn_opts.mode,
	None,
	kv_backend.clone(),
	layered_cache_registry.clone(),
	);

feat: improve observability for procedure #4675

Are you sure you want to change the base?

feat: improve observability for procedure #4675

Conversation

realtaobo commented Sep 4, 2024 • edited Loading

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

coderabbitai bot commented Sep 4, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

codecov bot commented Sep 4, 2024 • edited Loading

Codecov Report

WenyXu commented Sep 9, 2024

This comment was marked as outdated.

WenyXu commented Sep 9, 2024

MichaelScofield commented Sep 9, 2024

WenyXu left a comment

Choose a reason for hiding this comment

MichaelScofield Sep 10, 2024

Choose a reason for hiding this comment

realtaobo Sep 13, 2024

Choose a reason for hiding this comment

killme2008 left a comment

Choose a reason for hiding this comment

realtaobo commented Sep 13, 2024 • edited Loading

realtaobo commented Sep 4, 2024 •

edited

Loading

codecov bot commented Sep 4, 2024 •

edited

Loading

realtaobo commented Sep 13, 2024 •

edited

Loading