github-actions[bot] commented on code in PR #68278: URL: https://github.com/apache/doris/pull/68278#discussion_r4228242635
########## tools/benchmark/run-benchmark.sh: ########## @@ -0,0 +1,312 @@ +#!/usr/bin/env bash +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +set -Eeuo pipefail +BENCHMARK_ROOT=$(cd "$(dirname "$0")" && pwd) +benchmark=$1 +shift +case "${benchmark}" in + ssb | tpch | tpcds) ;; + *) + echo "Unknown benchmark: ${benchmark}" >&2 + exit 1 + ;; +esac +SUITE_ROOT="${BENCHMARK_ROOT}/../${benchmark}-tools" +benchmark_name=${benchmark^^} + +usage() { + cat <<EOF +Usage: run-${benchmark}.sh [-s SCALE] [-c CONFIG] [-d DATABASE] [--queries-only] + [--result-dir DIRECTORY] [--mode both|ssb|flat] [--splits COUNT] + +Create tables, generate and import data through the Trino ${benchmark} connector, +collect statistics, and run every existing query three times. No data files or +separate Trino server are needed. SSB can also prepare lineorder_flat. +Existing table DDL and query SQL are preserved. + +SCALE: 1, 100, 1000 (also 10000 for TPCH/TPCDS). Default: 1. +--mode is only supported by SSB; its default is both. +--splits is only supported by TPCH/TPCDS; its default is max(10, SCALE). +COUNT must be an integer from 1 to 2147483647 and applies during preparation. +Requires mysql and the generator plugin installed on every Doris FE and BE. +The default connection configuration is conf/doris-cluster.conf. +Preparation requires a new database. Use --queries-only against completed data. +EOF +} + +scale=1 +config="${SUITE_ROOT}/conf/doris-cluster.conf" +database='' +queries_only=0 +mode='' +generator_splits='' +result_dir="${SUITE_ROOT}/results/$(date +%Y%m%d-%H%M%S)-$$" +options=$(getopt -o hs:c:d: -l help,queries-only,mode:,result-dir:,splits: -- "$@") +eval set -- "${options}" +while true; do + case "$1" in + -h | --help) + usage + exit 0 + ;; + -s) + scale=$2 + shift 2 + ;; + -c) + config=$2 + shift 2 + ;; + -d) + database=$2 + shift 2 + ;; + --queries-only) + queries_only=1 + shift + ;; + --mode) + mode=$2 + shift 2 + ;; + --result-dir) + result_dir=$2 + shift 2 + ;; + --splits) + # Both Trino connectors parse the split count as a Java int. + if [[ ! $2 =~ ^[1-9][0-9]{0,9}$ ]] || (($2 > 2147483647)); then + echo '--splits must be an integer from 1 to 2147483647.' >&2 + exit 1 + fi + generator_splits=$2 + shift 2 + ;; + --) + shift + break + ;; + *) + usage >&2 + exit 1 + ;; + esac +done +if [[ $# -ne 0 || ! ${scale} =~ ^(1|100|1000|10000)$ ]] || + [[ ${benchmark} == ssb && ${scale} == 10000 ]] || + [[ ${benchmark} == ssb && -n ${generator_splits} ]] || + [[ ${benchmark} != ssb && -n ${mode} ]] || + [[ -n ${mode} && ! ${mode} =~ ^(both|ssb|flat)$ ]]; then + usage >&2 + exit 1 +fi +mode=${mode:-both} +generator_splits=${generator_splits:-$((scale > 10 ? scale : 10))} Review Comment: [P2] Cap generator splits for small TPCH/TPCDS tables. At SF10000 this default is 10,000 and is passed to every table. Trino 435 creates that many splits even for TPCH region/nation (5/25 rows) and TPCDS income_band (20 rows); their generators return no rows for chunks after the first. Doris still schedules all 10,000 scan ranges and initializes a reader for each, wasting 9,999 range/reader setups per tiny table. The global --splits override trades away parallelism on fact tables. Choose per-table counts or suppress empty chunks so large imports stay parallel without the empty work. ########## tools/benchmark/run-benchmark.sh: ########## @@ -0,0 +1,312 @@ +#!/usr/bin/env bash +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +set -Eeuo pipefail +BENCHMARK_ROOT=$(cd "$(dirname "$0")" && pwd) +benchmark=$1 +shift +case "${benchmark}" in + ssb | tpch | tpcds) ;; + *) + echo "Unknown benchmark: ${benchmark}" >&2 + exit 1 + ;; +esac +SUITE_ROOT="${BENCHMARK_ROOT}/../${benchmark}-tools" +benchmark_name=${benchmark^^} + +usage() { + cat <<EOF +Usage: run-${benchmark}.sh [-s SCALE] [-c CONFIG] [-d DATABASE] [--queries-only] + [--result-dir DIRECTORY] [--mode both|ssb|flat] [--splits COUNT] + +Create tables, generate and import data through the Trino ${benchmark} connector, +collect statistics, and run every existing query three times. No data files or +separate Trino server are needed. SSB can also prepare lineorder_flat. +Existing table DDL and query SQL are preserved. + +SCALE: 1, 100, 1000 (also 10000 for TPCH/TPCDS). Default: 1. +--mode is only supported by SSB; its default is both. +--splits is only supported by TPCH/TPCDS; its default is max(10, SCALE). +COUNT must be an integer from 1 to 2147483647 and applies during preparation. +Requires mysql and the generator plugin installed on every Doris FE and BE. +The default connection configuration is conf/doris-cluster.conf. +Preparation requires a new database. Use --queries-only against completed data. +EOF +} + +scale=1 +config="${SUITE_ROOT}/conf/doris-cluster.conf" +database='' +queries_only=0 +mode='' +generator_splits='' +result_dir="${SUITE_ROOT}/results/$(date +%Y%m%d-%H%M%S)-$$" +options=$(getopt -o hs:c:d: -l help,queries-only,mode:,result-dir:,splits: -- "$@") +eval set -- "${options}" +while true; do + case "$1" in + -h | --help) + usage + exit 0 + ;; + -s) + scale=$2 + shift 2 + ;; + -c) + config=$2 + shift 2 + ;; + -d) + database=$2 + shift 2 + ;; + --queries-only) + queries_only=1 + shift + ;; + --mode) + mode=$2 + shift 2 + ;; + --result-dir) + result_dir=$2 + shift 2 + ;; + --splits) + # Both Trino connectors parse the split count as a Java int. + if [[ ! $2 =~ ^[1-9][0-9]{0,9}$ ]] || (($2 > 2147483647)); then + echo '--splits must be an integer from 1 to 2147483647.' >&2 + exit 1 + fi + generator_splits=$2 + shift 2 + ;; + --) + shift + break + ;; + *) + usage >&2 + exit 1 + ;; + esac +done +if [[ $# -ne 0 || ! ${scale} =~ ^(1|100|1000|10000)$ ]] || + [[ ${benchmark} == ssb && ${scale} == 10000 ]] || + [[ ${benchmark} == ssb && -n ${generator_splits} ]] || + [[ ${benchmark} != ssb && -n ${mode} ]] || + [[ -n ${mode} && ! ${mode} =~ ^(both|ssb|flat)$ ]]; then + usage >&2 + exit 1 +fi +mode=${mode:-both} +generator_splits=${generator_splits:-$((scale > 10 ? scale : 10))} +ddl="${SUITE_ROOT}/ddl/create-${benchmark}-tables-sf${scale}.sql" +# Each list is the base tables in the existing DDL; TPCH's revenue0 is a view. +# The benchmark name is validated above. +# shellcheck disable=SC2249 +case "${benchmark}" in + ssb) + tables=(customer part supplier dates lineorder) + suites=(ssb ssb-flat) + query_ids=(1.1 1.2 1.3 2.1 2.2 2.3 3.1 3.2 3.3 3.4 4.1 4.2 4.3) + generator_properties="'trino.connector.name'='ssb'" + ;; + tpch) + tables=(region nation supplier customer part partsupp orders lineitem) + suites=(tpch) + mapfile -t query_ids < <(seq 1 22) + # Match the existing Doris DDL, including exact two-decimal monetary values. + generator_properties="'trino.connector.name'='tpch', + 'trino.tpch.column-naming'='STANDARD', + 'trino.tpch.double-type-mapping'='DECIMAL', + 'trino.tpch.splits-per-node'='${generator_splits}'" + ;; + tpcds) + tables=(call_center catalog_page catalog_returns catalog_sales customer_address + customer_demographics customer date_dim household_demographics income_band + inventory item promotion reason ship_mode store_returns store_sales store + time_dim warehouse web_page web_returns web_sales web_site) + suites=(tpcds) + query_ids=() + for ((query = 1; query <= 99; query++)); do + query_ids+=("${query}") + # The existing suite splits these four templates into two statements. + case "${query}" in + 14 | 23 | 24 | 39) query_ids+=("${query}_1") ;; + *) ;; + esac + done + generator_properties="'trino.connector.name'='tpcds', 'trino.tpcds.split-count'='${generator_splits}'" + ;; +esac + +query_path() { + # The benchmark name is validated above. + # shellcheck disable=SC2249 + case "${benchmark}" in + ssb) printf '%s/%s-queries/q%s.sql' "${SUITE_ROOT}" "$1" "$2" ;; + tpch) printf '%s/queries/q%s.sql' "${SUITE_ROOT}" "$2" ;; + tpcds) printf '%s/queries/sf%s/query%s.sql' "${SUITE_ROOT}" "${scale}" "$2" ;; + esac +} + +# Fail before creating a database if a requested suite is incomplete. +for suite in "${suites[@]}"; do + for query in "${query_ids[@]}"; do + test -r "$(query_path "${suite}" "${query}")" + done +done +test -r "${ddl}" +# shellcheck disable=SC1090 +source "${config}" +database=${database:-${DB}} +if [[ ! ${database} =~ ^[a-zA-Z_][a-zA-Z0-9_]*$ ]]; then Review Comment: [P2] Validate the generated catalog name before creating the database. Doris accepts a 55-character database name, but TPCDS prepends tpcds_gen_ (10 characters), making the catalog name 65 characters; CREATE CATALOG then fails Doris's 64-character limit after CREATE DATABASE has succeeded. Retrying under the same name hits the fresh-database guard and requires manual cleanup. Bound the accepted name length for each suite, or derive a valid catalog name, before creating the database. ########## tools/benchmark/run-benchmark.sh: ########## @@ -0,0 +1,312 @@ +#!/usr/bin/env bash +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +set -Eeuo pipefail +BENCHMARK_ROOT=$(cd "$(dirname "$0")" && pwd) +benchmark=$1 +shift +case "${benchmark}" in + ssb | tpch | tpcds) ;; + *) + echo "Unknown benchmark: ${benchmark}" >&2 + exit 1 + ;; +esac +SUITE_ROOT="${BENCHMARK_ROOT}/../${benchmark}-tools" +benchmark_name=${benchmark^^} + +usage() { + cat <<EOF +Usage: run-${benchmark}.sh [-s SCALE] [-c CONFIG] [-d DATABASE] [--queries-only] + [--result-dir DIRECTORY] [--mode both|ssb|flat] [--splits COUNT] + +Create tables, generate and import data through the Trino ${benchmark} connector, +collect statistics, and run every existing query three times. No data files or +separate Trino server are needed. SSB can also prepare lineorder_flat. +Existing table DDL and query SQL are preserved. + +SCALE: 1, 100, 1000 (also 10000 for TPCH/TPCDS). Default: 1. +--mode is only supported by SSB; its default is both. +--splits is only supported by TPCH/TPCDS; its default is max(10, SCALE). +COUNT must be an integer from 1 to 2147483647 and applies during preparation. +Requires mysql and the generator plugin installed on every Doris FE and BE. +The default connection configuration is conf/doris-cluster.conf. +Preparation requires a new database. Use --queries-only against completed data. +EOF +} + +scale=1 +config="${SUITE_ROOT}/conf/doris-cluster.conf" +database='' +queries_only=0 +mode='' +generator_splits='' +result_dir="${SUITE_ROOT}/results/$(date +%Y%m%d-%H%M%S)-$$" +options=$(getopt -o hs:c:d: -l help,queries-only,mode:,result-dir:,splits: -- "$@") +eval set -- "${options}" +while true; do + case "$1" in + -h | --help) + usage + exit 0 + ;; + -s) + scale=$2 + shift 2 + ;; + -c) + config=$2 + shift 2 + ;; + -d) + database=$2 + shift 2 + ;; + --queries-only) + queries_only=1 + shift + ;; + --mode) + mode=$2 + shift 2 + ;; + --result-dir) + result_dir=$2 + shift 2 + ;; + --splits) + # Both Trino connectors parse the split count as a Java int. + if [[ ! $2 =~ ^[1-9][0-9]{0,9}$ ]] || (($2 > 2147483647)); then + echo '--splits must be an integer from 1 to 2147483647.' >&2 + exit 1 + fi + generator_splits=$2 + shift 2 + ;; + --) + shift + break + ;; + *) + usage >&2 + exit 1 + ;; + esac +done +if [[ $# -ne 0 || ! ${scale} =~ ^(1|100|1000|10000)$ ]] || + [[ ${benchmark} == ssb && ${scale} == 10000 ]] || + [[ ${benchmark} == ssb && -n ${generator_splits} ]] || + [[ ${benchmark} != ssb && -n ${mode} ]] || + [[ -n ${mode} && ! ${mode} =~ ^(both|ssb|flat)$ ]]; then + usage >&2 + exit 1 +fi +mode=${mode:-both} +generator_splits=${generator_splits:-$((scale > 10 ? scale : 10))} +ddl="${SUITE_ROOT}/ddl/create-${benchmark}-tables-sf${scale}.sql" +# Each list is the base tables in the existing DDL; TPCH's revenue0 is a view. +# The benchmark name is validated above. +# shellcheck disable=SC2249 +case "${benchmark}" in + ssb) + tables=(customer part supplier dates lineorder) + suites=(ssb ssb-flat) + query_ids=(1.1 1.2 1.3 2.1 2.2 2.3 3.1 3.2 3.3 3.4 4.1 4.2 4.3) + generator_properties="'trino.connector.name'='ssb'" + ;; + tpch) + tables=(region nation supplier customer part partsupp orders lineitem) + suites=(tpch) + mapfile -t query_ids < <(seq 1 22) + # Match the existing Doris DDL, including exact two-decimal monetary values. + generator_properties="'trino.connector.name'='tpch', + 'trino.tpch.column-naming'='STANDARD', + 'trino.tpch.double-type-mapping'='DECIMAL', + 'trino.tpch.splits-per-node'='${generator_splits}'" + ;; + tpcds) + tables=(call_center catalog_page catalog_returns catalog_sales customer_address + customer_demographics customer date_dim household_demographics income_band + inventory item promotion reason ship_mode store_returns store_sales store + time_dim warehouse web_page web_returns web_sales web_site) + suites=(tpcds) + query_ids=() + for ((query = 1; query <= 99; query++)); do + query_ids+=("${query}") + # The existing suite splits these four templates into two statements. + case "${query}" in + 14 | 23 | 24 | 39) query_ids+=("${query}_1") ;; + *) ;; + esac + done + generator_properties="'trino.connector.name'='tpcds', 'trino.tpcds.split-count'='${generator_splits}'" + ;; +esac + +query_path() { + # The benchmark name is validated above. + # shellcheck disable=SC2249 + case "${benchmark}" in + ssb) printf '%s/%s-queries/q%s.sql' "${SUITE_ROOT}" "$1" "$2" ;; + tpch) printf '%s/queries/q%s.sql' "${SUITE_ROOT}" "$2" ;; + tpcds) printf '%s/queries/sf%s/query%s.sql' "${SUITE_ROOT}" "${scale}" "$2" ;; + esac +} + +# Fail before creating a database if a requested suite is incomplete. +for suite in "${suites[@]}"; do + for query in "${query_ids[@]}"; do + test -r "$(query_path "${suite}" "${query}")" + done +done +test -r "${ddl}" +# shellcheck disable=SC1090 +source "${config}" +database=${database:-${DB}} +if [[ ! ${database} =~ ^[a-zA-Z_][a-zA-Z0-9_]*$ ]]; then + echo 'The database name must contain only letters, digits and underscores.' >&2 + exit 1 +fi +export MYSQL_PWD=${PASSWORD:-} +mysql_args=(--protocol=tcp --host="${FE_HOST}" --port="${FE_QUERY_PORT}" --user="${USER}" + --batch --raw --skip-column-names --comments --skip-force) +command -v mysql >/dev/null +mkdir -p "$(dirname "${result_dir}")" +# Refuse to overwrite an earlier run's measurements or query results. +mkdir "${result_dir}" +result_dir=$(cd "${result_dir}" && pwd) +trap 'echo "${benchmark_name} failed at line ${LINENO}. Logs: ${result_dir}. Prepared tables are preserved." >&2' ERR + +run_sql() { + local sql=$1 + shift + mysql "${mysql_args[@]}" "$@" --execute "${sql}" +} + +insert_sql() { + # A successful INSERT can otherwise return COMMITTED before its rows are visible. + # Preserve the diagnostic and abort rather than benchmark incomplete data or retry a write. + local output insert_status status=0 + output=$( + set -e + run_sql "SET enable_insert_strict=true; SET insert_max_filter_ratio=0; + SET insert_timeout=14400; SET insert_visible_timeout_ms=600000; $1" -vvv 2>&1 + ) || status=$? + printf '%s\n' "${output}" >>"${result_dir}/prepare.log" + if [[ ${status} -ne 0 ]]; then + printf '%s\n' "${output}" >&2 + return "${status}" + fi + # mysql -vvv also echoes the SQL. Read the status field only from returned + # metadata records, so SQL identifiers and label values cannot match it. + insert_status=$(awk -F"'" ' + /^[[:space:]]*\{/ { + for (i = 2; i + 2 <= NF; i += 2) { + if ($i == "status" && $(i + 1) ~ /^[[:space:]]*:[[:space:]]*$/) { + print $(i + 2) + break + } + } + }' <<<"${output}") + if [[ ${insert_status} != VISIBLE ]]; then + echo "INSERT did not report VISIBLE (status: ${insert_status:-missing}); inspect prepare.log before continuing." >&2 + return 1 + fi +} + +echo "${benchmark_name} SF${scale}: ${FE_HOST}:${FE_QUERY_PORT}/${database}; results: ${result_dir}" +if [[ ${queries_only} -eq 0 ]]; then + if [[ ${benchmark} != ssb ]]; then + echo "Generator splits per table: ${generator_splits}" | tee -a "${result_dir}/prepare.log" + fi + echo "Creating database and Trino ${benchmark_name} catalog" + # CREATE DATABASE is deliberately not IF NOT EXISTS: a retry must never append + # the same generated data to these DUPLICATE KEY tables, even after a partial run. + run_sql "CREATE DATABASE \`${database}\`;" >>"${result_dir}/prepare.log" + run_sql "CREATE CATALOG \`${benchmark}_gen_${database}\` PROPERTIES ( Review Comment: [P3] Save preparation errors in prepare.log. This CREATE CATALOG call, the DDL load, and ANALYZE append only stdout, so a missing generator plugin or SQL error appears only on the terminal while the ERR trap directs users to the result directory. After CREATE DATABASE succeeds, the preserved prepare.log cannot explain why preparation stopped, and another run with the same database name is refused. Capture stderr in the log as well, optionally echoing it to the terminal. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
