zeroshade commented on code in PR #250: URL: https://github.com/apache/arrow-go/pull/250#discussion_r1916929370
########## ci/scripts/bench.sh: ########## @@ -0,0 +1,54 @@ +#!/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. + +# this will output the benchmarks to STDOUT but if `-json` is passed +# as the second argument, it will create a file "bench_stats.json" +# in the directory this is called from containing a json representation + +set -ex + +# simplistic semver comparison +verlte() { + [ "$1" = "`echo -e "$1\n$2" | sort -V | head -n1`" ] +} +verlt() { + [ "$1" = "$2" ] && return 1 || verlte $1 $2 +} + +ver=`go env GOVERSION` Review Comment: we don't need this or these checks anymore, you can remove them ########## .github/workflows/benchmark.yml: ########## @@ -0,0 +1,78 @@ +# 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. + +name: Benchmarks +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + workflow_dispatch: + +jobs: + benchmark: + runs-on: ubuntu-latest + container: debian:12 + + strategy: + matrix: + go: ['1.21'] Review Comment: `1.23` please, we've bumped everything to 1.22 and 1.23, not 1.21 anymore ########## ci/scripts/bench_adapt.py: ########## @@ -0,0 +1,127 @@ +# 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. + +import json +import os +import uuid +import logging +from pathlib import Path +from typing import List + +from benchadapt import BenchmarkResult +from benchadapt.adapters import BenchmarkAdapter +from benchadapt.log import log + +log.setLevel(logging.DEBUG) + +ARROW_ROOT = Path(__file__).parent.parent.parent.resolve() +SCRIPTS_PATH = ARROW_ROOT / "ci" / "scripts" + +# `github_commit_info` is meant to communicate GitHub-flavored commit +# information to Conbench. See +# https://github.com/conbench/conbench/blob/cf7931f/benchadapt/python/benchadapt/result.py#L66 +# for a specification. +github_commit_info = {"repository": "https://github.com/apache/arrow-go"} + +if os.environ.get("CONBENCH_REF") == "main": + # Assume GitHub Actions CI. The environment variable lookups below are + # expected to fail when not running in GitHub Actions. + github_commit_info = { + "repository": f'{os.environ["GITHUB_SERVER_URL"]}/{os.environ["GITHUB_REPOSITORY"]}', + "commit": os.environ["GITHUB_SHA"], + "pr_number": None, # implying default branch + } + run_reason = "commit" +else: + # Assume that the environment is not GitHub Actions CI. Error out if that + # assumption seems to be wrong. + assert os.getenv("GITHUB_ACTIONS") is None + + # This is probably a local dev environment, for testing. In this case, it + # does usually not make sense to provide commit information (not a + # controlled CI environment). Explicitly leave out "commit" and "pr_number" to + # reflect that (to not send commit information). + + # Reflect 'local dev' scenario in run_reason. Allow user to (optionally) + # inject a custom piece of information into the run reason here, from + # environment. + run_reason = "localdev" + custom_reason_suffix = os.getenv("CONBENCH_CUSTOM_RUN_REASON") + if custom_reason_suffix is not None: + run_reason += f" {custom_reason_suffix.strip()}" + + +class GoAdapter(BenchmarkAdapter): + result_file = "bench_stats.json" + command = ["bash", SCRIPTS_PATH / "bench.sh", ARROW_ROOT, "-json"] + + def __init__(self, *args, **kwargs) -> None: + super().__init__(command=self.command, *args, **kwargs) + + def _transform_results(self) -> List[BenchmarkResult]: + with open(self.result_file, "r") as f: + raw_results = json.load(f) + + run_id = uuid.uuid4().hex + parsed_results = [] + for suite in raw_results[0]["Suites"]: + batch_id = uuid.uuid4().hex + pkg = suite["Pkg"] + + for benchmark in suite["Benchmarks"]: + data = benchmark["Mem"]["MBPerSec"] * 1e6 + time = 1 / benchmark["NsPerOp"] * 1e9 + + name = benchmark["Name"].removeprefix("Benchmark") + ncpu = name[name.rfind("-") + 1 :] + pieces = name[: -(len(ncpu) + 1)].split("/") + + parsed = BenchmarkResult( + run_id=run_id, + batch_id=batch_id, + stats={ + "data": [data], + "unit": "B/s", + "times": [time], + "time_unit": "i/s", + "iterations": benchmark["Runs"], + }, + context={ + "benchmark_language": "Go", + "goos": suite["Goos"], + "goarch": suite["Goarch"], + }, + tags={ + "pkg": pkg, + "num_cpu": ncpu, + "name": pieces[0], + "params": "/".join(pieces[1:]), + }, + run_reason=run_reason, + github=github_commit_info, + ) + parsed.run_name = ( + f"{parsed.run_reason}: {github_commit_info.get('commit')}" + ) + parsed_results.append(parsed) + + return parsed_results + + +if __name__ == "__main__": + go_adapter = GoAdapter(result_fields_override={"info": {}}) + go_adapter() Review Comment: add newline to the end of the file please ########## ci/scripts/bench.sh: ########## @@ -0,0 +1,54 @@ +#!/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. + +# this will output the benchmarks to STDOUT but if `-json` is passed +# as the second argument, it will create a file "bench_stats.json" +# in the directory this is called from containing a json representation + +set -ex + +# simplistic semver comparison +verlte() { + [ "$1" = "`echo -e "$1\n$2" | sort -V | head -n1`" ] +} +verlt() { + [ "$1" = "$2" ] && return 1 || verlte $1 $2 +} + +ver=`go env GOVERSION` + +source_dir=${1} + +export PARQUET_TEST_DATA=${1}/cpp/submodules/parquet-testing/data +pushd ${source_dir} + +# lots of benchmarks, they can take a while +# the timeout is for *ALL* benchmarks together, +# not per benchmark +go test -bench=. -benchmem -timeout 40m -run=^$ ./... | tee bench_stat.dat + +popd + +if [[ "$2" = "-json" ]]; then + go install go.bobheadxi.dev/gobenchdata@latest + export PATH=`go env GOPATH`/bin:$PATH + cat ${source_dir}/bench_*.dat | gobenchdata --json bench_stats.json +fi + +rm ${source_dir}/bench_*.dat Review Comment: add new line to the end of the file please -- 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]
