Document AC setting always_use_short_sample_period #22109
Conversation
Fixes DOC-15826 Summary of changes: - Add a new 'Cluster settings' section to the 'Recommended production settings' page - Manually add the `goschedstats.always_use_short_sample_period.enabled` cluster setting to the cluster settings page - Update the mention of the above setting on the AC page to link to the other updated sections NB. These changes will be ported to v23.2, v24.1, v24.3, and v25.2 docs. (This cluster setting was changed to default to `true` in v25.3)
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Appreciate the change Rich. LGTM! |
sumeerbhola
left a comment
sumeerbhola
left a comment
There was a problem hiding this comment.
@sumeerbhola reviewed 3 files and made 1 comment.
Reviewable status:complete! 1 of 0 LGTMs obtained (waiting on @lin-crl).
|
This change is |
taroface
left a comment
taroface
left a comment
There was a problem hiding this comment.
I'm sure you expected this question from me, but is there a specific reason we would not consult with engineering on marking this setting as public on the backend? I read the DOC ticket and couldn't glean the context. I'm concerned that we are starting to add tech debt by diverging from the norm here.
this was discussed in the initial convo prompting this, my understanding is that we didn't want to do a bunch of backports of this to make it public since we actually still want it to be private going forward - the main change was to make it default to true in v25.3+. Now that it's true, it should still stay private because users shouldn't have to care about it. But for customers still on those older versions, they will need to know about it turn it on (for a while, until they upgrade through v25.3+) @sumeerbhola is my summary above of the decision around whether to backport accurate? (for context, Ryan is understandably asking about this because ever since the big public vs non-public PR in cockroach docs team have a policy of not documenting non-public settings) my $0.02 is I think it's something of an edge case situation. But based on the ZD escalations linked from https://cockroachlabs.atlassian.net/browse/DOC-15826 which affected some important customers it seemed to me perhaps worth breaking that rule in this case to prevent more escalations, even if the engineering decision was to not backport |
5 participants
Fixes DOC-15826
Summary of changes:
Add a new 'Cluster settings' section to the 'Recommended production settings' page
Manually add the
goschedstats.always_use_short_sample_period.enabledcluster setting to the cluster settings pageUpdate the mention of the above setting on the AC page to link to the other updated sections
NB. These changes will be ported to v23.2, v24.1, v24.3, and v25.2 docs. (This cluster setting was changed to default to
truein v25.3)