# pylint: disable=unused-argument # pylint: disable=redefined-outer-name # pylint: disable=line-too-long import time import threading import pytest from helpers.client import QueryRuntimeException from helpers.cluster import ClickHouseCluster cluster = ClickHouseCluster(__file__) node = cluster.add_instance( "node", stay_alive=True, main_configs=[ "configs/storage_configuration.xml", "configs/resources.xml", "configs/resources.xml.default", "configs/workloads.xml", "configs/workloads.xml.default", ], with_minio=True, ) @pytest.fixture(scope="module", autouse=True) def start_cluster(): try: cluster.start() yield finally: cluster.shutdown() @pytest.fixture(scope="function", autouse=True) def set_default_configs(): node.exec_in_container( [ "bash", "-c", "cp /etc/clickhouse-server/config.d/resources.xml.default /etc/clickhouse-server/config.d/resources.xml", ] ) node.exec_in_container( [ "bash", "-c", "cp /etc/clickhouse-server/config.d/workloads.xml.default /etc/clickhouse-server/config.d/workloads.xml", ] ) node.query("system reload config") yield @pytest.fixture(scope="function", autouse=True) def clear_workloads_and_resources(): node.query( f""" drop resource if exists io_write; drop resource if exists io_read; drop workload if exists production; drop workload if exists development; drop workload if exists admin; drop workload if exists all; """ ) yield def update_workloads_config(**settings): xml = "" for name in settings: xml += f"<{name}>{settings[name]}" print(xml) node.exec_in_container( [ "bash", "-c", f"echo '{xml}' > /etc/clickhouse-server/config.d/workloads.xml", ] ) node.query("system reload config") def check_profile_event_for_query(workload, profile_event, amount=1): node.query("system flush logs") query_pattern = f"workload='{workload}'".replace("'", "\\'") assert ( int( node.query( f"select ProfileEvents['{profile_event}'] from system.query_log where query ilike '%{query_pattern}%' and type = 'QueryFinish' order by query_start_time_microseconds desc limit 1" ) ) == amount ) def test_s3_resource_request_granularity(): node.query( f""" drop table if exists data; create table data (key UInt64 CODEC(NONE), value String CODEC(NONE)) engine=MergeTree() order by key settings min_bytes_for_wide_part=1e9, storage_policy='s3'; """ ) total_bytes = 50000000 # Approximate data size max_bytes_per_request = 2000000 # Should be ~1MB or less in general min_bytes_per_request = 6000 # Small requests are ok, but we don't want hurt performance with too often resource requests writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/admin'" ).strip() ) write_bytes_before = int( node.query( f"select dequeued_cost from system.scheduler where resource='network_write' and path='/prio/admin'" ).strip() ) write_budget_before = int( node.query( f"select budget from system.scheduler where resource='network_write' and path='/prio/admin'" ).strip() ) node.query( f"insert into data select number, randomString(10000000) from numbers(5) SETTINGS workload='admin'" ) writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/admin'" ).strip() ) write_bytes_after = int( node.query( f"select dequeued_cost from system.scheduler where resource='network_write' and path='/prio/admin'" ).strip() ) write_budget_after = int( node.query( f"select budget from system.scheduler where resource='network_write' and path='/prio/admin'" ).strip() ) write_requests = writes_after - writes_before write_bytes = (write_bytes_after - write_bytes_before) - ( write_budget_after - write_budget_before ) assert write_bytes > 1.0 * total_bytes assert write_bytes < 1.05 * total_bytes assert write_bytes / write_requests < max_bytes_per_request assert write_bytes / write_requests > min_bytes_per_request check_profile_event_for_query("admin", "SchedulerIOWriteRequests", write_requests) check_profile_event_for_query("admin", "SchedulerIOWriteBytes", write_bytes) node.query(f"optimize table data final") reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/admin'" ).strip() ) read_bytes_before = int( node.query( f"select dequeued_cost from system.scheduler where resource='network_read' and path='/prio/admin'" ).strip() ) read_budget_before = int( node.query( f"select budget from system.scheduler where resource='network_read' and path='/prio/admin'" ).strip() ) node.query( f"select count() from data where not ignore(*) SETTINGS workload='admin'" ) reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/admin'" ).strip() ) read_bytes_after = int( node.query( f"select dequeued_cost from system.scheduler where resource='network_read' and path='/prio/admin'" ).strip() ) read_budget_after = int( node.query( f"select budget from system.scheduler where resource='network_read' and path='/prio/admin'" ).strip() ) read_bytes = (read_bytes_after - read_bytes_before) - ( read_budget_after - read_budget_before ) read_requests = reads_after - reads_before assert read_bytes > 1.0 * total_bytes assert read_bytes < 1.05 * total_bytes assert read_bytes / read_requests < max_bytes_per_request assert read_bytes / read_requests > min_bytes_per_request check_profile_event_for_query("admin", "SchedulerIOReadRequests", read_requests) check_profile_event_for_query("admin", "SchedulerIOReadBytes", read_bytes) def test_s3_disk(): node.query( f""" drop table if exists data; create table data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3'; """ ) def write_query(workload): try: node.query( f"insert into data select * from numbers(1e5) settings workload='{workload}'" ) except QueryRuntimeException: pass thread1 = threading.Thread(target=write_query, args=["development"]) thread2 = threading.Thread(target=write_query, args=["production"]) thread3 = threading.Thread(target=write_query, args=["admin"]) thread1.start() thread2.start() thread3.start() thread3.join() thread2.join() thread1.join() assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='network_write' and path='/prio/admin'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='network_write' and path='/prio/fair/dev'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='network_write' and path='/prio/fair/prod'" ) == "1\n" ) def read_query(workload): try: node.query(f"select sum(key*key) from data settings workload='{workload}'") except QueryRuntimeException: pass thread1 = threading.Thread(target=read_query, args=["development"]) thread2 = threading.Thread(target=read_query, args=["production"]) thread3 = threading.Thread(target=read_query, args=["admin"]) thread1.start() thread2.start() thread3.start() thread3.join() thread2.join() thread1.join() assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='network_read' and path='/prio/admin'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='network_read' and path='/prio/fair/dev'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='network_read' and path='/prio/fair/prod'" ) == "1\n" ) def test_merge_workload(): node.query( f""" drop table if exists data; create table data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3'; """ ) reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/sys/merges'" ).strip() ) writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/sys/merges'" ).strip() ) node.query(f"insert into data select * from numbers(1e4)") node.query(f"insert into data select * from numbers(2e4)") node.query(f"insert into data select * from numbers(3e4)") node.query(f"optimize table data final") reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/sys/merges'" ).strip() ) writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/sys/merges'" ).strip() ) assert reads_before < reads_after assert writes_before < writes_after def test_merge_workload_override(): node.query( f""" drop table if exists prod_data; drop table if exists dev_data; create table prod_data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3', merge_workload='prod_merges'; create table dev_data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3', merge_workload='dev_merges'; """ ) prod_reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/prod_merges'" ).strip() ) prod_writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/prod_merges'" ).strip() ) dev_reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/dev_merges'" ).strip() ) dev_writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/dev_merges'" ).strip() ) node.query(f"insert into prod_data select * from numbers(1e4)") node.query(f"insert into prod_data select * from numbers(2e4)") node.query(f"insert into prod_data select * from numbers(3e4)") node.query(f"insert into dev_data select * from numbers(1e4)") node.query(f"insert into dev_data select * from numbers(2e4)") node.query(f"insert into dev_data select * from numbers(3e4)") node.query(f"optimize table prod_data final") node.query(f"optimize table dev_data final") prod_reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/prod_merges'" ).strip() ) prod_writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/prod_merges'" ).strip() ) dev_reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/dev_merges'" ).strip() ) dev_writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/dev_merges'" ).strip() ) assert prod_reads_before < prod_reads_after assert prod_writes_before < prod_writes_after assert dev_reads_before < dev_reads_after assert dev_writes_before < dev_writes_after def test_mutate_workload(): node.query( f""" drop table if exists data; create table data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3'; """ ) node.query(f"insert into data select * from numbers(1e4)") node.query(f"optimize table data final") reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/sys/mutations'" ).strip() ) writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/sys/mutations'" ).strip() ) node.query(f"alter table data update key = 1 where key = 42") node.query(f"optimize table data final") reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/sys/mutations'" ).strip() ) writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/sys/mutations'" ).strip() ) assert reads_before < reads_after assert writes_before < writes_after def test_mutation_workload_override(): node.query( f""" drop table if exists prod_data; drop table if exists dev_data; create table prod_data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3', mutation_workload='prod_mutations'; create table dev_data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3', mutation_workload='dev_mutations'; """ ) node.query(f"insert into prod_data select * from numbers(1e4)") node.query(f"optimize table prod_data final") node.query(f"insert into dev_data select * from numbers(1e4)") node.query(f"optimize table dev_data final") prod_reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/prod_mutations'" ).strip() ) prod_writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/prod_mutations'" ).strip() ) dev_reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/dev_mutations'" ).strip() ) dev_writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/dev_mutations'" ).strip() ) node.query(f"alter table prod_data update key = 1 where key = 42") node.query(f"optimize table prod_data final") node.query(f"alter table dev_data update key = 1 where key = 42") node.query(f"optimize table dev_data final") prod_reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/prod_mutations'" ).strip() ) prod_writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/prod_mutations'" ).strip() ) dev_reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/dev_mutations'" ).strip() ) dev_writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/dev_mutations'" ).strip() ) assert prod_reads_before < prod_reads_after assert prod_writes_before < prod_writes_after assert dev_reads_before < dev_reads_after assert dev_writes_before < dev_writes_after def test_merge_workload_change(): node.query( f""" drop table if exists data; create table data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3'; """ ) for env in ["prod", "dev"]: update_workloads_config(merge_workload=f"{env}_merges") reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/{env}_merges'" ).strip() ) writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/{env}_merges'" ).strip() ) node.query(f"insert into data select * from numbers(1e4)") node.query(f"insert into data select * from numbers(2e4)") node.query(f"insert into data select * from numbers(3e4)") node.query(f"optimize table data final") reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/{env}_merges'" ).strip() ) writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/{env}_merges'" ).strip() ) assert reads_before < reads_after assert writes_before < writes_after def test_mutation_workload_change(): node.query( f""" drop table if exists data; create table data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3'; """ ) for env in ["prod", "dev"]: update_workloads_config(mutation_workload=f"{env}_mutations") node.query(f"insert into data select * from numbers(1e4)") node.query(f"optimize table data final") reads_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/{env}_mutations'" ).strip() ) writes_before = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/{env}_mutations'" ).strip() ) node.query(f"alter table data update key = 1 where key = 42") node.query(f"optimize table data final") reads_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_read' and path='/prio/fair/{env}_mutations'" ).strip() ) writes_after = int( node.query( f"select dequeued_requests from system.scheduler where resource='network_write' and path='/prio/fair/{env}_mutations'" ).strip() ) assert reads_before < reads_after assert writes_before < writes_after def test_create_workload(): node.query( f""" create resource io_write (write disk s3_no_resource); create resource io_read (read disk s3_no_resource); create workload all settings max_cost = 1000000; create workload admin in all settings priority = 0; create workload production in all settings priority = 1, weight = 9; create workload development in all settings priority = 1, weight = 1; """ ) def do_checks(): assert ( node.query( f"select count() from system.scheduler where path ilike '%/admin/%' and type='fifo'" ) == "2\n" ) assert ( node.query( f"select count() from system.scheduler where path ilike '%/admin' and type='unified' and priority=0" ) == "2\n" ) assert ( node.query( f"select count() from system.scheduler where path ilike '%/production/%' and type='fifo'" ) == "2\n" ) assert ( node.query( f"select count() from system.scheduler where path ilike '%/production' and type='unified' and weight=9" ) == "2\n" ) assert ( node.query( f"select count() from system.scheduler where path ilike '%/development/%' and type='fifo'" ) == "2\n" ) do_checks() node.restart_clickhouse() # Check that workloads persist do_checks() def test_resource_read_and_write(): node.query( f""" drop table if exists data; create table data (key UInt64 CODEC(NONE)) engine=MergeTree() order by tuple() settings min_bytes_for_wide_part=1e9, storage_policy='s3_no_resource'; """ ) node.query( f""" create resource io_write (write disk s3_no_resource); create resource io_read (read disk s3_no_resource); create workload all settings max_cost = 1000000; create workload admin in all settings priority = 0; create workload production in all settings priority = 1, weight = 9; create workload development in all settings priority = 1, weight = 1; """ ) def write_query(workload): try: node.query( f"insert into data select * from numbers(1e5) settings workload='{workload}'" ) except QueryRuntimeException: pass thread1 = threading.Thread(target=write_query, args=["development"]) thread2 = threading.Thread(target=write_query, args=["production"]) thread3 = threading.Thread(target=write_query, args=["admin"]) thread1.start() thread2.start() thread3.start() thread3.join() thread2.join() thread1.join() assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='io_write' and path ilike '%/admin/%' and type='fifo'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='io_write' and path ilike '%/development/%' and type='fifo'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='io_write' and path ilike '%/production/%' and type='fifo'" ) == "1\n" ) def read_query(workload): try: node.query(f"select sum(key*key) from data settings workload='{workload}'") except QueryRuntimeException: pass thread1 = threading.Thread(target=read_query, args=["development"]) thread2 = threading.Thread(target=read_query, args=["production"]) thread3 = threading.Thread(target=read_query, args=["admin"]) thread1.start() thread2.start() thread3.start() thread3.join() thread2.join() thread1.join() assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='io_read' and path ilike '%/admin/%' and type='fifo'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='io_read' and path ilike '%/development/%' and type='fifo'" ) == "1\n" ) assert ( node.query( f"select dequeued_requests>0 from system.scheduler where resource='io_read' and path ilike '%/production/%' and type='fifo'" ) == "1\n" )