AnandInguva commented on code in PR #23931: URL: https://github.com/apache/beam/pull/23931#discussion_r1046096082
########## sdks/python/apache_beam/testing/analyzers/README.md: ########## @@ -0,0 +1,80 @@ +<!-- + 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. +--> + +<h1>Performance alerts for Beam Python performance and load tests</h1> + + +<h2> Alerts </h2> + +Performance regressions or improvements detected with the [Change Point Analysis](https://en.wikipedia.org/wiki/Change_detection) using [edivisive](https://github.com/apache/beam/blob/0a91d139dea4276dc46176c4cdcdfce210fc50c4/.test-infra/jenkins/job_InferenceBenchmarkTests_Python.groovy#L30) +analyzer are automatically filed as Beam GitHub issues with a label `perf-alert`. + +The GitHub issue description will contain the information on the affected test and metric by providing the metric values for N consecutive runs with timestamps +before and after the observed change point. Observed change point is pointed as `Anomaly` in the issue description. + +Example: [sample perf alert GitHub issue](https://github.com/AnandInguva/beam/issues/83). + +If a performance alert is created on a test, a GitHub issue will be created and the GitHub issue metadata such as GitHub issue +URL, issue number along with the change point value and timestamp are exported to BigQuery. This data will be used to analyze the next change point observed on the same test to +update already created GitHub issue or ignore performance alert by not creating GitHub issue to avoid duplicate issue creation. + +<h2> Config file structure </h2> +The config file defines the structure to run change point analysis on a given test. To add a test to the config file, +please follow the below structure. + +**NOTE**: The Change point analysis only supports reading the metric data from Big Query for now. + +``` +# the test_1 must be a unique id. +test_1: + test_name: apache_beam.testing.benchmarks.inference.pytorch_image_classification_benchmarks + source: big_query + metrics_dataset: beam_run_inference + metrics_table: torch_inference_imagenet_results_resnet152 + project: apache-beam-testing + metric_name: mean_load_model_latency_milli_secs + labels: + - run-inference + min_runs_between_change_points: 5 + num_runs_in_change_point_window: 7 +``` + +**Note**: If the source is **BigQuery**, the metrics_dataset, metrics_table, project and metric_name should match with the values defined for performance/load tests. +The above example uses this [test configuration](https://github.com/apache/beam/blob/0a91d139dea4276dc46176c4cdcdfce210fc50c4/.test-infra/jenkins/job_InferenceBenchmarkTests_Python.groovy#L30) +to fill up the values required to fetch the data from source. + +<h3>Different ways to avoid false positive change points</h3> + +**min_runs_between_change_points**: As the metric data moves across the runs, the change point analysis can place the +change point in a slightly different place. These change points refer to the same regression and are just noise. +When we find a new change point, we will search up to the `min_runs_between_change_points` in both directions from the +current change point. If an existing change point is found within the distance, then the current change point will be +suppressed. + +**num_runs_in_change_point_window**: This defines how many runs to consider from the most recent run to be in change point window. +Sometimes, the change point found might be way back in time and could be irrelevant. For a test, if a change point needs to be +reported only when it was observed in the last 7 runs from the current run, +setting `num_runs_in_change_point_window=7` will achieve it. + +<h2> Register a test for performance alerts. </h2> Review Comment: I added a triage section https://github.com/apache/beam/blob/3a453cd9fe2883eebed4b326d800b4cf8b2069e4/sdks/python/apache_beam/testing/analyzers/README.md#triage-performance-alert-issues Explains how to fetch values for test + metric_name. Also, I showed a simple way to generate plots. -- 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]
