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

Make sanity check of settings worse #63119

Merged
merged 5 commits into from Apr 30, 2024

Conversation

Algunenano
Copy link
Member

@Algunenano Algunenano commented Apr 29, 2024

Changelog category (leave one):

  • Bug Fix (user-visible misbehavior in an official stable release)

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

  • Sanity check: Clamp values instead of throwing

Documentation entry for user-facing changes

When I introduced setting sanity checks in 24.2 (#60138) I didn't anticipate anybody except the fuzzer would be using such trash values. I was wrong, and this led to problems during upgrades.

Introducing a setting to allow skipping sanity checks is stupid, as the sanity checks are necessary to prevent crashes that otherwise would require hundreds to different checks whenever some settings are used, so I intend to introduce 2 modes of sanity checks: the one introduced initially, where we throw and error, and the one I'm using to replace temporarily now where we clamp the values to something "valid" (still unreasonable in most cases).

This will be done in 2 stages:

  • This PR: Changes the behaviour to clamp values, as it's intended to be backported.
  • A future PR, where better checks will be introduced, controlled via the compatibility setting.

@robot-clickhouse-ci-2 robot-clickhouse-ci-2 added the pr-improvement Pull request with some product improvements label Apr 29, 2024
@robot-clickhouse-ci-2
Copy link
Contributor

robot-clickhouse-ci-2 commented Apr 29, 2024

This is an automated comment for commit 5355dec with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Check nameDescriptionStatus
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR⏳ pending
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure
Successful checks
Check nameDescriptionStatus
A SyncThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
Bugfix validationChecks that either a new test (functional or integration) or there some changed tests that fail with the binary built on master branch✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
PR CheckThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts✅ success

@Algunenano Algunenano added pr-bugfix Pull request with bugfix, not backported by default and removed pr-improvement Pull request with some product improvements labels Apr 29, 2024
@antaljanosbenjamin antaljanosbenjamin self-assigned this Apr 29, 2024
if (max_threads > getNumberOfPhysicalCPUCores() * 65536)
throw Exception(ErrorCodes::INVALID_SETTING_VALUE, "Sanity check: Too many threads requested ({})", max_threads);
UInt64 max_threads_max_value = 256 * getNumberOfPhysicalCPUCores();
if (max_threads > max_threads_max_value)
Copy link
Member

Choose a reason for hiding this comment

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

Maybe log the fact that clamping happened, so when somebody gets surprised, we can check the logs.

Copy link
Contributor

Choose a reason for hiding this comment

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

Logs can rotate quite quickly. I would love to see this information in system.errors as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll add some logs. Adding to system.errors might come in the future since we need extra code to support this (right now we only log exceptions) and I'd rather not backport that part.


EXPLAIN PIPELINE SELECT zero + 1 AS x FROM system.zeros SETTINGS max_block_size = 9223372036854775806, max_rows_to_read = 20, read_overflow_mode = 'break'; -- { serverError INVALID_SETTING_VALUE }
EXPLAIN PIPELINE SELECT zero + 1 AS x FROM system.zeros LIMIT 10 SETTINGS max_block_size = 9223372036854775806, max_rows_to_read = 20, read_overflow_mode = 'break';
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can do something like:

SET max_block_size =9223372036854775806;
SELECT value FROM system.settings WHERE name = 'max_block_size';

@Algunenano Algunenano added this pull request to the merge queue Apr 30, 2024
Merged via the queue into ClickHouse:master with commit 415a7be Apr 30, 2024
218 of 234 checks passed
@Algunenano Algunenano deleted the sanity_check_clamp branch April 30, 2024 12:48
@robot-ch-test-poll robot-ch-test-poll added the pr-synced-to-cloud The PR is synced to the cloud repo label Apr 30, 2024
robot-ch-test-poll3 added a commit that referenced this pull request Apr 30, 2024
…6f746fb25d73a43a27f6f39c361a5

Cherry pick #63119 to 24.2: Make sanity check of settings worse
robot-ch-test-poll3 added a commit that referenced this pull request Apr 30, 2024
…6f746fb25d73a43a27f6f39c361a5

Cherry pick #63119 to 24.3: Make sanity check of settings worse
@robot-ch-test-poll3 robot-ch-test-poll3 added the pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore label Apr 30, 2024
robot-ch-test-poll added a commit that referenced this pull request Apr 30, 2024
Backport #63119 to 24.2: Make sanity check of settings worse
Algunenano added a commit that referenced this pull request May 2, 2024
Backport #63119 to 24.3: Make sanity check of settings worse
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
make it worse pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore pr-backports-created-cloud pr-bugfix Pull request with bugfix, not backported by default pr-must-backport-cloud pr-synced-to-cloud The PR is synced to the cloud repo v24.2-must-backport v24.3-must-backport
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants