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

Rename directory monitor concept into background INSERT #55978

Merged
merged 4 commits into from Nov 1, 2023

Conversation

azat
Copy link
Collaborator

@azat azat commented Oct 24, 2023

Changelog category (leave one):

  • Backward Incompatible Change

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

Rename directory monitor concept into background INSERT. All settings *directory_monitor* had been renamed to distributed_background_insert*. Backward compatibility should be preserved (since old settings had been added as an alias).

Rename the following query settings (with preserving backward compatibility, by keeping old name as an alias):

  • distributed_directory_monitor_sleep_time_ms -> distributed_background_insert_sleep_time_ms
  • distributed_directory_monitor_max_sleep_time_ms -> distributed_background_insert_max_sleep_time_ms
  • distributed_directory_monitor_batch -> distributed_background_insert_batch_inserts
  • distributed_directory_monitor_split_batch_on_failure -> distributed_background_insert_split_batch_on_failure
  • insert_distributed_sync -> distributed_foreground_insert
  • insert_distributed_timeout -> distributed_background_insert_timeout

And also group all settings related to distributed INSERTs in one place in Settings.h

Rename the following table settings (with preserving backward compatibility, by keeping old name as an alias):

  • monitor_batch_inserts -> background_insert_batch
  • monitor_split_batch_on_failure -> background_insert_split_batch_on_failure
  • directory_monitor_sleep_time_ms -> background_insert_sleep_time_ms
  • directory_monitor_max_sleep_time_ms -> background_insert_max_sleep_time_ms

P.S. Marked as Backward Incompatible Change just to underling this change in changelog.

Follow-up for: #45491 (cc @tavplubix @hanfei1991 )

@robot-ch-test-poll3 robot-ch-test-poll3 added the pr-backward-incompatible Pull request with backwards incompatible changes label Oct 24, 2023
@robot-ch-test-poll3
Copy link
Contributor

robot-ch-test-poll3 commented Oct 24, 2023

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

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

Successful checks
Check nameDescriptionStatus
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
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✅ 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 image for serversThe 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
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✅ 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
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
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub✅ success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool✅ success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ 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
Check nameDescriptionStatus
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❌ failure

@azat azat force-pushed the dist/dir-mon branch 2 times, most recently from 17daca1 to ef7d8c8 Compare October 25, 2023 18:20
@tavplubix
Copy link
Member

Rename directory monitor concept into async INSERT.

Why? I understand that "directory monitor" exposes some internal name from code that a user should not know about, but:

@azat
Copy link
Collaborator Author

azat commented Oct 30, 2023

the change is backward incompatible

Actually it should be 100% compatible, since old settings preserved as aliases for new ones, and there is a test for this.

"async insert" is confusing: we have another feature with the same name clickhouse.com/docs/en/optimize/asynchronous-inserts

But this in context of distributed, do you still think that they should not match?

@tavplubix
Copy link
Member

the change is backward incompatible

Actually it should be 100% compatible, since old settings preserved as aliases for new ones, and there is a test for this.

Sorry, I don't notice that from the first glance. And we already have settings aliases (I didn't know that), so it doesn't introduce more complexity. Then it's okay if the test is not flaky :)

"async insert" is confusing: we have another feature with the same name clickhouse.com/docs/en/optimize/asynchronous-inserts

But this in context of distributed, do you still think that they should not match?

Yes, I think that the "distributed_" prefix doesn't make it less confusing

@azat
Copy link
Collaborator Author

azat commented Oct 31, 2023

Yes, I think that the "distributed_" prefix doesn't make it less confusing

The problem is that there is old setting that named insert_distributed_sync, and if it not "sync" that it is "async".
Okay, let me think what could be done with the most hardest problem - naming...

@azat azat marked this pull request as draft October 31, 2023 12:34
…essage

After SYSTEM STOP DISTRIBUTED SENDS it will constantly print this
message.

Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
Rename the following query settings (with preserving backward
compatiblity, by keeping old name as an alias):
- distributed_directory_monitor_sleep_time_ms -> distributed_async_insert_sleep_time_ms
- distributed_directory_monitor_max_sleep_time_ms -> distributed_async_insert_max_sleep_time_ms
- distributed_directory_monitor_batch -> distributed_async_insert_batch_inserts
- distributed_directory_monitor_split_batch_on_failure -> distributed_async_insert_split_batch_on_failure

Rename the following table settings (with preserving backward
compatiblity, by keeping old name as an alias):
- monitor_batch_inserts -> async_insert_batch
- monitor_split_batch_on_failure -> async_insert_split_batch_on_failure
- directory_monitor_sleep_time_ms -> async_insert_sleep_time_ms
- directory_monitor_max_sleep_time_ms -> async_insert_max_sleep_time_ms

And also update all the references:

    $ gg -e directory_monitor_ -e monitor_ tests docs | cut -d: -f1 | sort -u | xargs sed -e 's/distributed_directory_monitor_sleep_time_ms/distributed_async_insert_sleep_time_ms/g' -e 's/distributed_directory_monitor_max_sleep_time_ms/distributed_async_insert_max_sleep_time_ms/g' -e 's/distributed_directory_monitor_batch_inserts/distributed_async_insert_batch/g' -e 's/distributed_directory_monitor_split_batch_on_failure/distributed_async_insert_split_batch_on_failure/g' -e 's/monitor_batch_inserts/async_insert_batch/g' -e 's/monitor_split_batch_on_failure/async_insert_split_batch_on_failure/g' -e 's/monitor_sleep_time_ms/async_insert_sleep_time_ms/g' -e 's/monitor_max_sleep_time_ms/async_insert_max_sleep_time_ms/g' -i

Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
@azat
Copy link
Collaborator Author

azat commented Oct 31, 2023

@tavplubix how about "background_insert"? It actually even better describe what internally happens.

@tavplubix
Copy link
Member

Yep, sounds good

@azat azat changed the title Rename directory monitor concept into async INSERT Rename directory monitor concept into background INSERT Oct 31, 2023
@azat azat marked this pull request as ready for review October 31, 2023 13:36
This will avoid amigibuity between general async INSERT's and INSERT
into Distributed, which are indeed background, so new term express it
even better.

Mostly done with:

    $ git di HEAD^ --name-only | xargs sed -i -e 's/distributed_async_insert/distributed_background_insert/g' -e 's/async_insert_batch/background_insert_batch/g' -e 's/async_insert_split_batch_on_failure/background_insert_split_batch_on_failure/g' -e 's/async_insert_sleep_time_ms/background_insert_sleep_time_ms/g' -e 's/async_insert_max_sleep_time_ms/background_insert_max_sleep_time_ms/g'

Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
@azat
Copy link
Collaborator Author

azat commented Nov 1, 2023

Upgrade check (tsan) — Logical error thrown (see clickhouse-server.log or logical_errors.txt)

/var/log/clickhouse-server/clickhouse-server.err.log:2023.11.01 02:49:04.648384 [ 1390 ] {} <Error> 75bc9495-20e3-44b8-ade3-4ac38b8717ee::all_0_5_3_14 (MergeFromLogEntryTask): virtual bool DB::ReplicatedMergeMutateTaskBase::executeStep(): Code: 49. DB::Exception: Invalid number of rows in Chunk column UInt64 position 5: expected 8192, got 5: While executing MergeTreeSequentialSource. (LOGICAL_ERROR), Stack trace (when copying this message, always include the lines below):
/var/log/clickhouse-server/clickhouse-server.err.log:2023.11.01 02:49:04.648459 [ 1390 ] {} <Error> MergeTreeBackgroundExecutor: Exception while executing background task {75bc9495-20e3-44b8-ade3-4ac38b8717ee::all_0_5_3_14}: Code: 49. DB::Exception: Invalid number of rows in Chunk column UInt64 position 5: expected 8192, got 5: While executing MergeTreeSequentialSource. (LOGICAL_ERROR), Stack trace (when copying this message, always include the lines below):

@tavplubix
Copy link
Member

Upgrade check (tsan) — Logical error thrown (see clickhouse-server.log or logical_errors.txt)

/var/log/clickhouse-server/clickhouse-server.err.log:2023.11.01 02:49:04.648384 [ 1390 ] {} <Error> 75bc9495-20e3-44b8-ade3-4ac38b8717ee::all_0_5_3_14 (MergeFromLogEntryTask): virtual bool DB::ReplicatedMergeMutateTaskBase::executeStep(): Code: 49. DB::Exception: Invalid number of rows in Chunk column UInt64 position 5: expected 8192, got 5: While executing MergeTreeSequentialSource. (LOGICAL_ERROR), Stack trace (when copying this message, always include the lines below):
/var/log/clickhouse-server/clickhouse-server.err.log:2023.11.01 02:49:04.648459 [ 1390 ] {} <Error> MergeTreeBackgroundExecutor: Exception while executing background task {75bc9495-20e3-44b8-ade3-4ac38b8717ee::all_0_5_3_14}: Code: 49. DB::Exception: Invalid number of rows in Chunk column UInt64 position 5: expected 8192, got 5: While executing MergeTreeSequentialSource. (LOGICAL_ERROR), Stack trace (when copying this message, always include the lines below):

#56202

@tavplubix tavplubix merged commit c25d6cd into ClickHouse:master Nov 1, 2023
283 of 284 checks passed
@azat azat deleted the dist/dir-mon branch January 8, 2024 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-backward-incompatible Pull request with backwards incompatible changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants