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

release-24.3: sql: do not collect histograms for non-indexed JSON columns #139897

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Jan 27, 2025

Backport 1/1 commits from #139766 on behalf of @mgartner.

/cc @cockroachdb/release


Informs #139381

Release note (sql change): Since v23.2 table statistics histograms have
been collected for non-indexed JSON columns. Histograms are no longer
collected for these columns if sql.stats.non_indexed_json_histograms.enabled
is set to false. This reduces memory usage during table
statistics collection, for both automatic and manual collection via
ANALYZE and CREATE STATISTICS.


Release justification: New cluster setting disabled by default.

@blathers-crl blathers-crl bot requested review from a team as code owners January 27, 2025 20:21
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-24.3-139766 branch from 8b1e538 to bfce5f6 Compare January 27, 2025 20:21
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Jan 27, 2025
@blathers-crl blathers-crl bot requested review from DrewKimball and removed request for a team January 27, 2025 20:21
Copy link
Author

blathers-crl bot commented Jan 27, 2025

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Jan 27, 2025
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@mgartner mgartner requested a review from a team January 30, 2025 20:55
@mgartner mgartner force-pushed the blathers/backport-release-24.3-139766 branch from bfce5f6 to 1611c96 Compare January 30, 2025 21:06
Copy link
Member

@yuzefovich yuzefovich left a comment

Choose a reason for hiding this comment

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

Reviewed 6 of 6 files at r1, all commit messages.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @blathers-crl[bot] and @DrewKimball)


pkg/sql/logictest/testdata/logic_test/distsql_stats line 1550 at r1 (raw file):

s                {a}           3          0           true
s                {b}           3          0           true
s                {j}           3          0           false

nit: I'm assuming these tests should have no change given the default value true.


docs/generated/settings/settings.html line 316 at r1 (raw file):

<tr><td><div id="setting-sql-stats-multi-column-collection-enabled" class="anchored"><code>sql.stats.multi_column_collection.enabled</code></div></td><td>boolean</td><td><code>true</code></td><td>multi-column statistics collection mode</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
<tr><td><div id="setting-sql-stats-non-default-columns-min-retention-period" class="anchored"><code>sql.stats.non_default_columns.min_retention_period</code></div></td><td>duration</td><td><code>24h0m0s</code></td><td>minimum retention period for table statistics collected on non-default columns</td><td>Serverless/Dedicated/Self-Hosted</td></tr>
<tr><td><div id="setting-sql-stats-non-indexed-json-histograms-enabled" class="anchored"><code>sql.stats.non_indexed_json_histograms.enabled</code></div></td><td>boolean</td><td><code>false</code></td><td>set to true to collect table statistics histograms on non-indexed JSON columns</td><td>Serverless/Dedicated/Self-Hosted</td></tr>

nit: I think the default value needs to be updated to true in docs.

@mgartner mgartner force-pushed the blathers/backport-release-24.3-139766 branch from 1611c96 to 161b5ec Compare January 30, 2025 21:25
Informs #139381

Release note (sql change): Since v23.2 table statistics histograms have
been collected for non-indexed JSON columns. Histograms are no longer
collected for these columns if `sql.stats.non_indexed_json_histograms.enabled`
is set to `false`. This reduces memory usage during table
statistics collection, for both automatic and manual collection via
`ANALYZE` and `CREATE STATISTICS`.
@mgartner mgartner force-pushed the blathers/backport-release-24.3-139766 branch from 161b5ec to 5eac908 Compare January 30, 2025 21:29
Copy link
Collaborator

@mgartner mgartner left a comment

Choose a reason for hiding this comment

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

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @DrewKimball and @yuzefovich)


docs/generated/settings/settings.html line 316 at r1 (raw file):

Previously, yuzefovich (Yahor Yuzefovich) wrote…

nit: I think the default value needs to be updated to true in docs.

Done.


pkg/sql/logictest/testdata/logic_test/distsql_stats line 1550 at r1 (raw file):

Previously, yuzefovich (Yahor Yuzefovich) wrote…

nit: I'm assuming these tests should have no change given the default value true.

Done.

Copy link
Member

@yuzefovich yuzefovich left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r2, 3 of 3 files at r3, all commit messages.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @DrewKimball)

@mgartner mgartner merged commit 576e5da into release-24.3 Jan 31, 2025
20 of 21 checks passed
@mgartner mgartner deleted the blathers/backport-release-24.3-139766 branch January 31, 2025 16:14
@mgartner
Copy link
Collaborator

blathers backport 24.3.4-rc

Copy link
Author

blathers-crl bot commented Jan 31, 2025

Encountered an error creating backports. Some common things that can go wrong:

  1. The backport branch might have already existed.
  2. There was a merge conflict.
  3. The backport branch contained merge commits.

You might need to create your backport manually using the backport tool.


error setting assignees, but backport branch blathers/backport-release-24.3.4-rc-139897 is ready: POST https://api.github.com/repos/cockroachdb/cockroach/issues/140265/assignees: 404 Not Found []

Backport to branch 24.3.4-rc failed. See errors above.


🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants