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

[Docs] Add documentation for Scheduled Full Compactions feature #15188

Closed
jmeehan16 opened this issue Nov 30, 2022 · 1 comment
Closed

[Docs] Add documentation for Scheduled Full Compactions feature #15188

jmeehan16 opened this issue Nov 30, 2022 · 1 comment
Assignees
Labels
area/documentation Documentation needed temp/docs-migration TEMPORARY USE for migrating docs tickets to Jira

Comments

@jmeehan16
Copy link
Contributor

Description

Add documentation for the scheduled full compactions feature (#7614 / https://docs.google.com/document/d/1f9mbHKp7Z4KVR9Ln6AaMctz6rDlswI1rxBG6MrmzGZM/edit#heading=h.4kzu8dyrew3x). Documentation should include:

Basics about the feature
Details about new gflags
Limitations

@jmeehan16 jmeehan16 added the area/documentation Documentation needed label Nov 30, 2022
@jmeehan16 jmeehan16 self-assigned this Nov 30, 2022
jmeehan16 added a commit that referenced this issue Dec 15, 2022
* [#15188][Docs] Add documentation for scheduled full compactions feature

Specifically, adds compaction documentation to the `architecture/concepts/yb-tserver.md` and gflag documentation to `reference/configuration/yb-tserver.md`.

These changes are on `stable`(2.16) ONLY, and will need to be backported to `preview` once 2.17.1 is released.

Co-authored-by: John Meehan <jmeehan16@users.noreply.github.com>
@jmeehan16
Copy link
Contributor Author

Documentation has been committed to the stable/2.16 branch. Will still need to be added to "preview" once 2.17.1 lands.

Leaving this issue open for then.

@polarweasel polarweasel added the temp/docs-migration TEMPORARY USE for migrating docs tickets to Jira label Feb 4, 2023
jmeehan16 added a commit that referenced this issue Jun 14, 2023
* [#15188][Docs] Add documentation for scheduled full compactions feature

Adds statistics-based full compaction documentation to the preview section. This includes:

Addition of a new section (Statistics-based full compactions to improve read performance) to the yb-tserver page, near the other compaction documentation.
Documentation of the following gflags:
-- auto_compact_check_interval_sec
-- auto_compact_stat_window_seconds
-- auto_compact_percent_obsolete
-- auto_compact_min_obsolete_keys_found
-- auto_compact_min_wait_between_seconds
Also adds the Scheduled Full Compactions documentation to the preview documentation.

---------

Co-authored-by: John Meehan <jmeehan16@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation needed temp/docs-migration TEMPORARY USE for migrating docs tickets to Jira
Projects
None yet
Development

No branches or pull requests

2 participants