Feedback: Production Checklist
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the v25.3 recommended production settings page, especially the cache and SQL memory size section, and compare its example with the stated formula. Check the documented guidance against the v24.3 misconfiguration log message quoted in the issue. Done means the example and formula are consistent and the relevant warning message is documented or clearly referenced.
Written by the indexing model from the issue text.
Description
Page: https://cockroachlabs.com/docs/v25.3/recommended-production-settings.html#cache-and-sql-memory-size
What is the reason for your feedback?
[ ] Missing the information I need
[X] Too complicated
[ ] Out of date
[ ] Something is broken
[ ] Other
Additional details
This section is quite confusing.
On the one hand it suggests that you can set both --cache and --max-sql-memory to 35% of physical memory -
cockroach start --cache=.35 --max-sql-memory=.35 {other start flags}
Then the following formula is given:
(2 * --max-sql-memory) + --cache <= 80% of system RAM
If I decide to set both to 35% and then plug the values into the formula I get
(2 * 35%) + 35% <= 80% of system RAM
105% <= 80% of system RAM
This means that the example cockroach start command is invalid.
Also the following log messages are sent to the main log file in the event of a misconfiguration (this is with v24.3):
W250821 22:36:37.660126 1 1@cli/start.go:1371 ⋮ [T1,n?] 3 the sum of --max-sql-memory (‹31 GiB›), --cache (‹62 GiB›), and --max-tsdb-memory (‹1.2 GiB›) is larger than 75% of total RAM (93 GiB).
This server is running at increased risk of memory-related failures.
Can the docs page be made consistent with the product?
Can we mention to look for this error message somewhere in the docs?
Jira issue: DOC-15028
- 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
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 76/100
EchoTools/nevr-runtime#110 ·
Maintainers usually reply within 1 day
-
Device Details tables: FS/SF columns contradict each other (nfet_01v8 Vt row, pfet_01v8 Idsat row)Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
google/skywater-pdk#450 ·
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
databendlabs/databend-docs#3511 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
chingu-voyages/V62-tier3-team-33#285 ·
Maintainers usually reply within 1 day
-
automated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
lirantal/discoprint#36 ·
Maintainers usually reply within 1 day