Skip to content

[AMORO-1528] Add metrics document#2859

Merged
zhoujinsong merged 3 commits into
apache:masterfrom
zhoujinsong:add-metric-docs
May 23, 2024
Merged

[AMORO-1528] Add metrics document#2859
zhoujinsong merged 3 commits into
apache:masterfrom
zhoujinsong:add-metric-docs

Conversation

@zhoujinsong

Copy link
Copy Markdown
Contributor

Why are the changes needed?

Add a document for metrics.

Brief change log

  • Move metric description in Dashboard to using-table page
  • Add metric document

How was this patch tested?

  • Add some test cases that check the changes thoroughly including negative and positive cases if possible

  • Add screenshots for manual tests if appropriate

  • Run test locally before making a pull request

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? (not applicable)

@github-actions github-actions Bot added the type:docs Improvements or additions to documentation label May 23, 2024

@xxubai xxubai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I drop some comments, PTAL

- full: means that full optimizing is being executed on the table.
- committing: means that self-optimizing process is being committed.
- **Duration**: The duration of the current status.
- **File Count**: The total number of files involved in the current Self-optimizing, including base, insert, eq-delete, and pos-delete file types.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **File Count**: The total number of files involved in the current Self-optimizing, including base, insert, eq-delete, and pos-delete file types.
- **File Count**: The total number of files involved in the current self-optimizing, including base, insert, eq-delete, and pos-delete file types.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we describe it in more detail? For example with a self-optimising process?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do you mean that we can add some description about the optimizing process tab in the table detail page here?

If yes, maybe we can add it in another PR.

Comment thread docs/user-guides/using-tables.md Outdated
Co-authored-by: Xavier Bai <tocreationbai@gmail.com>

@xxubai xxubai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@zhoujinsong zhoujinsong merged commit 8e78f34 into apache:master May 23, 2024
@zhoujinsong zhoujinsong deleted the add-metric-docs branch May 23, 2024 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants