Minor correction needed to details on the automatic CPU profiler
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
Research direction
Open the automatic CPU profiler documentation at the high-water-mark-threshold anchor and review the timing example. Check the referenced profiler_common.go code around line 113 for confirmation that the interval resets after each profile. Update the sentence so the 20-minute interval is measured from time1, then verify the rendered page wording.
Written by the indexing model from the issue text.
Description
Affected page: https://www.cockroachlabs.com/docs/stable/automatic-cpu-profiler#high-water-mark-threshold
What needs changed:
At time2, the 20m0s interval after time0, the high-water mark threshold is reset to the baseline threshold of 65.
Needs to be changed to this line:
At time2, the 20m0s interval after time1, the high-water mark threshold is reset to the baseline threshold of 65.
Reasoning:
The interval period always resets after each new CPU profile, so we count the 20 minutes from time1 in this example - we do NOT count from when the first CPU profile was taken.
Confirmation:
Confirmed by the Observability team and by the code in https://github.com/cockroachdb/cockroach/blob/74a9fdc34d97afc902379f73f017e028531ae841/pkg/server/profiler/profiler_common.go#L113
Jira issue: DOC-16188
- Dominant language
- HTML
- Stars
- 212
- Forks
- 478
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cockroachdb/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cockroachdb/docs#23467 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
cockroachdb/docs#23456 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
cockroachdb/docs#23454 ·
-
Difficulty 2/5 1-2 days Newbie friendliness 68/100
cockroachdb/docs#23445 · 1 comment ·
-
sql-diagram-validation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
cockroachdb/docs#23444 · 4 comments ·
All issues in cockroachdb/docs
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
pyca/verified-garbage#1023 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
quickemu-project/quickemu#1960 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
area/docs
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day